Compute plane node API - IBM PowerVC for Private Cloud version 2.3.1

Options for Compute plane APIs

Table 1. Options for Compute plane APIs
Method	URI	Description
POST	`/v2.1/{tenant_id}/compute-planes`	Registers or adds a Compute plane.
GET	`/v2.1/{tenant_id}/compute-planes/{compute_plane_id}`	Shows details of compute plane.
GET	`/v2.1/{tenant_id}/compute-planes`	Gets a list of all compute planes.
DELETE	`/v2.1/{tenant_id}/compute-planes/{compute_plane_id}`	Deregisters the compute plane in the backend and uninstalls PowerVC from it if `uninstall` is set to true.
PUT	`/v2.1/{tenant_id}/compute-planes/{compute_plane_id}`	Updates the display name and credentials of the compute plane.

Compute plane registration

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

Response code

Normal Response Code: OK (200)
Error response code: Bad Request (400), Forbidden (403), Not Found(404), Server Error (500)

Request parameters

Table 2. Parameters in the request for Compute plane registration
Name	Style	Type	Description
`display_name`	body	string	Display name of the Compute plane.
`access_ip`	body	string	Access IP of the Compute plane.
`user_id`	body	string	User ID of the Compute plane node.
`password`	body	string	Password for Compute plane node.

Example of registering a Compute plane:

{
    "compute_planes": {
        "registration": {
            "access_ip": "9.x.x.x",
            "user_id": "root",
            "password": "powervc123",
            "display_name": "bak2"
        }
    }
}

Response body

Table 3. Parameters in the response for Compute plane registration
Name	Style	Type	Description
`display_name`	body	string	Display name of the Compute plane.
`access_ip`	body	string	Access IP of the Compute plane registered.
`user_id`	body	string	User ID of the Compute plane node registered.
`unique_id`	body	string	Unique ID of Compute plane node registered.
`id`	body	string	ID of Compute plane node registered.
`registered_at`	body	string	Time when the Compute plane node was registered.

Example response when registering a Compute plane node:

{
    "compute_plane": {
        "registration": {
            "access_ip": "9.x.x.x",
            "user_id": "root",
            "display_name": "bak2",
            "unique_id": "1f:e2:f0:16:da:97:e1:3d:49:0a:13:4b:22:2e:16:ff",
            "id": 5,
            "registered_at": "2021-09-29T16:51:49Z"
        }
    }
}

Update a Compute plane node

This operation updates the registration information for a Compute plane node in PowerVC. This API takes the Compute plane 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)
Error response code: Bad Request (400), Not Found (404), Server Error (500)

Request parameters

Table 4. Parameters in the request for updating a Compute plane node
Name	Style	Type	Description
`user_id`	body	string	User ID for connecting to the Compute plane node.
`password`	body	string	Password for connecting to the Compute plane.
`display_name`	body	string	Display name of the Compute plane.

Example:

{
    "compute_planes": {
        "registration": {
            "user_id": "root1"
        }
    }
}

Response body

Table 5. Parameters in the response for updating a Compute plane node
Name	Style	Type	Description
`user_id`	body	string	User ID for connecting to the Compute plane node.
`password`	body	string	Password for connecting to the Compute plane.
`display_name`	body	string	Display name of the Compute plane.

Example response:

{
        "registration": {
            "user_id": "root1"
        }
}

Deregister a Compute plane node

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

Response codes

Normal Response Code: OK (204)
Error Response Codes: Unauthorized (401), Not Found (404)

Example for deregister Compute plane API

DELETE  /compute/v2.1/{tenant_id}/compute-planes/3?uninstall=true

View Compute plane node details

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

Response code

Normal Response Code: OK (200)
Error response code: Unauthorized (401)

Response body

Table 6. Parameters in the response body for viewing details of a Compute plane node
Name	Style	Type	Description
`created_at`	body	string	Time when the compute plane node was registered.
`updated_at`	body	string	Time when the compute plane node was updated.
`deleted_at`	body	string	Time when the compute plane node was deleted.
`deleted`	body	Boolean	Displays whether the Compute plane node is deleted. 0 means not deleted and 1 indicates deleted.
`id`	body	string	ID of the compute plane node registered
`display_name`	body	string	Display name of the Compute plane registered.
`user_id`	body	string	User ID for the Compute plane node registered.
`unique_id`	body	string	Unique id of the Compute plane node registered
`access_ip`	body	string	Access IP of the Compute plane registered.
`password`	body	string	Encrypted password of the Compute plane node.
`private_key`	body	string	Represents location of private key for compute plane. (currently not supported)

Example response body:

{
    "compute_plane": {
        "created_at": "2021-09-29T16:39:35.000000",
        "updated_at": null,
        "deleted_at": null,
        "deleted": 0,
        "id": 4,
        "display_name": "bak1",
        "user_id": "root",
        "password": "aes-ctr:MTk0NTIwODIzMTkzMjEyMDE0Olkg+CkM8rajiLM=",
        "access_ip": "9.x.x.x",
        "unique_id": "79:16:ab:5d:52:12:c4:08:0f:b6:1d:03:66:09:f0:48",
        "private_key": null
    }
}

View list of Compute plane nodes

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

Response code

Normal Response Code: OK (200)
Error response code: Unauthorized (401)

Response body

Table 7. Parameters in the response body for viewing all of the Compute plane nodes
Name	Style	Type	Description
`created_at`	body	string	Time when the compute plane node was registered.
`updated_at`	body	string	Time when the compute plane node was updated.
`deleted_at`	body	string	Time when the compute plane node was deleted.
`deleted`	body	Boolean	Displays whether the Compute plane node is deleted. 0 means not deleted and 1 indicates deleted.
`id`	body	string	ID of the compute plane node registered
`display_name`	body	string	Display name of the Compute plane registered.
`user_id`	body	string	User ID for the Compute plane node registered.
`unique_id`	body	string	Unique id of the Compute plane node registered
`access_ip`	body	string	Access IP of the Compute plane registered.
`password`	body	string	Encrypted password of the Compute plane node.
`private_key`	body	string	Represents location of private key for compute plane. (currently not supported)

{
    "compute_planes": [{
            "created_at": "2021-09-29T16:39:35.000000",
            "updated_at": null,
            "deleted_at": null,
            "deleted": 0,
            "id": 4,
            "display_name": "bak1",
            "user_id": "root",
            "password": "aes-ctr:MTk0NTIwODIzMTkzMjEyMDE0Olkg+CkM8rajiLM=",
            "access_ip": "9.x.x.x",
            "unique_id": "79:16:ab:5d:52:12:c4:08:0f:b6:1d:03:66:09:f0:48",
            "private_key": null
        },
        {
            "created_at": "2021-09-29T16:49:00.000000",
            "updated_at": null,
            "deleted_at": null,
            "deleted": 0,
            "id": 5,
            "display_name": "bak2",
            "user_id": "root",
            "password": "aes-ctr:MTQzMjQwNDgzMjc0MDI2ODkzNTrIwbTC7MS/l4X+",
            "access_ip": "9.x.x.x",
            "unique_id": "1f:e2:f0:16:da:97:e1:3d:49:0a:13:4b:22:2e:16:ff",
            "private_key": null
        }
    ]
}