Create a Product Snapshot

You can create a snapshot of any vRealize Suite product that vRealize Suite Lifecycle Manager supports.

For the list of products that vRealize Suite Lifecycle Manager supports, see Installing and Importing Products Using vRealize Suite Lifecycle Manager APIs.

The following procedure shows how to create a snapshot of the installed vRealize Operations Manager product. This example creates a snapshot without memory and without shutdown before the snapshot.

To choose the input parameters for the snapshot that you want to create, refer to the settings in the table below.

Snapshot settings	What occurs
Create a snapshot without memory	The snapshot only captures an image of the disk, not the memory. After reverting to a snapshot without memory, the product nodes power off. To restore the nodes to their initial state, you can accept the option to power on all the nodes automatically or you can power on the nodes manually.
Create a snapshot with memory	The snapshot requires more time and vCenter disk space to capture the contents of both the disk and memory. Select this option if you want to restore the product nodes to their same state as when the snapshot was taken.
Create a snapshot without shutdown	The time to take the snapshot is much faster and allows you to control when the product shutdown occurs. Select this option if you are sure that product services will not be impacted after reverting to the snapshot.
Create a snapshot with shutdown	vRealize Suite Lifecycle Manager requires time to stop all product services before taking the snapshot and powers back on the nodes after the snapshot. Select this option if you want to ensure that product services are up and running after reverting to a snapshot. vRealize Automation only allows snapshots with shutdown.

Prerequisites

• Verify that all general prerequisites have been satisfied and that you have assigned your environment ID and product ID. See the prerequisites for Performing Day 2 operations using vRealize Suite Lifecycle Manager APIs.
• If you are creating a snapshot of SaltStack Config or vRealize Business for Cloud, verify that the tenant ID variable is assigned. See Creating and Managing Product Snapshots.

Procedure

1. Create a snapshot.

   curl -X POST \
     '$url/lcm/lcops/api/environments/$environmentId/products/$productId/snapshot/inventory' \
     -H 'Authorization: Basic YWRtaW5AbG9jYWw6VGhpc0lzUGFzc3dvcmQ=' \
     -H 'Content-Type: application/json' \
     -d '{
        "description": "example snapshot of vROps",
        "shutdownBeforeSnapshot": false,
        "snapshotPrefix": "vrops-snapshot",
        "snapshotWithMemory": false
   }' | jq "."

   Note: To create a snapshot of SaltStack Config or vRealize Business for Cloud, include the tenant ID as a query parameter in your request, for example:

   curl -X POST \
     '$url/lcm/lcops/api/environments/$environmentId/products/$productId/snapshot/inventory?tenantId=$tenantId' \
     -H 'Authorization: Basic YWRtaW5AbG9jYWw6VGhpc0lzUGFzc3dvcmQ=' \
     -H 'Content-Type: application/json' \
     -d '{
        "description": "example snapshot of SSC",
        "shutdownBeforeSnapshot": false,
        "snapshotPrefix": "ssc-snapshot",
        "snapshotWithMemory": false
   }' | jq "."

   The request triggers the API. The response shows the request ID.

   {
       "requestId":"a3f77209-0005-44b3-9eb5-ac1a1ba19394"
   }

2. Assign the variable for the requestId.

   requestId = "a3f77209-0005-44b3-9eb5-ac1a1ba19394"

3. Use the requestId to track your request.

   curl -X GET '$url /lcm/request/api/v2/requests/$requestId' -H 'Authorization: Basic YWRtaW5AbG9jYWw6VGhpc0lzUGFzc3dvcmQ=' | jq "."

   After the request succeeds, vRealize Suite Lifecycle Manager saves the state and configuration details for the vRealize Operations Manager virtual appliance.

   ...
   },
     "outputMap": {},
     "state": "COMPLETED",
     "executionId": "59430b9d-44cc-47a1-90ec-777481edb9z9",
   ...

