Report Configuration

Use the report Configuration or any custom report based on it.

_images/reference_report_run100101.png

Figure 85 An equivalent action on a web browser.

_images/reference_report_run100102.png

Figure 86 An example report of vSnap Storage Utilization

Data

paramValues

Key

Value (example)

Type

Description

ConfigurationType

[“…”, …, “…”]

Arrays RequiredBrowser

Target vSnap server’s {vsnapId}

paramValues > ConfigurationType

Value (example)

Type

Description

(All)

String Browser

Select all the options

Application Servers

String Browser

Select Application Servers

Backup Storage - Cloud

String Browser

Select Backup Storage - Cloud

Backup Storage - Disk

String Browser

Select Backup Storage - Disk

Backup Storage - Repository Server

String Browser

Select Backup Storage - Repository Server

Hypervisors

String Browser

Select Hypervisors

LDAP

String Browser

Select LDAP

SMTP

String Browser

Select SMTP

VADP Proxy

String Browser

Select VADP Proxy

Example

Consider the predefined report Configuration has the {reportId} 1001. You want to run it with the following options:

  • Configuration Type

    • Application Servers, Backup Storage - Disk, Hypervisors

The following Python snippet can be used to run it:

report_id = "1001"    # Configuration (predefined)

_params = {"action": "run"}

_data = f'''
   {{
       "paramValues": {{
                          "ConfigurationType": [
                              "Application Servers",
                              "Backups Storage - Disk",
                              "Hypervisors"
                          ],
                      }}
   }}'''

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

To select all in the Configuration Type, replace the _data parameter with below:

_data = f'''
   {{
       "paramValues": {{
                          "ConfigurationType": [
                              "(All)"
                          ],
                      }}
   }}'''

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

{
    "links": {...},
    "name": "Configuration",
    "displayName": "Configuration",
    "description": "Review Node Configuration and associated policies.",
    "categoryDisplayName": "System",
    "custom": false,
    "creationTime": 1564685718014,
    "paramValues": {
        "ConfigurationType": [
            "(All)"
        ]
    },
    "parentName": "Configuration",
    "parentDisplayName": "Configuration",
    "rbacPath": "root:0/report:0/reportcategory:ECXMgmtCategory/report:1001",
    "id": "1001"
}