Adding disk storage: vSnap server

Add a vSnap server to IBM Spectrum Protect Plus.

Method and URI

To add a vSnap server to IBM Spectrum Protect Plus, use a POST method and a URI:

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

Parameters

None.

Data

Data 1: hostAddress

The hostname or the IPv4 address of the vSnap server.

  • Example value: 10.0.1.1

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

Data 2: siteId

The {siteId} of the site to associate with the vSnap server.

  • Example value: 1000

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

Tip

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

Data 3: type

The type of the disk storage. Use the vSnap server which is only available disk storage for IBM Spectrum Protect Plus.

  • Value: vsnap

  • Type: System string. Required.

Data 4: username

The username of the vSnap server.

  • Example value: sarah-vsnap1

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

Data 5: password

The password of the vSnap server.

  • Example value: 6bxPYs6eQNa!V85R

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

Data 6: portNumber

The port number to connect to the vSnap server.

  • Example value: 8900

  • Type: Integer. Required.

Data 7: sslConnection

Indication of whether SSL is used to connect with the vSnap server.

  • Example value: true

  • Type: Boolean. Required.

Example: Add a vSnap server

Assume that you want to add the following vSnap server to IBM Spectrum Protect Plus:

  • Hostname/IP: 10.0.1.1

  • Site: Primary ({siteId} 1000)

  • User name: sarah-vsnap1

  • Password: 6bxPYs6eQNa!V85R

  • Port: 8900

  • SSL connection: Enable

A Python snippet that is similar to the following example can be used to add the vSnap server to IBM Spectrum Protect Plus.

_data = f'''{{
     "hostAddress":   "10.0.1.1",
     "siteId":        "1000",
     "type":          "vsnap",
     "username":      "sarah-vsnap1",
     "password":      "6bxPYs6eQNa!V85R",
     "portNumber":    8900,
     "sslConnection": true
}}'''

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

Figure 32 An equivalent action can be done from a web browser: In the navigation pane, click System Configuration > Backup Storage > Disk and click Add Disk Storage.

The request prompts a response that is structured as shown, with the HTTP status of 201 (Created). Review the response to ensure that the vSnap server was added.

{
    "statusCode": 201,
    "response": {
        "links": {...},
        "resourceType": "storage",
        "type": "vsnap",
        "typeDisplayName": "vSnap",
        "site": "1000",
        "name": "10.0.1.1",
        "storageId": "2101",
        "user": {
            "href": "https://10.0.1.1:-1/api/identity/user/2120"
        },
        "rbacPath": "root:0/site:0/site:1000/site.all.storage:1000/storage:2101"
,
        "hostAddress": "10.0.1.1",
        "portNumber": 8900,
        "sslConnection": true,
        "initializeStatus": "Not Initialized",
        "initializeStatusDisplayName": "Not Initialized",
        "storageProfiles": null,
        "version": "10.1.8-1824",
        "capacity": null,
        "activeDirectoryInfo": null,
        "demo": false,
        "maxStreams": null,
        "isReady": false
        "statistics": {
            "storageId": "2101",
            "sizeTotal": 0,
            "sizeUsed": 0,
            "sizeFree": 0,
            "writable": true,
            "site": "1000",
            "description": null,
            "compressionRatio": "0.00",
            "deduplicationRatio": "0.00",
            "type": "vsnap",
            "errorDescription": null,
            "time": null,
            "lastUpdateTimestamp": null,
            "pools": []
        }
    }
}