4. To get the snapshot ID, list all the snapshots for the product.

   curl -X GET \
     '$url/lcm/lcops/api/environments/$environmentId/products/$productId/snapshot/inventory' \
     -H 'Authorization: Basic YWRtaW5AbG9jYWw6VGhpc0lzUGFzc3dvcmQ=' \
     -H 'Content-Type: application/json' | jq "."

   A snippet of the response shows a hierarchy of all vRealize Operations Manager snapshots with metadata such as the snapshot ID, the Unix epoch time for the snapshot generation, and whether there was a product shutdown before taking the snapshot.

   ...
   [
       {
           "snapshotId": "ba89bb68-6786-4fbe-b3e3-fe5cf3a5eca1",
           "snapshotGeneratedTime": 1629390494756,
           "snapshotName": "example-19-AUG",
           "snapshotWithMemory": false,
           "quiesceSnapshot": false,
           "shutdownSnapshot": true,
           "currentSnapshot": false,
           "validSnapshotNodes": [
               {
                   "type": "vropsva-primary",
                   "properties": {
                       "hostName": "lcm-32-110.sqa.local",
                       "vmName": "vropsva-primary",
                       "ip": "10.198.32.110"
                   }
               }
           ],                
           "invalidSnapshotNodes": [],
           "missingSnapshotNodes": [],
           "description": "vRSLCM Snapshot: Tue Aug 24 04:58:02 UTC 2021",
           "parentSnapshotId": "null",
           "status": "VALID",
           "childrenSnapshots": [
               {
                   "snapshotId": "260b6589-85cc-42d8-a204-450350281963",
                   "snapshotGeneratedTime": 1629785569356,
                   "snapshotName": "test",
                   "snapshotWithMemory": false,
                   "quiesceSnapshot": false,
                   "shutdownSnapshot": false,
                   "currentSnapshot": false,
                   "validSnapshotNodes": [
                       {
                           "type": "vropsva-primary",
                           "properties": {
                               "hostName": "lcm-32-110.sqa.local",
                               "vmName": "vropsva-primary",
                               "ip": "10.198.32.110"
                           }
                       }
                   ],
                   "invalidSnapshotNodes": [],
                   "missingSnapshotNodes": [],
                   "description": "vRSLCM Snapshot: Tue Aug 24 06:12:48 UTC 2021",
                   "parentSnapshotId": "ba89bb68-6786-4fbe-b3e3-fe5cf3a5eca1",
                   "status": "VALID",
                   "childrenSnapshots": [
                       {
                           "snapshotId": "2347e467-632b-4124-8b2e-643de4a66cae",
                           "snapshotGeneratedTime": 1629785569356,
                           "snapshotName": "preupgrade",
                           "snapshotWithMemory": false,
                           "quiesceSnapshot": false,
                           "shutdownSnapshot": false,
                           "currentSnapshot": false,
                           "validSnapshotNodes": [
                               {
                                   "type": "vropsva-primary",
                                   "properties": {
                                       "hostName": "lcm-32-110.sqa.local",
                                       "vmName": "vropsva-primary",
                                       "ip": "10.198.32.110"
                                   }
                               }
                           ],
                                   "invalidSnapshotNodes": [],
                                   "missingSnapshotNodes": [],
                                   "description": "vRSLCM Snapshot: Wed Sep 15 12:51:49 UTC 2021",
                                   "parentSnapshotId": "260b6589-85cc-42d8-a204-450350281963",
                                   "status": "VALID",
                                   "childrenSnapshots": [
                                       {
                                           "snapshotId": "349085d7-3d00-4ff8-9f86-bfdc318b3f36",
                                           "snapshotGeneratedTime": 1631764698097,
                                           "snapshotName": "vrops-snapshot1",
                                           "snapshotWithMemory": false,
                                           "quiesceSnapshot": false,
                                           "shutdownSnapshot": false,
                                           "currentSnapshot": true,
                                           "validSnapshotNodes": [
                                               {
                                                   "type": "vropsva-primary",
                                                   "properties": {
                                                       "hostName": "lcm-32-110.sqa.local",
                                                       "vmName": "vropsva-primary",
                                                       "ip": "10.198.32.110"
                                                   }
                                               }
                                           ],
                                           "invalidSnapshotNodes": [],
                                           "missingSnapshotNodes": [],
                                           "description": "example snapshot of vROps",
                                           "parentSnapshotId": "2347e467-632b-4124-8b2e-643de4a66cae",
                                           "status": "VALID",
                                           "childrenSnapshots": []
                                       }
                                   ]
                               }
                           ]
                       }
                   ]
               }
           ]
       }
   ]
   ...

   To revert a product to its snapshot or to delete a snapshot, you use the snapshot ID.

What to do next

If you created a snapshot of a deployed product before performing an upgrade, note the snapshot ID and proceed with the upgrade. See Upgrade deployed products using the vRealize Suite Lifecycle Manager API.