Planning for the procedure

Background knowledge

This procedure assumes that:

  • you are installing into an existing VMware vSphere deployment which has pre-configured networks and VLANs; this procedure does not cover setting up a VMware vSphere deployment from scratch

  • you are upgrading an exisiting downlevel deployment for ShCM.

  • you have deployed a SIMPL VM, unpacked the uplevel CSAR, and prepared an uplevel SDF.

Reserve maintenance period

This procedure does require a maintenance period. When integrating into a live network, it is recommended to implement measures to mitigate any unforeseen events.

Plan for service impact

Misconfiguration could disrupt service for existing network elements.


You must be a system operator to perform the MOP steps.

Tools and access

You must have access to the SIMPL VM, and the SIMPL VM must have the right permissions on the VMware vSphere deployment.

Method of procedure

Note Refer to the SIMPL VM Documentation for details on the commands mentioned in the procedure.

See CSAR EFIX patches to learn more on the CSAR EFIX patching process.

Step 1 - Upgrade the downlevel ShCM nodes

Run csar update --vnf shcm --sdf <path to SDF>.

This will validate the uplevel SDF, generate the uplevel Terraform template, and upload the uplevel image.

The following will occur one ShCM node at a time:

  • The downlevel node will be quiesced.

  • The uplevel node will be created and boot up.

  • The VM will automatically start applying configuration from the files you uploaded to CDS in the above steps. During this phase, the status of the VM in MDM will be Orange.

  • Once configuration is complete, the status will change to Green, and the node will be ready for service. At this point the csar update command will move on to the next ShCM VM, or report that the upgrade of the ShCM was successful if all nodes have now been upgraded.

Note To perform a canary upgrade, run csar update --vnf shcm --sites <site> --service-group <service_group> --index-range <range> --sdf <path to SDF>. The range accepts a comma delimited index of nodes starting from 0. Only the nodes specified in the index will be upgraded.

Backout procedure

If the upgrade has brought up uplevel VMs to replace the downlevel VMs, then the uplevel VMs can be rolled back to the downlevel VMs. To rollback, repeat step 1 with the downlevel ShCM CSAR and downlevel SDF, appending the --skip pre-update-checks flag to the csar update command. The --skip pre-update-checks flag allows rollbacks when a node is unhealthy.

If the upgrade has failed to bring up the uplevel VMs or the rollback has failed to bring up the downlevel VMs, then you must redeploy the downlevel VMs. run csar redeploy --vnf shcm --sites <site> --sdf <path to SDF>.

Diagnostics during the quiesce stage

When the downlevel VMs are quiesced, they upload some diagnostics to CDS. These may be useful if the upgrade or rollback fails.

To get these diagnostics, follow instructions from Retrieving Initconf and Rhino logs with export-log-history.

Next Step

If you are upgrading a full set of VMs, go to Rolling CSAR EFIX patch MAG nodes on VMware vSphere, otherwise, verify your ShCM upgrade here: Verify the state of the nodes and processes.

Previous page Next page
Rhino VoLTE TAS VMs Version 4.0.0