Backup node registration API - IBM PowerVC for Private Cloud version 2.3.1

Options for backup node registration APIs

Table 1. Options for backup node registration APIs
Method	URI	Description
POST	`/v3/{project-id}/backup-nodes`	Registers or adds a backup node.
PUT	`/v3/{project-id}/backup-nodes/{id}`	Updates a backup node.
DELETE	`/v3/{project-id}/backup-nodes/{id}`	Deletes or deregister a backup node.
GET	`/v3/{project-id}/backup-nodes/{id}`	Shows the details of a backup node.
GET	`/v3/{project-id}/backup-nodes`	Lists all backup nodes
PUT	`/v3/{project-id}/backup-nodes/{id-of-backup-node}/discover`	Discovers existing image OVAs on the backup node.

Backup node registration

This operation adds a backup node to PowerVC. This API takes configuration attributes for the backup node in the request body as input and registers the backup node with PowerVC.

Response code

Normal Response Code: OK (201)

Request parameters

Table 2. Parameters in the request for backup node registration
Name	Style	Type	Description
`access_ip`	body	string	IP address of the virtual machine that is being registered as the backup node.
`user_id`	body	string	User ID of the backup node.
`password`	body	string	Password for backup node.
`display_name`	body	string	Display name of the backup node.
`cos_default`	body	string	Optional. Name of the COS bucket to be used as default.

Example of registering a backup node:

{
    "backup_nodes": {
        "registration": {
            "access_ip": "9.X.X.X",
            "user_id": "user1",
            "password": "p#####",
            "display_name": "Backup-node-111",
            "cos_default”: "bucket-1"
        }
    }
}

Response body

Table 3. Parameters in the response for backup node registration
Name	Style	Type	Description
`id`	body	string	Displays backup node ID.
`access_ip`	body	string	IP address of the virtual machine that is being registered as the backup node.
`user_id`	body	string	User ID for connecting to the VM.
`display_name`	body	string	Display name of the backup node.
`backup_node_id`	body	string	Displays backup node ID.
`unique_id`	body	string	Unique ID of the backup node.
`cos_default`	body	string	Name of the COS bucket to be used as default.
`registered_at`	body	string	Date and time details of backup node creation.

Example response when registering a backup node:

{
   "backup_node":{
      "registration":{
         "id":1,
         "access_ip":"9.X.X.X",
         "user_id":"user1",
         "display_name":"Backup-node-111",
         "backup_node_id":"vm-xxx",
         "unique_id":"30:cc:f7:ed:1b:ff:be:e3:55:c8:7b:af:ba:2c:1e:73",
         "cos_default":"bucket-1",
         "registered_at":"2021-01-20T11:50:38Z"
      }
   }
}

Update a backup node

This operation updates the registration information for a backup node in PowerVC. This API takes the backup node ID for which you want to change the attributes in the URI and the attributes that you want to change in the body as input. The response body contains the attributes that are updated by the request.

Response code

Normal Response Code: OK (201)

Request parameters

Table 4. Parameters in the request for updating a backup node
Name	Style	Type	Description
`access_ip`	body	string	IP address of the virtual machine that is being registered as the backup node.
`user_id`	body	string	User ID for connecting to the VM.
`password`	body	string	Password for connecting to the VM.
`display_name`	body	string	Display name of the backup node.
`cos_default`	body	string	Optional. Name of the COS bucket to be used as default.

All the attributes in the request body are optional. You can update all the attributes or any one of the attributes. Example of updating a backup node:

{
    "backup_nodes": {
        "registration": {
            "access_ip": "9.x.x.x",
            "user_id": "user2",
            "password": "p#####",
            "display_name": "Backup-node-112",
            "cos_default”: “bucket-1"
        }
    }
}

Response body

Table 5. Parameters in the response for updating a backup node
Name	Style	Type	Description
`access_ip`	body	string	IP address of the virtual machine that is being registered as the backup node.
`user_id`	body	string	User ID for connecting to the VM.
`display_name`	body	string	Display name of the backup node.
`cos_default`	body	string	Name of the COS bucket to be used as default.

Example response when updating a backup node:

{
    "backup_node": {
        "registration": {
            "access_ip": "9.x.x.x",
            "user_id": "user2",
            "display_name": "Backup-node-112",
            "cos_default": "bucket-1"
        }
    }
}

Deregister a backup node

This operation deregisters backup node from PowerVC. This API takes the backup node ID in the URI as input and takes uninstall and force as optional parameters. The API does not take any request body.

Response codes

Normal Response Code: No Content (204)

Example for deregister backup node API

/v3/{project-id}/backup-nodes/{id}?<uninstall=true&force=false>

Default option for force and uninstall parameters is false.
If force is set to true, then backup node will be removed even if there are image backups existing on the backup node.
If uninstall option is set true, PowerVC will be uninstalled from the backup node.

View backup node details

This operation displays the basic information about a backup node that is registered in PowerVC. This API takes no input in the request body and returns the name and display name of the backup node in the response body.

Response code

Normal Response Code: OK (200)

Response body

