Upgrading Cloud Manager PeopleTools Using Command Line
The Cloud Manager command line option can be used for triggering the PeopleTools upgrade and monitoring the upgrade status. This command line utility can be used to upgrade PeopleTools for Cloud Manager instances that are on PeopleTools below 8.58. If self update was used (Cloud Manager Update Image 10 to Update Image 11), the PeopleTools upgrade is included in the process. For Cloud Manager 9 and below, a PeopleTools upgrade is required.
Note: If you are running Cloud Manager Update Image 8 or lower, you must upgrade to Cloud Manager Update Image 11 using selective adoption to obtain the command line utility for automated PeopleTools upgrade.
Note: If you are running Cloud Manager 12 or above, the tools upgrade process is automatically triggered as part of “Automatically Applying Updates Using Manage Updates”. Use the command line for checking the status and retrying the failed step, see Monitoring PeopleTools Upgrade.
To use the command line utility to upgrade PeopleTools:
Subscribe to the PeopleTools download channel. Ensure that the download is complete.
For example: Interaction Hub PI 9.1.11 has PeopleTools version 8.58.03, therefore you must subscribe to PeopleTools 8.58 Linux download channel with a minimum patch version of 8.58.03. To determine the PeopleTools version on the IH PUM Source, SSH into the IH PUM Source, switch user to psadm2 and run psadmin -v command. See Accessing Provisioned Environments
Log into the Cloud Manager instance using SSH.
Create a response file.
Back up Cloud Manager instance. See Using Automated Backup and Restore Utility.
Important! The backup will be available in case of any failures in the PeopleTools upgrade process, allowing you to restore to this point.
Run the command line to carry out the upgrade.
run_cloud_manager_update -t <task_name> -o <operation_name > -r <response_file.json>
Example: run_cloud_manager_update -t cm_upgrade -o execute -r /tmp/cm_update_rsponse_file.json
The command line has the following hierarchy:
Command > Task > Operation > Subtask >Activity
Command
The command is run_cloud_manager_update.
Task
For Cloud Manager Update Image 9, the only supported task is cm_upgrade [-t option].
Operation
Multiple operations [-o option] are available for a task. For cm_upgrade operations see Command Line Operations for cm_upgrade
Subtasks
Each operation contains one or more subtasks. See Subtasks for PeopleTools Upgrade [PTU] in Cloud Manager Instance.
Activity
Each subtask may have multiple activities.
The task cm_upgrade is used to perform a PeopleTools Upgrade [PTU] in the Cloud Manager instance. The input values are given as a response file. The format is:
run_cloud_manager_update -t cm_upgrade -o <operation_name> -r <response_file.json>
This table lists the operation/subtask details.
Operation Type [-o] |
Description/Details |
---|---|
execute |
This operation is used for running the current task. If the response file is present it will read the response file and that will be used for creating the input values for the task implementation. |
get_status |
This operation is used to display the current task status in the console. The status will show the implementation status at the activity level. -v [verbose] option can be used for the detailed status. The activity status will be updated, only after the task implementation completes. The statuses supported by activities are:
|
retry |
This operation is used for rerunning failed activities. This can be run with or without a response file. The response file should be used when the task implementation failed due to input value error and the response file has been updated. Retry will:
Note: In the status summary RETRY is displayed for the activity that was in a failed state. In verbose summary, the activity status will be the current failed status. After the activities finish running, the activity status and task status will be updated properly. |
mark_as_complete |
This operation is used to mark an activity as manually fixed. The user manually fixes the failed activity and then runs this operation. This operation will then skip the current failed activity and mark it as MANUAL_SUCCESS, then resume to next subtask. Note: The status summary will show the MANUAL_SUCCESS status for the particular sub task. In verbose status the activity status is not changed. This is because the task or activity is not rerun, therefore the verbose status display the old status. |
mark_all_steps_complete |
This operation is used to skip all the subtask processing in case of failure. In this case the user can manually fix all pending and failed subtasks. Note: The status summary will show the MANUAL_SUCCESS status for the particular subtask. In verbose status the activity status will be the current status [in FAILED / PENDING/SUCCESS state]. Since the subtask or activity is not rerun, the verbose status displays the old status. |
The cm_upgrade task is used to perform a PeopleTools Upgrade [PTU] in Cloud Manager instance. The input values should given as response file. This task will upgrade PeopleTools on the Cloud Manager instance with no manual stop.
The following sub tasks are performed.
Validate the Cloud Manager PTU response file input values.
The validation activity (PsftCMUpdateValidationActivity) will validate:
WinRm connectivity to the Windows client instance
Windows client user id and password
File server validation
Current PeopleTools version
PeopleTools DPK for the new PeopleTools version
Database information in TNS entry
PIA port - http and https
psftserver values and jolt port in wls config
WLS port and Jolt port in Application domain
Operator id/password
WLS admin is/password
Web profile user id/password
DB admin password
Operator id and password
Connect id and password
Access id and password
All user input mandatory values
Take a backup of current CM_PS_HOME and PS_CFG_HOME.
The activity to prepare for the update (PsftPrepareCMUpdateActivity) will:
Take a backup of PS_HOME and PS_CFG_HOME
Take a backup of PTU specific files.
Copy the PTC and ODC DPK from CM DPKs to the file server.
Stop the Cloud Manager psft domains.
The activity to shut down PSFT domains (PsftCMDomainRestartActivity) will run,
Cloud Manager PTU upgrade process.
This subtask contains multiple activities:
Copy the Cloud folder from Cloud Manager file server to Windows client.
Install the PeopleTools client for current CM PeopleTools version.
Install the PeopleTools client for new CM PeopleTools version.
Configuration Change Assistant for CM PeopleTools Upgrade process.
Trigger the Change Assistant PTU command line process.
Cloud Manager PTP update process.
This subtask contains multiple activities:
Copy the Cloud folder from Cloud Manager file server to Windows client.
Install the PeopleTools client for new CM PeopleTools version.
Configuration Change Assistant for CM PeopleTools Update process.
Trigger the Change Assistant PTP command line process.
Uninstall the Cloud Manager middle tier.
The activity to uninstall the middle tier will:
Uninstall middle tier from the Cloud Manager instance.
Call the puppet clean up command using the root user.
Re-provision the Cloud Manager middle tier.
This subtask contains multiple activities:
Provision middle tier:
Installation of new PeopleTools middle tier in the Cloud Manager middle tier.
Restore old configuration files in Cloud Manager.
Restore log4j, open ssl, puppet config and processing scripts.
Will do Cloud Manager specific configuration in Cloud Manager puppet yaml file and will trigger the Cloud Manager specific puppet profiles.
Run puppet apply using root user for recreating the middle tier.
Place holder for doing the post mid-tier creation steps, if any.
Cloud Manager PTU post update settings.
The activity for PTU post update settings will:
Post the upgrade task.
Run the application engine program for notifying the UI about the processing status.
Restarting the Cloud Manager domains.
The activity will restart all Cloud Manager psft domains.
Create a json file that includes all the mandatory values. The other values will be discovered in job processing. If the mandatory values are not included in the response file, running the job results in an error.
This is an example of the response file containing the mandatory values:
{
"pum_source": {
"windows_client": {
"private_ip": "<windows_client private IP>",
"remote_password": "<Windows Client Password>"
}
},
"pum_target": {
"psft": {
"access_pwd": "<Access Password>",
"opr_pwd": "<Operator Password>",
"admin_pwd": "<DB Admin Password>",
"connect_pwd": "<Connect Password>",
"gw_admin_user_pwd": "<Gateway User Password>",
"webprofile_user_pwd": "<Web Profile User Password>",
"weblogic_admin_pwd": "<Webserver Admin Password>"
}
}
}
The response file can also contain additional values, however the mandatory values must be included.
This is an example of a response file with additional values:
{
"file_server": {
"hostname": "hostname.example.com"
},
"pum_source": {
"windows_client": {
"host_name": "win_client_hostname",
"private_ip": "<Windows Client Private IP>",
"remote_password": "<Windows Client Password>"
}
},
"pum_target": {
"psft": {
"opr_id": "CLADM",
"connect_id": "people",
"access_id": "SYSADM",
"weblogic_admin_user": "system",
"gw_admin_user": "administrator",
"db_name": "CMPSDB",
"db_service_name": "CMPSDB",
"db_host": "hostname.example.com",
"psft_server": "hostname.example.com",
"wsl_port": "7000",
"jolt_port": "9033",
"pia_https_port": "8443",
"pia_http_port": "8000",
"db_port": "1522",
"tools_version": "8.56.12",
"new_tools_version": "8.57.03",
"pi_number": "8",
"access_pwd": "<Access Password>",
"opr_pwd": "<Operator Password>",
"admin_pwd": "<DB Admin Password>",
"connect_pwd": "<Connect Password>",
"gw_admin_user_pwd": "<Gateway User Password>",
"webprofile_user_pwd": "<Web Profile User Password>",
"weblogic_admin_pwd": "<Webserver Admin Password>"
}
}
}
Use the following command to get the current status of the PeopleTools Upgrade:
run_cloud_manager_update -t CM_UPGRADE -o get_status
When the PeopleTools Upgrade begins, the status will show in progress and you can see what step is running.
This example illustrates Cloud Manager PeopleTools Upgrade Status.
If a step fails, the status will show failure. You will need to correct the failure and either retry or mark the step as complete in order to continue.
This example illustrates Cloud Manager PeopleTools Upgrade Status where a step has failed.
This example illustrates Cloud Manager PeopleTools Upgrade Status where all steps are successful.
Verbose
To display the verbose status, add the -v verbose option:
run_cloud_manager_update -t CM_UPGRADE -o get_status -v
This is an example of the verbose Cloud Manager PeopleTools Upgrade Status:
--------------------------------------------
CLOUD MANAGER PEOPLETOOLS UPGRADE STATUS
--------------------------------------------
ORCHESTRATION ID: CM_ORCH_PTU_20190501_160902 [Time: 2019-05-01 16:09:57:122185]
JOB SCHEDULE STATUS: SUCCESS
JOB STATUS: SUCCESS
JOB DETAILS: Successfully completed
JOB LOG: /home/psadm2/psft/data/cloud/cmlogs/envs/CLOUD_MANAGER_INSTANCE/CM_ORCH_PTU_20190501_160902/cm_job_psft_cm_ptu_job_0_20190501_160903_out.log
JOB SCHEDULER LOG: /home/psadm2/psft/data/cloud/cmlogs/envs/CLOUD_MANAGER_INSTANCE/CM_ORCH_PTU_20190501_160902/out.log
JOB STATUS CHECK LOG: /home/psadm2/psft/data/cloud/cmlogs/envs/CLOUD_MANAGER_INSTANCE/CM_DATA/out_20190501.log
1. Validating Input Data: SUCCESS
TASK DETAILS: Successfully completed
TASK LOG: /home/psadm2/psft/data/cloud/cmlogs/envs/CLOUD_MANAGER_INSTANCE/CM_PTU_VALIDATE_0_20190501_160906/out.log
1.1 CM Update Validation Process: SUCCESS
Details: Successfully completed
2. Cloud Manager Pre-Update Settings: SUCCESS
TASK DETAILS: Successfully completed
TASK LOG: /home/psadm2/psft/data/cloud/cmlogs/envs/CLOUD_MANAGER_INSTANCE/CM_PRE_UPDATE_0_20190501_160912/out.log
2.1 Cloud Manager Prepare Update Process: SUCCESS
Details: Successfully completed
3. Stopping the Cloud Manager PSFT Domains: SUCCESS
TASK DETAILS: Successfully completed
TASK LOG: /home/psadm2/psft/data/cloud/cmlogs/envs/CLOUD_MANAGER_INSTANCE/CM_DOMAIN_STOP_0_20190501_160918/out.log
3.1 CM Domain Restart/Stop Process: SUCCESS
Details: Successfully completed
4. Cloud Manager PeopleTools Upgrade [PTU]: SUCCESS
TASK DETAILS: Successfully completed
TASK LOG: /home/psadm2/psft/data/cloud/cmlogs/envs/CLOUD_MANAGER_INSTANCE/CM_PTU_UPGRADE_0_20190501_160924/out.log
4.1 Performing PsftActivityWindowsCloudFolderSync: SUCCESS
Details: Successfully completed
4.2 Performing Cloud Manager Windows Client Install Activity [Source PeopleTools]: SUCCESS
Details: Successfully completed
4.3 Performing Windows Client Install Activity: SUCCESS
Details: Successfully completed
4.4 Adding Environment Info to CA: SUCCESS
Details: Successfully completed
4.5 CA PTU Apply Process: SUCCESS
Details: Successfully completed
5. Cloud Manager PeopleTools Update [PTP]: SUCCESS
TASK DETAILS: Successfully completed
TASK LOG: /home/psadm2/psft/data/cloud/cmlogs/envs/CLOUD_MANAGER_INSTANCE/CM_PTP_UPDATE_0_20190501_160930/out.log
5.1 Performing PsftActivityWindowsCloudFolderSync: SUCCESS
Details: Successfully completed
5.2 Performing Windows Client Install Activity: SUCCESS
Details: Successfully completed
5.3 Adding Environment Info to CA: SUCCESS
Details: Successfully completed
5.4 CA PTP Apply Process: SUCCESS
Details: Successfully completed
6. Un-Provisioning the Middle Tier of Cloud Manager: SUCCESS
TASK DETAILS: Successfully completed
TASK LOG: /home/psadm2/psft/data/cloud/cmlogs/envs/CLOUD_MANAGER_INSTANCE/CM_UNPROV_MT_0_20190501_160936/out.log
6.1 Performing Unprovision MT: SUCCESS
Details: Successfully completed
7. Re-Provisioning the Middle Tier of Cloud Manager: SUCCESS
TASK DETAILS: Successfully completed
TASK LOG: /home/psadm2/psft/data/cloud/cmlogs/envs/CLOUD_MANAGER_INSTANCE/CM_REPROV_MT_0_20190501_160942/out.log
7.1 Performing Reprovision MT: SUCCESS
Details: Successfully completed
7.2 Cloud Manager Post MT Reprovision Process: SUCCESS
Details: Successfully completed
8. Cloud Manager Post Update Settings: SUCCESS
TASK DETAILS: Successfully completed
TASK LOG: /home/psadm2/psft/data/cloud/cmlogs/envs/CLOUD_MANAGER_INSTANCE/CM_POST_UPDATE_0_20190501_160948/out.log
8.1 Cloud Manager Post Update Process: SUCCESS
Details: Successfully completed
Several logs are available to assist the users in troubleshooting errors that may occur during the upgrade process.
Log |
Location/Example log file name |
---|---|
JOB LOG |
/home/psadm2/psft/data/cloud/cmlogs/envs/CLOUD_MANAGER_INSTANCE/CM_ORCH_PTU_20190308_054432/cm_job_psft_cm_ptu_job_0_20190308_054432_out.log |
JOB SCHEDULER LOG |
/home/psadm2/psft/data/cloud/cmlogs/envs/CLOUD_MANAGER_INSTANCE/CM_ORCH_PTU_20190308_054432/out.log |
JOB STATUS CHECK LOG |
/home/psadm2/psft/data/cloud/cmlogs/envs/CLOUD_MANAGER_INSTANCE/CM_ORCH_PTU_20190308_054607/out.log |
TASK LOG |
/home/psadm2/psft/data/cloud/cmlogs/envs/CLOUD_MANAGER_INSTANCE/CM_POST_UPDATE_0_20190308_054441/out.log |
Note: The log file names are only examples; the file name in a customer environment will vary.