Getting VADP proxy information

You can get information about VADP proxies that are registered with IBM Spectrum Protect Plus.

Method and URI

To get information about all VADP proxy servers, use a GET method and a URI:

GET     https://{hostname|IPv4}/api/vadp

Parameters

None.

Data

None.

Example: Get VADP proxy information

Assume that you registered a VADP proxy with IBM Spectrum Protect Plus, in addition to the onboard VADP proxy.

A Python snippet that is similar to the following example can be used to get information about the VADP proxies:

requests.get('https://' + spp_ipv4 + '/api/vadp',
    headers={...}, verify=...)
_images/reference_vadp_get01.png

Figure 49 The same action can be taken in the IBM Spectrum Protect Plus web user interface: Click Refresh.

The following response body displays information about VADP proxies. The HTTP status of this response is 200 (“OK”).

{
    "links": {...},
    "vadps": [
        {
            "links": {...},
            "id": 2103,
            "siteId": 3101,
            "siteName": "Dallas",
            "displayName": "centos-vadp-dallas1",
            "hostName": "10.0.2.1",
            "ipAddr": "10.0.2.1",
            "securePort": 8098,
            "rbacPath": "root:0/proxy:0/proxy.type:VMDKBACKUP.VADPPROXY/proxy.ty
pe.VMDKBACKUP.VADPPROXY:2,103",
            "corecount": 0,
            "availablememory": 0,
            "version": "10.1.6.0000",
            "state": "ENABLED",
            "stateDisplayName": "Enabled",
            "isLocal": false,
            "demo": false,
            "user": {
                "href": "https://10.0.0.100/api/identity/user/2154"
            }
        },
        {
            "links": {...},
            "id": 2000,
            "siteId": 1000,
            "siteName": "Primary",
            "displayName": "spp-dallas1a",
            "hostName": "spp-dallas1a",
            "ipAddr": "127.0.0.1",
            "port": 8080,
            "rbacPath": "root:0/proxy:0/proxy.type:VMDKBACKUP.VADPPROXY/proxy.ty
pe.VMDKBACKUP.VADPPROXY:2,000",
            "corecount": 0,
            "availablememory": 0,
            "version": "10.1.6.0000",
            "state": "ENABLED",
            "stateDisplayName": "Enabled",
            "isLocal": true,
            "demo": false,
            "user": {
                "href": "https://10.0.0.100/api/identity/user/-1"
            }
        },
        {...}, {...}
    ],
    "enabled": [
        {
            "links": {...},
            "id": 2000,
            "siteId": 1000,
            "siteName": "Primary",
            "displayName": "spp-dallas1a",
            ...
        },
        {
            "links": {...},
            "id": 2103,
            ...,
        },
        {...}
    ],
    "suspended": [
        {
            "links": {...},
            "id": 2105,
            "siteId": 1001,
            "siteName": "Secondary",
            "displayName": "vsnap-singapore1",
            ...,
            "version": "10.1.5.1008",
            "state": "SUSPENDED",
            "stateDisplayName": "Suspended",
            ...
        }
],
    "available": []
}