Protected virtual machines

Get basic information about protected virtual machines.

Method and URI

To get information about all protected virtual machines, use a GET method and a URI:

GET     https://{hostname|IPv4}/api/endeavour/catalog/recovery/hypervisorvm

Parameters

Parameter 1: embeded

Specify the type of the action.

  • Value: (children(properties))

  • Type: System string. Required.

Data

None.

Example: Get information about protected virtual machines

Assume that you want to get information about protected virtual machines.

A Python snippet that is similar to the following example can be used to get a list of protected virtual machines and detailed information about each:

_params = {"embed": "(children(properties))"}

requests.post('https://' + spp_ipv4
    + '/api/endeavour/catalog/recovery/hyipervisorvm',
    headers={...}, params=_params, verify=...)
_images/reference_report10001_02.png

Figure 77 An example report of VM Backup Utilization. The REST API command described in this section will give you more detailed information including the primary key (pk) for each protected virtual machines. You will rely on those primary keys to retrieve additional data such as backup sizes and the number of backup snapshots (restore points).

The request prompts a response that is structured as shown, with the HTTP status of 200 (OK).

{
    "links": {...},
    "queryElapsedTime": 11,
    "id": "hypervisorvm",
    "name": "hypervisorvm",
    "type": "folder",
    "catalogTime": null,
    "catalogProvider": "recovery",
    "comment": null,
    "tags": null,
    "documentType": null,
    "page": 1,
    "properties": {},
    "children": [
        {
            "links": {...},
            "id": "5d551d2816186f1eeea46718",
            "name": "sales-sql",
            "type": "document",
            "catalogTime": 1565871979100,
            "catalogProvider": "recovery",
            "comment": null,
            "tags": null,
            "documentType": "vm",
            "metadataPath": "/MS:1002/VM:8989CFF1-6F16-4E2B-9FCC-9F8C8CD719C9",
            "properties": {
                "name": "sales-sql",
                "comment": null,
                "creatorId": 0,
                "creationTime": null,
                "type": "vm",
                "flags": 0,
                "pk": "8989CFF1-6F16-4E2B-9FCC-9F8C8CD719C9",
                "sessionId": 1565871979100,
                "objType": null,
                "jobId": "1014",
                "host": null,
                "protectionInfo": {
                    "policyName": "hyperv_Gold",
                    "subPolicyName": "VADP Backup(2000)",
                    "subPolicyId": "2000",
                    "storageProfileId": 2000,
                    "storageProfileName": "Gold",
                    "subPolicyLabel": null,
                    "subPolicyType": "BACKUP",
                    "subPolicySubType": "vsnap",
                    "originalSubPolicyType": null,
                    "protectionTime": 1565873191165,
                    "lastErrorMessage": null,
                    "recoveryPoint": "1365d24f-f8ca-4e29-9064-f487e8906701",
                    "mirrorLabel": null,
                    "snapLabels": null,
                    "snapShotName": null,
                    "protectedVolumePks": [],
                    "flashCopyIds": null,
                    "emcVnxSnapshotIds": null,
                    "cloudSnapshotIds": null,
                    "storageSnapshots": [
                        {
                            "storageType": "vsnap",
                            "storageSnapshotId": "2000.snapshot.87",
                            "snapshotReplicationId": null,
                            "snapshotVersionId": "17374895456114910019",
                            "storageId": "2000",
                            "storageVolumeId": "2000.volume.20",
                            "contentType": null
                        },
                        {
                            "storageType": "vsnap",
                            "storageSnapshotId": "2000.snapshot.87",
                            "snapshotReplicationId": null,
                            "snapshotVersionId": "17374895456114910019",
                            "storageId": "2000",
                            "storageVolumeId": "2000.volume.20",
                            "contentType": null
                        }
                    ],
                    "maskSnapshotIds": null,
                    "storageSiteIds": [
                        "1000"
                    ],
                    "primary": null,
                    "baseBackup": false,
                    "retentionInfo": {
                        "type": "days",
                        "count": 7,
                        "expiration": 1566478113751
                    },
                    "skippedVolumePks": [],
                    "protectionMethod": "VMWARE_CBT",
                    "resourceType": null,
                    "destinationPk": null,
                    "destinationInfo": {
                        "destinationFileName": null,
                        "vmx": null,
                        "vmxf": null,
                        "vmxBackup": null,
                        "vmxfBackup": null,
                        "configFile": "Virtual Machines\\8989CFF1-6F16-4E2B-9FCC
-9F8C8CD719C9.VMCX",
                        "extendedConfigFile": null,
                        "configFileBackup": null,
                        "extendedConfigFileBackup": null,
                        "backupPath": "sales-sql_8ee9123",
                        "destinationVolumeKey": "ae85b9df-5739-4de9-a287-b12ae2a
030b9"
                    },
                    "storageType": [
                        "VSNAP"
                    ],
                    "backupMetadata": null,
                    "backupDocumentKey": null,
                    "rmanTag": null,
                    "recoveryTransactionId": null,
                    "masked": false,
                    "forceBase": false,
                    "dbServerTime": null,
                    "incrementalSnapshot": false,
                    "isCGCreatedByEcx": false,
                    "transferDuration": 66668,
                    "transferSize": 9256960,
                    "storageInfo": "{\"localhost\":[\"spp_1014_2000_16c946367fd_
_16c94639564_15_vsnap\"]}",
                    "sppoFromVSnap": false,
                    "excludedFromBackup": false,
                    "dummyObject": false,
                    "backupPathsInfos": [
                        {
                            "destStorageVolumePk": "2000.volume.20",
                            "backupPaths": [
                                "sales-sql_8ee9123"
                            ]
                        },
                        {
                            "destStorageVolumePk": "2000.volume.20",
                            "backupPaths": [
                                "sales-sql_8ee9123"
                            ]
                        }
                    ],
                    "baseBackupSize": 9295626240,
                    "combinedDelta": 0
                },
                "parentPk": "2d60ba76-9161-3492-ae5d-80f0b067760a",
                "providerNodeId": "1002",
                "providerUniqueId": null,
                "siteId": null,
                "autoProvisionedsubPolicyName": null,
                "rbacPath": "root:0/hypervisor.all:0/hypervisor.type:hyperv/hype
rvisor:1002/vm:8989CFF1-6F16-4E2B-9FCC-9F8C8CD719C9",
                "rbacPathId": 186,
                "location": "/dallas-hv1",
                "metadataPath": "/MS:1002/VM:8989CFF1-6F16-4E2B-9FCC-9F8C8CD719C
9",
                "isProtected": false,
                "inHLO": false,
                "hypervisorType": "hyperv",
                "hypervisorKey": "1002",
                "hypervisorManagementServerID": "1002",
                "nativeKey": null,
                "cloudType": null,
                "tags": [],
                "tagCategories": [],
                "metadataPathVmHost": "/MS:1002/VM:8989CFF1-6F16-4E2B-9FCC-9F8C8
CD719C9/CLUST:2d60ba76-9161-3492-ae5d-80f0b067760a/HOST:8a88cacf-80f5-308d-bdaf
-f2939920ee87/VM:8989CFF1-6F16-4E2B-9FCC-9F8C8CD719C9",
                "rbacPathVmHost": "root:0/hypervisor.all:0/hypervisor.type:hyper
v/hypervisor:1002/vm:8989CFF1-6F16-4E2B-9FCC-9F8C8CD719C9/vcluster:2d60ba76-916
1-3492-ae5d-80f0b067760a/vhost:8a88cacf-80f5-308d-bdaf-f2939920ee87/vm:8989CFF1
-6F16-4E2B-9FCC-9F8C8CD719C9",
                "rbacPathIdVmHost": 187,
                "alternatePaths": [],
                "isTemplate": false,
                "isEncrypted": false,
                "powerSummary": {
                    "powerState": "ON",
                    "lastPowerOnTime": 1564750421466,
                    "lastPowerOffTime": 0,
                    "lastSuspendTime": 0,
                    "uptime": 0
                },
                "storageSummary": {
                    "commited": 9295626240,
                    "uncommited": 45465206784,
                    "shared": 0
                },
                "hypervisorHostKey": "8a88cacf-80f5-308d-bdaf-f2939920ee87",
                "hypervisorHostName": "dallas-hv1",
                "volumes": [
                    {
                        "name": "csvvol1",
                        "key": "2b7532f9-7f2e-4457-ab79-160b631fc66f",
                        "isConfigVolume": false
                    },
                    {
                        "name": "csvvol2",
                        "key": "9dab0f74-ace3-4d1a-bb5a-07e7ed10c185",
                        "isConfigVolume": true
                    }
                ],
                "uniqueId": "8989CFF1-6F16-4E2B-9FCC-9F8C8CD719C9",
                "configFilePath": "Virtual Machines\\8989CFF1-6F16-4E2B-9FCC-9F8
C8CD719C9.VMCX",
                "fileDirPath": "SSwin2k12",
                "cluster": {
                    "name": "dallas-hv1",
                    "key": "2d60ba76-9161-3492-ae5d-80f0b067760a"
                },
                "cpu": 1,
                "coresPerCpu": 1,
                "memory": 1073741824,
                "vmVersion": "8.0",
                "vmStorageUtilization": 0,
                "vmDestVolDedupCompressionInfo": [],
                "configInfo": {
                    "name": null,
                    "comment": null,
                    "creatorId": 0,
                    "creationTime": null,
                    "type": null,
                    "flags": 0,
                    "pk": null,
                    "sessionId": null,
                    "objType": null,
                    "jobId": null,
                    "host": null,
                    "providerNodeId": null,
                    "providerUniqueId": null,
                    "siteId": null,
                    "autoProvisionedsubPolicyName": null,
                    "isProtected": false,
                    "inHLO": true,
                    "hypervisorType": null,
                    "hypervisorKey": null,
                    "hypervisorManagementServerID": null,
                    "nativeKey": null,
                    "cloudType": null,
                    "tags": null,
                    "tagCategories": null,
                    "vmId": null,
                    "osName": null,
                    "osVersion": null,
                    "hostName": null,
                    "vmToolsStatus": null,
                    "guestNetworkInfo": []
                }
            }
        },
        {...}, ..., {...}
    ]
}