Report Protected and Unprotected VMs

Use the report Protected and Unprotected VMs or any custom report based on it.

_images/reference_report_run100201.png

Figure 83 The option menus in the web browser.

_images/reference_report_run100202.png

Figure 84 An example report.

Data

paramValues

Key

Value (example)

Type

Description

NodeCascadingParameterGroup

[“…”, …, “…”]

Arrays RequiredBrowser

Target vSnap server’s {vsnapId}

NodeCascadingParameterGroup

[“…”, …, “…”]

Arrays RequiredBrowser

Target vSnap server’s {vsnapId}

Example

Consider the predefined report Protected and Unprotected VM has the {reportId} 1002. You want to run it with the following options:

  • Hypervisor Type: VMware

    • vCenter(s): 10.0.0.10 (BlueMachines vCenter - Dallas)

      • vCenter tag(s): Dallas-Production

The following Python snippet can be used to run it:

report_id = "1002"    # Protected and Unprotected VMs (predefined)

_params = {"action": "run"}

_data = f'''
   {{
       "paramValues": {{
           "NodeCascadingParameterGroup-HypervisorType": "vmware",
           "NodeCascadingParameterGroup-Hypervisor":     ["1001"]
           "UnprotectedVMs":                             false,
           "OffloadedVMs":                               false,
           "tags":                                       ["Dallas-Production"]
           }}
   }}'''

requests.get('https://' + spp_ipv4 + '/api/endeavour/report/' + report_id,
    headers={...}, params=_params, data=_data, verify=...)

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

{
    "links": {...},
    "name": "Protected VMs",
    "displayName": "Protected and Unprotected VMs",
    "description": "Review the Managed VM Count & Capacity for measuring license
.",
    "categoryDisplayName": "Protection",
    "custom": false,
    "creationTime": 1564685718097,
    "paramValues": {
        "NodeCascadingParameterGroup-HypervisorType": "(All)",
        "OffloadedVMs": false,
        "UnprotectedVMs": false,
        "NodeCascadingParameterGroup-Hypervisor": [
            "(All)"
        ],
        "tags": [
            "(All)"
        ]
    },
    "parentName": "Protected VMs",
    "parentDisplayName": "Protected and Unprotected VMs",
    "rbacPath": "root:0/report:0/reportcategory:ProtectionCategoryName/report:10
02",
    "id": "1002"
}