Registering a VADP proxy

You can register a VADP proxy with the IBM Spectrum Protect Plus system environment.

Method and URI

To register a VADP proxy with the IBM Spectrum Protect Plus system environment, use a POST method and a URI:

POST    https://{hostname|IPv4}/ngp/vadp

Parameters

None.

Data

Data 1: pushinstall

  • Example value:

Install the VADP proxy application on the Linux system.

{
    "hostAddress": "10.0.2.1"
}
  • Type: JSON object. Required. Available in the web user interface.

Data 1.1: pushinstall > hostAddress

The IPv4 address or the hostname of the Linux system.

Data 2: identityId

The {identityId} of the identity to log in to the Linux system.

  • Example value: 2110

Tip

To get a {siteId} value based on the name of the site, follow the instructions in Getting a {siteId}.

  • Type: String. Required. Available in the web user interface.

Data 3: registration

  • Example value:

{
    "siteId": "3102"
}
  • Type: JSON object. Required. Available in the web user interface.

Data 3.1: registration > siteId

The {siteId} of the site to associate with the VADP proxy.

Tip

To get a {siteId} value based on the name of the site, follow the instructions in Getting a {siteId}.

Type: String. Required. Available in the web user interface.

Example: Installing a VADP proxy

Assume that you want to install a VADP proxy on the following Linux system and add it to IBM Spectrum Protect Plus:

  • Name: centos-vadp-dallas1

  • IPv4 address: 10.0.2.1

  • Identity: sarah-vadp1_10.0.2.1 ({identityId} 2110)

  • Site: Dallas ({siteId} 3101)

A Python snippet that is similar to the following example can be used to install the VADP proxy on the Linux system and register the proxy with IBM Spectrum Protect Plus:

_data = f'''{{
     "pushinstall": {
         "hostAddress":"10.0.2.1"
     },
     "identityId":   "2110",
     "registration":{
         "siteId":"3101"
     }

}}'''

requests.post('https://' + spp_ipv4 + '/ngp/vadp',
    headers={...}, data=_data, verify=...)
_images/reference_vadp_register01.png

Figure 48 The same action can be taken in the IBM Spectrum Protect Plus web user interface: In the navigation pane, click System Configuration > VADP Proxy. Click Register Proxy. Enter the required values in the fields and click Install.

The request prompts a response with the HTTP status of 201 (Created). Review the response to ensure that the new VADP proxy, centos-vadp-dallas1, was added. The response body is similar to the JSON object for centos-vadp-dallas1, as shown in Getting VADP proxy information.