Table 6. Parameters in the response body for viewing details of a backup node
Name	Style	Type	Description
`created_at`	body	string	Date and time details of backup node creation.
`updated_at`	body	string	Date and time details when the backup node was updated.
`deleted_at`	body	string	Details of backup node deletion.
`deleted`	body	Boolean	Displays whether the backup node is deleted.
`id`	body	string	Displays backup node ID.
`display_name`	body	string	Display name of backup node.
`user_id`	body	string	User ID for connecting to the VM.
`password`	body	string	Password for connecting to the VM.
`access_ip`	body	string	Displays IP address of the backup node.
`backup_node_id`	body	string	ID of the backup node.
`unique_id`	body	string	Unique ID of the backup node.
`cos_default`	body	string	Name of the COS bucket to be used as default.
`driver_meta`	body	string	Additional metadata for the cinder backup driver.
`health_status`	body	string	Health status of the backup node.

{
"backup_node": 
{
"created_at": "2021-07-22T07:30:30.000000",
"updated_at": null,
"deleted_at": null,
"deleted": false,
"id": 1,
"display_name": "Backupnode235",
"user_id": "root",
"password": "aes-ctr:ODI1NDg4NDM2NzE2MzA2NTI5NTrWHkifHf/NNg==",
"access_ip": "9.114.254.235",
"backup_node_id": "zsa333",
"unique_id": "48:8e:78:35:ec:ad:7f:26:2e:12:9d:19:cf:ce:d8:53",
"cos_default": null,
"private_key": null,
"driver_meta": null,
"health_status": {
"id": "cinder-backup_1",
"health_value": "OK",
"updated_at": "2021-07-22T10:02:07.083218",
"value_reason": []
}
}
}

View list of backup nodes

This operation lists the basic information about all of the backup nodes that are registered in PowerVC. This API takes no input in the request body and returns the details of backup node in the response body.

Response code

Normal Response Code: OK (200)

Response body

Table 7. Parameters in the response body for viewing all of the backup nodes
Name	Style	Type	Description
`created_at`	body	string	Date and time details of backup node creation.
`updated_at`	body	string	Date and time details when the backup node was updated.
`deleted_at`	body	string	Details of backup node deletion.
`deleted`	body	Boolean	Displays whether the backup node is deleted.
`id`	body	string	Displays backup node ID.
`display_name`	body	string	Display name of backup node.
`user_id`	body	string	User ID for connecting to the VM.
`password`	body	string	Password for connecting to the VM.
`access_ip`	body	string	Displays IP address of the backup node.
`backup_node_id`	body	string	ID of the backup node.
`unique_id`	body	string	Unique ID of the backup node.
`cos_default`	body	string	Name of the COS bucket to be used as default.
`driver_meta`	body	string	Additional metadata for the cinder backup driver.
`health_status`	body	string	Health status of the backup node.

{
    "backup_nodes": [
    {
        "created_at": "2021-01-20T11:50:18.000000",
        "updated_at": null,
        "deleted_at": null,
        "deleted": false,
        "id": 1,
        "display_name": "Backup-Node-111",
        "user_id": "user1",
        "password": "aes-ctr:MjIwODM2NTU4NjA2NjMzNTEyNTpWGqvSof82Ng==",
        "access_ip": "9.x.x.x",
        "backup_node_id": "vm-xxx",
        "unique_id": "30:cc:f7:ed:1b:ff:be:e3:55:c8:7b:af:ba:2c:1e:73",
        "cos_default": "bucket-1”,
        "private_key": null,
        "driver_meta": null,
        "health_status": {
            "id": "cinder-backup_1",
            "health_value": "OK",
            "updated_at": "2021-01-20T12:13:40.045583",
            "value_reason": []
        }
     },
    {
        "created_at": "2021-02-20T11:50:18.000000",
        "updated_at": null,
        "deleted_at": null,
        "deleted": false,
        "id": 2,
        "display_name": "Backup-Node-113",
        "user_id": "user3",
        "password": "aes-ctr:EjIwODM2NTU4NjA2NjMzNTEyNTpWGqvSof82FR==",
        "access_ip": "9.x.x.x",
        "backup_node_id": "vm-xxx",
        "unique_id": "30:cc:f7:ed:1b:ff:be:e3:55:c8:7b:af:ba:2c:1e:73",
        "cos_default": "new-bucket-suman2”,
        "private_key": null,
        "driver_meta": null,
        "health_status": {
            "id": "cinder-backup_2",
            "health_value": "OK",
            "updated_at": "2021-02-20T12:13:40.045583",
            "value_reason": []
        }
     }
    ]
    }

Discover image OVAs on a backup node

Displays number of image OVAs on a backup node registered in PowerVC. The image OVAs can be manually added or the ones remaining after deregistration. This API takes no input in the request body and returns the image OVA count in the response body.

Response code

Normal Response Code: OK (200)

Response body

Table 8. Parameters in the response body for discovering manually added image OVAs
Name	Style	Type	Description
`ova_count`	body	string	Displays the number of image OVAs found on a backup node.

Example response when viewing the image OVAs:

{
    "backup_node": {
        "ova_count": 3
    }
}