Supported OpenStack Compute (Nova) APIs

General APIs

Flavors APIs

Use flavors APIs to work with PowerVC compute templates. PowerVC uses the term compute template instead of flavor.

Host aggregates (host groups) APIs

Hypervisors APIs

Image APIs

Interface APIs

Key Pair APIs

Limits, quotas, and usage APIs

Server groups APIs

Servers APIs

Optical device attachment and detachment of VM APIs

Optical device attachment API

Depending on the specific platform or system that you work with, the response body might contain information about the success of the operation, error messages, or details about the attached optical device.

Response codes

• Normal response code - OK (200)

Request parameters

Table 12. Parameters in the request body for optical device attachment

Name	Style	Type	Description
network_cfg	Body	Boolean	Indicates whether the network configuration is required (true or false). Currently, there is no false value for this parameter. This parameter is mandatory.
reboot_vm	Body	String	Indicates whether the virtual machine must be powered on. The valid values are soft, hard, or an empty string. If no value is provided, the VM is not powered on. This parameter is optional.
remove_vopt	Body	Boolean	Indicates whether the virtual optical media (vopt) is to be removed during the VM restart or during the next power-on operation. When the remove_vopt is set to true and the CONF.powervm.remove_vopt_media_on_boot is enabled, the virtual optical media is removed based on the configured time. This parameter is optional. If a restart (reboot_vm) is requested, the vopt media removal is scheduled during the power-on operation with a time delay (CONF.powervm.remove_vopt_media_time) that can be configured. If a restart (reboot_vm) is not requested, a metadata flag remove_vopt_on_power_on=true is set to remove the vopt during the next VM power-on operation.

Request body example

{
    "optical_device_attach": {
        "network_cfg": true,
        "reboot_vm":"soft",
        "remove_vopt": true
    }
}

Optical device detachment API

Response codes

• Response code - No Content (204)

Request body example

{ "optical_device_detach": {} }

Server interface APIs

Server volume attachment APIs

Availability zone APIs

Modify VM attributes after deployment

A new server action API has been added to modify the attributes of a virtual machine outside resize flow, where these updates do not involve any DLPAR operations.

Today, if any of the non-core/non-memory attributes needs to be modified for a virtual machine after it is deployed, customers will have to invoke the resize API to perform the operation. This new server action API alleviates the need for having to go through resize flow for modifying such attributes, in certain cases not having to shutdown the VM and change it dynamically. This is supported for virtual machines deployed on HMC and Novalink.

The above attributes can be specified either in one single request to be updated on the virtual machine, or confine to a specific set of attributes as needed to be modified or updated on the virtual machine.

Migration of VMs to a different host group API

Live migration of VMs to a different host group API

Table 19. Live migration of VMs to a different host group API option

Method	URI	Description
POST	/v2.1/{tenant_id}/servers/{server_id}/action	Migrates the specified server to a new host without restarting the server. Specify the os-migrateLive action in the request body.

Response codes

• Normal response code - Accepted (202)
• Error response code - Bad Request (400), Unauthorized (401), Forbidden (403) Not Found (404), Conflict (409)

Response parameters

Table 20. Parameters in the request body for live migration of VMs to a different host group API

Name	Style	Type	Description
os-migrateLive	Body	String	The action.
host	Body	String	The host where the server is migrated. This parameter is mandatory if ignore_az is True.
block_migration	Body	Boolean	Set to True to migrate local disks by using block migration. If the source or destination host uses shared storage and you set this value to True, the live migration fails.
disk_over_commit	Body	Boolean	Set to True to enable over commit when the destination host is checked for available disk space. Set to False to disable over commit. This setting impacts only the libvirt virt driver.
force	Body	Boolean	Force a live migration by not verifying the provided destination host by the scheduler. This parameter is optional.
ignore_az	Body	Boolean	Set to True if the server must be migrated to a host that is not a member of the same host group as the source host.

Cold migration of VMs to a different host group API

Table 21. Cold migration of VMs to a different host group API option

Method	URI	Description
POST	/v2.1/{tenant_id}/servers/{server_id}/action	Migrates the specified server to a new host if the server is powered-off. Specify the migrate action in the request body.

Response codes

• Normal response code - Accepted (202)
• Error response code - Bad Request (400), Unauthorized (401), Forbidden (403) Not Found (404), Conflict (409)

Response parameters

Table 22. Parameters in the request body for cold migration of VMs to a different host group API

Name	Style	Type	Description
migrate	Body	String	The action.
host	Body	String	The host where the server is migrated. This parameter is mandatory if ignore_az is True.
ignore_az	Body	Boolean	Set to True if the server must be migrated to a host that is not a member of the same host group as the source host.