Additional actions for a VADP proxy

You can take additional actions with a VADP proxy: suspending the VADP proxy temporarily, resuming the suspended VADP proxy, and uninstalling the VADP proxy application from the VADP proxy server. If you uninstall the VADP proxy will be unregistered from IBM Spectrum Protect Plus.

Method and URI

To take additional actions such as suspending, resuming, or uninstalling the VADP proxy, use a POST method with a URI:

POST    https://{hostname|IPv4}/api/vadp/{vadpId}

Tip

To get a {vadpId} value based on the IPv4 address of the VADP proxy, follow the instructions in Getting a {vadpId}.

Parameters

Parameter 1: action

Specify the type of action.

  • Value: Use one of the following values:

Action

Value

Suspend

suspend

Resume

resume

Uninstall

uninstall

Tip

To unregister a VADP proxy, follow the instructions in Unregistering a VADP proxy.

  • Type: System string. Required. Available in the web user interface.

Data

None.

Example: Suspend a VADP proxy

Assume that you have a VADP proxy, centos-vadp-dallas1 ({vadp_id} 2102), and you want to suspend the VADP proxy.

A Python snippet that is similar to the following example can be used to suspend the VADP proxy from IBM Spectrum Protect Plus:

_params = {"action": "suspend"}

requests.post('https://' + spp_ipv4 + '/api/vadp/' + vadp_id,
    headers={...}, params=_params, verify=...)

Ensure that you get a response with the HTTP status of 200 (OK) and the VADP proxy is suspended. You can take other actions (resuming and uninstalling) in a similar way.