IBM Cloud Manager with OpenStack. REST API Reference, version 4.1

Transcription

1 IBM Cloud Manager with OpenStack REST API Reference, version 4.1

2

3 IBM Cloud Manager with OpenStack REST API Reference, version 4.1

4 Note Before using this information and the product it supports, read the information in Notices on page 203. Sixth Edition (June 2014) Copyright IBM Corporation 2011, US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

5 Contents Chapter 1. IBM Cloud Manager with OpenStack REST API reference What's new in IBM Cloud Manager with OpenStack Software Development Kit (SDK) Reference Version Overview of IBM Cloud Manager with OpenStack REST web services Web services provided by IBM Cloud Manager with OpenStack Connecting to an IBM Cloud Manager with OpenStack server IBM Cloud Manager with OpenStack REST API response codes Appliance library services GET /appliances GET /appliances/id PUT/appliances/id DELETE/appliances/id GET /appliances/id/copies GET /appliances/id/targets GET /appliances/id/customization PUT /appliances/id/properties DELETE /appliances/id/customization GET /appliances/id/log POST /appliances Authentication services POST /auth GET /auth/reminder POST /auth/registration GET /auth/reminder/isenabled Billing services GET /accounts POST /accounts GET /accounts/id PUT /accounts/id DELETE /accounts/id GET /accounts/users GET /accounts/id/users GET /accounts/id/users/id POST /accounts/id/users DELETE /accounts/id/users/id GET /accounts/id/bills GET /accounts/id/bills/id GET /accounts/id/charges GET /accounts/id/credits POST /accounts/id/credits Billing cloud product services GET /billing/cloudproducts GET /billing/cloudproducts/prodid Billing payment authorizer services GET /billing/paymentauthorizers GET /billing/paymentauthorizers/id Configuration services GET /configuration/properties GET /configuration/ipaddresspools GET /configuration/ldap.xml PUT /configuration/ldap.xml GET /configuration/ldapcert PUT /configuration/ldapcert Cloud management services GET /clouds/certificate POST /clouds DELETE /clouds/id GET /clouds GET /clouds/id GET /clouds?types GET /clouds/id/certificate PUT /clouds/id Delinquency policies services GET /billing/delinquencypolicies GET /billing/delinquencypolicies/id Event services DELETE /events GET /events GET /events/eventcsv GET /events/id Expiration policy services GET /expirationpolicies PUT /expirationpolicy GET /expirationpolicy/id PUT /expirationpolicy/id GET /projects/id/expirationpolicy IaaS gateway services GET /iaasgateways POST /iaasgateways PUT /iaasgateways/id GET /iaasgateways/id DELETE /iaasgateways/id Key pair services GET /keypairs GET /keypairs/id POST /keypairs License key services GET /licensing PUT /licensing Metering data services GET /udrfiles GET /udrfiles/directoryname GET /udrfiles/directoryname/filename.. 59 GET /udrs GET /udrs/id Network configuration services GET /networkconfigurations POST /networkconfigurations GET /networkconfigurations/id PUT /networkconfigurations/id DELETE /networkconfigurations/id GET /networkconfigurations/id/ipaddresses 72 POST /networkconfigurations/id/ipaddresses 73 GET /networkconfigurations/id/ipaddresses/ ip Copyright IBM Corp. 2011, 2014 iii

6 PUT /networkconfigurations/id/ipaddresses/ ip DELETE /networkconfigurations/id/ ipaddresses/ip Product information services GET /productinfo/version GET /productinfo/shortname GET /productinfo/name GET /productinfo/fullname GET /productinfo/vendorname GET /productinfo/vendoricon GET /productinfo/splash GET /productinfo/icontype Project management services GET /projects POST /projects DELETE /projects/id PUT /projects/id GET /projects/id GET /projects/id/workloads GET /projects/id/appliances GET /projects/id/users GET /projects/id/expirationpolicy POST /projects/id/users PUT /projects/id/users/username DELETE /projects/id/users/username Request lifecycle services GET /requests PUT /requests GET /requests/id PUT /requests/id GET /requests/id/parameters PUT /requests/id/parameters GET /requests/id/comments POST /requests/id/comments GET /requests/handlers PUT /requests/handlers GET /requests/requestcsv DELETE /requests/requstcsv Statistics resource services GET /stats/free GET /stats/totals GET /stats/usage User services GET /users GET /users/username POST /users PUT /users/username DELETE /users/username Virtual server services GET /workloads/id/virtualservers GET /workloads/id/virtualservers/id GET /workloads/id/virtualservers/id/ credentials PUT /workloads/id/virtualservers/id/ credentials GET /virtualservers GET /virtualservers/id PUT /virtualservers/id GET /virtualservers/id/log GET /virtualservers/id/storages GET /virtualservers/id/storages/id POST /virtualservers/id/storages DELETE /virtualservers/id/storages/id GET /virtualservers/id/networks GET /virtualservers/id/networks/id GET /virtualservers/id/backups GET /virtualservers/id/backups/id POST /virtualservers/id/backups PUT /virtualservers/id/backups/id DELETE /virtualservers/id/backups/id GET /virtualservers/id/repositories GET /virtualservers/id/repositories/id/ customization Workload services GET /workloads POST /workloads GET /workloads/id GET /workloads/id/customization GET /workloads/id/target GET /workloads/id/log GET /workloads/id/virtualservers GET /workloads/id/virtualservers/id GET /workloads/id/virtualservers/id/ credentials PUT /workloads/id/virtualservers/id/ credentials GET /workloads/id/timestamps PUT /workloads/id DELETE /workloads/id GET /workloads/stats GET /workloads/owners Chapter 2. IBM OpenStack REST API reference Overview of IBM OpenStack REST API reference 165 Access OpenStack APIs OpenStack REST APIs IaaS gateway Keystone Glance Neutron Cinder Nova Related information Accessibility Notices Trademarks Privacy policy considerations Code license and disclaimer information iv IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

7 Chapter 1. IBM Cloud Manager with OpenStack REST API reference IBM Cloud Manager with OpenStack version 4.1 provides a self-service portal for the cloud user that complements VMware vsphere, and Hyper-V through OpenStack. IBM Cloud Manager with OpenStack also supports Linux Kernel-based Virtual Machine (KVM) and PowerVC through OpenStack. IBM Cloud Manager with OpenStack is implemented as a lightweight web-based application that runs as an Open Services Gateway initiative (OSGi) application. IBM Cloud Manager with OpenStack provides an environment that enables cloud users serve themselves while they maintain control over the allocation of resources. The self-service capabilities of IBM Cloud Manager with OpenStack simplify the process to carry out many common public or private cloud operations such as the following operations: v Provisioning (deploying) and de-provisioning servers v Drafting and cloning workloads v Taking workloads captures v Starting and shutting down servers v Resizing existing servers v Creating projects to give team-specific access to workloads v Providing network configurations that set unique network properties to different workloads v Billing, accounting, and metering support v Providing request and approval workflow support v Identifying the current capacity of the resources in a virtualization environment These and many other features are included in this version of the IBM Cloud Manager with OpenStack. For more detailed documentation about the IBM Cloud Manager with OpenStack capabilities, see the IBM Cloud Manager with OpenStack User Guide and the IBM Cloud Manager with OpenStack Administrator Guide. Related information: Code license and disclaimer information on page 205 What's new in IBM Cloud Manager with OpenStack Software Development Kit (SDK) Reference Version 4.1 The IBM Cloud Manager with OpenStack Software Development Kit (SDK) Reference, Version 4.1 introduces new and updated services. Note: IBM Cloud Manager with OpenStack Version 4.1 aligns more closely with OpenStack terminology. For example, in the user interface, the terms workload and appliance are replaced with instance and image. However, to maintain API compatibility, the REST resources still use the former terms. Chapter 2 describes the IBM OpenStack REST APIs that IBM Cloud Manager with OpenStack provides. Iaas Gateway services v IaaS gateway services on page 51 License key services v License key services on page 57 Copyright IBM Corp. 2011,

8 Delete /workloads/id v DELETE /workloads/id on page 161 POST /auth/registration v POST /auth/registration on page 17 Delete /users/username v DELETE /users/username on page 108 GET /accounts/id/bills v GET /accounts/id/bills on page 25 v GET /accounts/id/bills/id on page 26 Overview of IBM Cloud Manager with OpenStack REST web services IBM Cloud Manager with OpenStack provides a set of APIs that can be used to access IBM Cloud Manager with OpenStack data and services from applications that are running outside of the IBM Cloud Manager with OpenStack framework. These APIs are based on the Representational State Transfer (REST) architecture and are accessed by using the HTTP or HTTPS protocol. REST refers to an architecture used to create stateless web services that are typically accessed by using the HTTP or HTTPS protocol. The REST APIs are implemented with complete compatibility from release to release. This means is that newer versions of IBM Cloud Manager with OpenStack do not have an impact on the code that uses the existing REST APIs. Web services provided by IBM Cloud Manager with OpenStack IBM Cloud Manager with OpenStack provides the web services that are listed here. v Appliance library services v Authentication services v Billing services v Billing cloud product services v Billing payment authorizer services v Cloud management services v Configuration services v Delinquency policies services v Event services v Expiration policy services v Key pair services v Metering data services v Network configuration services v Product information services v Project management services v Request lifecycle services v Statistics resource services v User services v Virtual server services v Workload services 2 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

9 Connecting to an IBM Cloud Manager with OpenStack server IBM Cloud Manager with OpenStack is implemented as a lightweight web-based application that runs as an OSGi application. For production environments, IBM recommends that you use secure sockets layer (SSL) HTTPS communication between the IBM Cloud Manager with OpenStack server and the client that is using the IBM Cloud Manager with OpenStack REST APIs. Using SSL provides a greater level of security for the data on the network. For more information about configuring the server to use SSL communications, see the IBM Cloud Manager with OpenStack Administrator Guide. All APIs, except for the authentication APIs, require authentication. The preferred method to provide credential information is to use the /auth API. Use the /auth API to authenticate your user name and password and then use an authentication token for other APIs. For more information, see POST /auth on page 16 API. To establish a connection to the IBM Cloud Manager with OpenStack server, the format of the URL must be: <communication_scheme>://<sce_server_host>:<port>/cloud/api/<service> Where <communication_scheme> is the scheme that is used for the communication protocol, such as HTTP or HTTPS. <SCE_server_host> is the host (where the IBM Cloud Manager with OpenStack server is running) which is contacted as the data provider. <port> is the remote port that is used for the scheme. The IBM Cloud Manager with OpenStack server currently uses for HTTP requests and for HTTPS requests. IBM Cloud Manager with OpenStack REST API response codes Find detailed information about the REST API response codes. 200 OK The request was fulfilled successfully. 201 Created Following a POST command, this response indicates that the specified resource was successfully created. This response includes the URI of the newly created resource in the HTTP Location header. 202 Accepted The request is accepted for processing, but the processing is not complete. The request might eventually be acted upon, or it might be disallowed when processing takes place. This response code is also used to indicate that a request is accepted, but that the request must be approved by an administrator. The URI of the request that must be approved is included in the HTTP Location header of the response. Thus, users can track the status of their request by using that URI. 400 Bad request The request has incorrect syntax. For example, the JSON object is not recognized or is not valid JSON. Chapter 1. IBM Cloud Manager with OpenStack REST API reference 3

10 401 Unauthorized The parameter to this message gives a specification of authorization schemes that are acceptable. Submit the request with a suitable Authorization header. 404 Not found The server cannot find the resource that is requested in the URI. 500 Internal Error The server encountered an unexpected condition that prevented it from fulfilling the request. For more information, see the Response.Status Javadoc. Related information: Response.Status Javadoc Appliance library services IBM Cloud Manager with OpenStack provides the following services for appliance libraries. Related information: Code license and disclaimer information on page 205 GET /appliances This service retrieves the appliances available in the appliance libraries of the cloud. GET No HTTP body required. Name Description Default Required user cloudgroupid architecture start count owner Gets the list of appliances that this user name can see. Filters the list of appliances by the specified cloudgroupid. Filters the list of appliances by the specified platform architecture. The index of the first records to return. The number of records to return. Filters the list of appliances by the specified owner. N/A No * No * No 0 No 0 No * No HTTP Response Body: 1. For all appliances, including the master and copied appliance, the HTTP Response Body shows the creator as follows: 4 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

11 "total": "2", "appliances": [ "cloudname": "mpcapture", "changeddate": , "cloudgroupid": "251", "name": "mpcapture", "uri": " "cloudid": "cloud://251/49826", "state": "label": "OK", "id": "OK" "architecture": "Power", "projecturi": " "cloudgroupname": " ", "specificationversion": "1.1", "hypervisor": "PowerVM", "version": "1.1", "id": "347", "revision": "1.1", "description": "true" "cloudname": "mpcapture", "changeddate": , "cloudgroupid": "251", "name": "mpcapture", "uri": " "cloudid": "cloud://251/49567", "state": "label": "Unknown", "id": "UNKNOWN" "architecture": "Power", "projecturi": " "cloudgroupname": " ", "specificationversion": "1.1", "hypervisor": "PowerVM", "version": "1.1", "id": "303", "revision": "1.1", "description": "true" ] 2. If the appliance is a copy of another appliance, the HTTP Response Body shows the creator as follows: cloudid: "cloud://301/46047", cloudgroupid: "301", projecturi: " cloudgroupname: " ", state: id: "OK", label: "OK" architecture: "Power", logsuri: " uri: " specificationversion: "1.1", creator: id: "admin", name: "SmartCloud Entry Administrator" Chapter 1. IBM Cloud Manager with OpenStack REST API reference 5

12 cloudname: "RHEL63-Master", id: "357", changeddate: , revision: "1.1", customizationuri: " description: "root / passw0rd - RSCT fixes, AE ", hypervisor: "PowerVM", name: "RHEL63-Master :06:44", ismaster: false, targetsuri: " GET /appliances/id This service retrieves the properties of a specific appliance by id. GET No HTTP body required. Localized values: "state" HTTP Response Body: "cloudname": "mpcapture", "changeddate": , "priority": 2, "cloudgroupid": "251", "targetsuri": " "name": "mpcapture", "uri": " "cloudid": "cloud://251/49826", "state": "label": "OK", "id": "OK" "architecture": "Power", "projecturi": " "cloudgroupname": " ", "specificationversion": "1.1", "hypervisor": "PowerVM", "customizationuri": " "id": "347", "revision": "1.1", "description": "true", "logsuri": " PUT/appliances/id This service updates the specific appliance by id. PUT 6 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

13 "name": "MyApp on AIX Image (dual-nic) New Name", "description": "Some Better Descripton)" DELETE/appliances/id This service deletes an appliance that was captured by IBM Cloud Manager with OpenStack but failed during capture or was deleted from the cloud. This service deletes an appliance. If the appliance is in Failed state, Unknown state, or is a copy of another appliance, the appliance is only deleted from IBM Cloud Manager with OpenStack. If the appliance is in an OpenStack cloud, then it is deleted from the cloud as well. Deleting a master appliance that is in an OpenStack cloud will delete all copies of the appliance as well. DELETE No HTTP body required. GET /appliances/id/copies This service retrieves copies of the target appliance that is available in the cloud. The master appliance is the first appliance link to the VMWare or OpenStack cloud appliance. When the ID is the master image, this function returns a list of all its copies. When the ID is a copied image, this function returns its master and all its copies N/A Get total: "1", appliances: [ cloudid: "cloud://301/46047", cloudgroupid: "301", projecturi: " cloudgroupname: " ", state: id: "UNKNOWN", label: "Unknown" architecture: "Power", uri: " Chapter 1. IBM Cloud Manager with OpenStack REST API reference 7

14 specificationversion: "1.1", cloudname: "RHEL63-Master", version: "1.1", id: "357", changeddate: , revision: "1.1", description: "root / passw0rd - RSCT fixes, AE ", hypervisor: "PowerVM", name: "RHEL63-Master :06:44", ismaster: false, projectname: "Public" ] GET /appliances/id/targets This service retrieves the targets that are available in the cloud and that can handle a workload of this appliance. This list of targets can be used to select a target by ID and update the default target in the appliance default customization. This is an admin web service. Name Description Default Required cpu The desired CPU size 0 No memory The desired memory size 0 No To retrieve the workload targets for appliance with ID 1 GET "total": "5", "identifier": "id", "targets": [ "id": "cloud://551/123993", "name": "DRSCluster (CLUSTER)", "type": "label": "Cluster", "id": "CLUSTER" "timestamp": "Wed May 22 23:42:05 CST 2013", "parent": "cloud://551/1239", "hypervisor": "VMware", "cloudgroupid": "31801", "architecture": "x86", "hypervisorversion": "5.0", "totalmem": , "totalcpu": 32, "usedcpu": 20, "usedmem": , "totaldisk": 7809, "useddisk": 7051, "children": [ "cloud://31801/44" 8 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

15 ] "virtualservers": [ "state": "label": "OK", "id": "ACTIVE" "isdeployable": true GET /appliances/id/customization This service retrieves a default customization for an appliance. When a user deploys an appliance, IBM Cloud Manager with OpenStack uses the default customization as the workload configuration for the appliance. Customizations are configured by administrators. This is an admin web service. N/A To retrieve the default customization for appliance with ID 347: GET "target": "cloud://352/352", "properties": [ "category": "Network adapters", "valueorigin": [ "36ea3a9b-d4e6-4b4f-b13b-ddafa55a91e9" "values": [ "36ea3a9b-d4e6-4b4f-b13b-ddafa55a91e9" "basic": false, "description": "Networks settings of the image or virtual machine", "classification": "id": "NETWORK", "label": "Network" "name": "networkdevice.network adapters.networks", "required": true, "type": "MULTIPLE_SELECTION", "rules": [ "id": "max", "value": "1" "id": "min", "value": "1" "options": [ "id": "36ea3a9b-d4e6-4b4f-b13b-ddafa55a91e9", "value": "flat ( )" ] Chapter 1. IBM Cloud Manager with OpenStack REST API reference 9

16 "category": "OpenStack Flavor", "values": [ "1" "basic": true, "description": "Flavors describe the different options for sizing the deployed instances", "classification": "id": "HARDWARE", "label": "Hardware" "name": "openstack.flavors", "required": true, "type": "SINGLE_SELECTION", "options": [ "id": "1", "value": "\"ram\":512,\"disk\":1,\"name\":\"m1.tiny\",\"os-flv-ext-data:ephemeral\":0,\"vcpus\":1" "id": "2", "value": "\"ram\":2048,\"disk\":20,\"name\":\"m1.small\",\"os-flv-ext-data:ephemeral\":0,\"vcpus\":1" "id": "3", "value": "\"ram\":4096,\"disk\":40,\"name\":\"m1.medium\",\"os-flv-ext-data:ephemeral\":0,\"vcpus\":2" "id": "4", "value": "\"ram\":8192,\"disk\":80,\"name\":\"m1.large\",\"os-flv-ext-data:ephemeral\":0,\"vcpus\":4" "id": "5", "value": "\"ram\":16384,\"disk\":160,\"name\":\"m1.xlarge\",\"os-flv-ext-data:ephemeral\":0,\"vcpus\":8" ] "category": "Virtual Machine Configuration", "values": [ true "basic": false, "description": "Enable config drive (used to pass additional configuration data)", "classification": "id": "SOFTWARE", "label": "Software" "name": "openstack.config.drive", "required": false, "type": "BOOLEAN" "category": "Access and Security", "values": [ "" "basic": true, "description": "Keypair to use for SSH access to the virtual machine", "classification": "id": "SOFTWARE", "label": "Software" "name": "openstack.keypairs", "required": false, "type": "SINGLE_SELECTION", "options": [ "id": "", "value": "" ] "category": "Virtual Machine Customization", "values": [ "" "basic": false, "description": "Enter the contents of the customization script (user data)", 10 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

17 "classification": "id": "SOFTWARE", "label": "Software" "name": "openstack.server.customizations", "required": false, "type": "STRING", "rules": [ "id": "maxlen", "value": "65535" ] "category": "Virtual Machine Personality Files", "values": [ "" "basic": false, "description": "Enter the contents of personality file 1", "classification": "id": "SOFTWARE", "label": "Software" "name": "openstack.server.personality.source.1", "required": false, "type": "STRING", "rules": [ "id": "maxlen", "value": "65536" ] "category": "Virtual Machine Personality Files", "values": [ "" "basic": false, "description": "Enter the target path and file name for personality file 1", "classification": "id": "SOFTWARE", "label": "Software" "name": "openstack.server.personality.target.1", "required": false, "type": "STRING" "category": "Virtual Machine Personality Files", "values": [ "" "basic": false, "description": "Enter the contents of personality file 2", "classification": "id": "SOFTWARE", "label": "Software" "name": "openstack.server.personality.source.2", "required": false, "type": "STRING", "rules": [ "id": "maxlen", "value": "65536" ] "category": "Virtual Machine Personality Files", "values": [ "" "basic": false, "description": "Enter the target path and file name for personality file 2", "classification": Chapter 1. IBM Cloud Manager with OpenStack REST API reference 11

18 "id": "SOFTWARE", "label": "Software" "name": "openstack.server.personality.target.2", "required": false, "type": "STRING" "category": "Virtual Machine Personality Files", "values": [ "" "basic": false, "description": "Enter the contents of personality file 3", "classification": "id": "SOFTWARE", "label": "Software" "name": "openstack.server.personality.source.3", "required": false, "type": "STRING", "rules": [ "id": "maxlen", "value": "65536" ] "category": "Virtual Machine Personality Files", "values": [ "" "basic": false, "description": "Enter the target path and file name for personality file 3", "classification": "id": "SOFTWARE", "label": "Software" "name": "openstack.server.personality.target.3", "required": false, "type": "STRING" "category": "Virtual Machine Personality Files", "values": [ "" "basic": false, "description": "Enter the contents of personality file 4", "classification": "id": "SOFTWARE", "label": "Software" "name": "openstack.server.personality.source.4", "required": false, "type": "STRING", "rules": [ "id": "maxlen", "value": "65536" ] "category": "Virtual Machine Personality Files", "values": [ "" "basic": false, "description": "Enter the target path and file name for personality file 4", "classification": "id": "SOFTWARE", "label": "Software" "name": "openstack.server.personality.target.4", "required": false, "type": "STRING" 12 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

19 "category": "Virtual Machine Personality Files", "values": [ "" "basic": false, "description": "Enter the contents of personality file 5", "classification": "id": "SOFTWARE", "label": "Software" "name": "openstack.server.personality.source.5", "required": false, "type": "STRING", "rules": [ "id": "maxlen", "value": "65536" ] "category": "Virtual Machine Personality Files", "values": [ "" "basic": false, "description": "Enter the target path and file name for personality file 5", "classification": "id": "SOFTWARE", "label": "Software" "name": "openstack.server.personality.target.5", "required": false, "type": "STRING" "instances": 1, "appliance": "name": "mini-hyper-v", "uri": " IBM Cloud Manager with OpenStack uses the rootpassword property to save the default root password for the appliance. This property can be configured by an administrator on the appliance so each user does not need to configure the property for each workload. PUT /appliances/id/properties This service enables you to update the default customization for an appliance. ou can use this service to specify that an appliance is deployed to a specific target by default. The customization for the appliance can also be given default values. These default values do not override explicit values that are given by a user for any workload property. This is an admin web service. N/A s 1. Update the default workload target for appliance 1, make it target with id 123. PUT "target":"123" Chapter 1. IBM Cloud Manager with OpenStack REST API reference 13

20 2. Update the default customization such that when deploying appliance 1, CPU mode is Dedicated and the number of CPUs is 2 by default. PUT "properties":[ "name":"cpumode", "value": "DEDICATED" "name":"cpudedicated", "value":2 ] DELETE /appliances/id/customization This service resets the default customization for an appliance. An administrator can use the DELETE /appliances/id/customization service to reset the customized appliance to its initial settings. A customization, however, will never be null. This service resets the customization to the original values based on what is available in the cloud. This is an admin web service. N/A Reset the default customization for appliance 1 DELETE GET /appliances/id/log This service retrieves any capture progress logs for an appliance that is captured in the cloud. The exact contents of the logs are dependent on how the cloud stores the logs for capture. Logs might be deleted after an operation completes or fails; or, the logs might be maintained for an extended time. The actual string data that is returned in the JavaScript Object Notation (JSON) response is HTML formatted. Rather than having Java new line strings, the data shows <br> tags. N/A 14 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

21 Get capture progress logs for appliance GET "log":"workload, AIX 5L for POWER Version 5.3, was created. Start asynch work run for deploy of virtual appliance :8498 Workload removed due to exception: Workload, AIX 5L for POWER Version 5.3, was deleted. Error performing asynch work run for deploy of virtual appliance:8498 New workload removed: 11738" POST /appliances This service creates a new appliance on the cloud. The appliance is created by capturing the current state of a workload or by copying a master appliance that links to the VMware or OpenStack cloud appliance. Note: This API does not support capture of an OpenStack PowerVM instance, which is not in "STOPPED" state. N/A s 1. Create an appliance by taking a capture of workload with workload ID 133. POST "workload": Create an appliance by capturing a workload with workload ID 133. The new appliance is a Linux image and is at the image repository with ID 102. POST "workload":133, "repository":"102", "properties":[ "name":"ostypecapture", "value":"36" ] 3. Create an appliance by copying the appliance (5415). Chapter 1. IBM Cloud Manager with OpenStack REST API reference 15

22 "appliance":5415, "name":"tonytest", "description":"nim mksysb 12/09/09", HTTP Status: 201 HTTP Location Header: The URI of the new appliance HTTP Body: The customization, to avoid a trip back to the server for it. Authentication services IBM Cloud Manager with OpenStack provides services for requesting new users and services that are related to passwords. Related information: Code license and disclaimer information on page 205 POST /auth The POST /auth API validates the credentials for a user. The service takes an x-www-form-urlencoded form with two parameters: user name and password. Upon successful credential validation, the service returns an encrypted authentication token and the expiration for the token (in UTC format). This encrypted authentication token can then be used on subsequent secure API calls rather than using x-www-form-urlencoded credentials for each API call. Using authentication tokens for secure REST APIs is the recommended method of authentication. The x-www-form-urlencoded form is deprecated for anything other than the auth service. To use an encrypted authentication token on REST API calls, the REST agent must populate the HTTP request header with the cookie field name configured to transport authentication tokens (see the IBM Cloud Manager with OpenStack Administrator Guide). The IBM Cloud Manager with OpenStack REST APIs then obtain the encrypted authentication token from the cookie header and use it to validate the REST agent's identity. If IBM Cloud Manager with OpenStack is configured to renew authentication tokens that are based on API usage, successfully authenticated API responses will also include a Set-Cookie header with a renewed authentication token and its associated expiration. The agent can then use this renewed token on subsequent REST calls. However if an authentication token expires, the agent must again use the auth service REST API to re-authenticate their credentials and obtain a new token. This is an unauthenticated web service. This web service does not require authentication, so it is unsecured. The base uri for this web service is '/unsecured/cloud/api', so the complete URI looks like the following: if the user successfully authenticated 401 Unauthorized and 403 Forbidden. 16 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

23 HTTP Response Body: "access": "expires": , "id":"s9ewn4xghr7knp583hyewvhqohvg1pwycsvarknlnxnemdu5db4qn9p+i1dfae2x" GET /auth/reminder The GET /auth/reminder API requests that a password reminder is sent to the associated user with an notification (as of version 1.1). The actual reminder is sent only if the user name is specified and the installation has enabled notifications. This web service does not require authentication, so it is unsecured. The base URI for this web service is /unsecured/cloud/api, so the complete URI looks like the following: Name Description Default Required user The user name that is requesting the password reminder. NA es The the password reminder sent to. NA es Send a password reminder to the user 'john' for this account. GET HTTP Request Body: N/A POST /auth/registration The POST /auth/registration API creates a request for the administrator to approve. After approval, a new user account is created. The JSON in the request body should define the suggested values for the new user account. If the notification is enabled, an is sent to the administrator with the request. This web service does not require authentication, so it is unsecured. The base URI for this web service is /unsecured/cloud/api, so the complete URI looks like the following: Chapter 1. IBM Cloud Manager with OpenStack REST API reference 17

24 Specify the Content Type as application/json. N/A Send the administrator a notification that requests a new user account for john. POST HTTP Request Body: "username":"john", "name":"mr John", "password":"pwd4me", " ":"[email protected]" HTTP Status: 202 No HTTP Response Body GET /auth/reminder/isenabled The GET /auth/reminderisenabled API sends a password reset reminder. No resource is returned. HTTP Status: v 200 if the password reset reminder is enabled. v 500 if the password reset reminder is not enabled Billing services The IBM Cloud Manager with OpenStack product provides the billing services that are listed here. Related information: Code license and disclaimer information on page 205 GET /accounts This service retrieves the accounts that are defined in IBM Cloud Manager with OpenStack. 18 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

25 Name Description Default Required user Retrieve only the accounts that this user has access to (either by ownership or by membership). Administrators can see all accounts. false No s 1. Get all accounts known to the system GET No HTTP body required. 2. Get all accounts to which user user1 belongs to, owns, or is a member of. GET No HTTP body required. HTTP Response Body: "accounts": [ "state": "label": "Delinquent", "id": "DELINQUENT" "isdelinquent": true, "currency": "USD", "owner": "user1", "accountnumber": "1401", "name": "acc1", "id": "1401", "balance": 0, "description": "acc1", "uri": " ] POST /accounts This service creates a new account in IBM Cloud Manager with OpenStack. Use the POST /accounts/id/users API to add members to the account. This request JSON allows for an (optional) 'startingbalance' attribute, which enables the user to specify an initial balance for the account during creation. If specified, the newly created account is credited for the 'startingbalance' amount. POST HTTP Request Body: Chapter 1. IBM Cloud Manager with OpenStack REST API reference 19

26 "currency":"usd", "owner":"admin", "lowfundsthreshold":"5.00", "name":"test account.", "description":"test account for development purposes.", "defaultpaymentauthorizer": "admin", "delinquencypolicy": "com.ibm.cfs.services.billing.policies.shutdown", "startingbalance": , "currency": "USD" HTTP Status: 201 HTTP Location Header: The URI of the new account HTTP Response Body: "billsuri":" "isdelinquent":false, "usersuri":" "delinquencypolicy":"com.ibm.cfs.services.billing.policies.shutdown", "name":"test account.", "uri":" "defaultpaymentauthorizer":"admin", "lowfundsthreshold":5.0, "currency":"usd", "state": "label":"ok", "id":"ok" "creditsuri":" "owner":"admin", "accountnumber":"101651", "id":"101651", "description":"test account for development purposes.", "balance": GET /accounts/id This service retrieves the properties of a specific account by ID. GET No HTTP body required. Note: The "total" is presented formatted in currency for account. HTTP Response Body: "billsuri":" "isdelinquent":false, "usersuri":" 20 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

27 "name":"admin Account", "uri":" "lowfundsthreshold":"$1,000.00", "currency":"usd", "state": "label":"ok", "id":"ok" "creditsuri":" "owner":"admin", "accountnumber":"451", "id":"451", "description":"", "balance":"($10,000,000.00)" PUT /accounts/id This service updates the properties of a specific account by ID. PUT "name":"admin Account Changed", "lowfundsthreshold": SUCCESS: Account 451 updated. DELETE /accounts/id This service removes an account. N/A Remove the account 123. DELETE GET /accounts/users This service retrieves all users that do not belong to any account. For IBM Cloud Manager with OpenStack 2.0, users can belong to only one billing account. ou can use this service to list all users who are not members of any account. This service can be useful if you want to identify users that might potentially be added to a new account. Chapter 1. IBM Cloud Manager with OpenStack REST API reference 21

28 N/A Retrieve a listing of all users that do not belong to an account. GET No HTTP body required. HTTP Response Body: "users":[ "username":"admin", "name":"administrator", "isadmin":true, "isapprover":true, " notifications":false, " ":"[email protected]", "uri":" "username":"[email protected]", "name":"john Doe", "isadmin":false, "isapprover":true, " notifications":true, " ":"[email protected]", "uri":" ] GET /accounts/id/users This service retrieves the all users (members) associated with this account. The list is the same format as that returned under the 'users' resource but lists only those users who are members of this account. Users (members) can be added and removed with POST and DELETE as well. N/A To retrieve all users for account with ID 1: GET "users": [ "islocked": false, "isadmin": true, 22 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

29 ] "role": "label": "Admin", "id": "ADMIN" "username": "admin", "name": "Cloud Administrator", " notifications": false, " ": "", "isapprover": true "islocked": false, "isadmin": false, "role": "label": "User", "id": "USER" "username": "testuser", "name": "testuser", " notifications": false, " ": "isapprover": false GET /accounts/id/users/id This service retrieves the specific user (member) associated with this account. N/A To retrieve all users for account with ID 1: GET "cloudid":"cloud://351/0e158ff8847a47eaaef6e9be435b259d", " notifications": false, "username": "tester", "isapprover": false, "name": "tester", "role": "id": "USER", "label": "User" "isadmin": false, "uri": " "islocked": false POST /accounts/id/users This service adds users to the member list for the account. This API does not create new users, so the users must exist in the IBM Cloud Manager with OpenStack registry. N/A Chapter 1. IBM Cloud Manager with OpenStack REST API reference 23

30 1 Add the user with user name "admin" to the member list of account ID id: POST HTTP Request Body: "users": [ "username": "test" ] Response: "users": [ "islocked": false, "isadmin": false, "role": "label": "User", "id": "USER" "username": "test", "name": "test", " notifications": false, "isapprover": false ] 1 HTTP Status: 201 HTTP Response Body: "users":[ "isadmin":true, "username":"admin", "name":"admin", " notifications":false, "isapprover":true ] 2 Add the users with usernames john and luis to the member list of account ID 1. POST HTTP Request Body: "users":[ "username":"john" 24 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

31 ] "username":"luis" 2 HTTP Status: 201 HTTP Response Body: "users":[ "isadmin":false, "username":"john", "name":"john Doe", " notifications":false, "isapprover":false "isadmin":false, "username":"luis", "name":"luis G", " notifications":false, "isapprover":false ] DELETE /accounts/id/users/id This service removes a user from the member list for an account. The user is not deleted from the IBM Cloud Manager with OpenStack user registry, only the account association. N/A Remove the user jdoe from the account ID 1. DELETE GET /accounts/id/bills This service retrieves the bills for this account. This list of bills can be used to find the individual bill and their associated charges. N/A Chapter 1. IBM Cloud Manager with OpenStack REST API reference 25

32 To retrieve the bills for account with ID 1: GET Note: The "total" is presented formatted in the currency for the account. "bills": [ "currency": "USD", "total": , "resourceid":"1120", "resourcetype": "workload", "resourcename": "MyApp on SUSE Image :52:15", "id": "1151", "creator": "admin", "uri": " "invoice": "1151" "currency": "USD", "total": 0, "resourceid":"1120", "resourcetype": "workload", "resourcename": "MyApp on SUSE Image :54:37", "id": "1152", "creator": "admin", "uri": " "invoice": "1152" ] GET /accounts/id/bills/id This service retrieves a specific bill from the specified account. From this information, you can find links to the deployment associated with this bill and list of all charges that are associated with the bill. N/A Get bill with ID 1 from account with ID 1: GET In this sample, the total is presented formatted in currency for the account. "currency": "USD", "total": , "resourceid":"1120", "resourcetype": "workload", "resourcename": "MyApp on SUSE Image :52:15", "id": "1151", 26 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

33 "creator": "admin", "uri": " "chargesuri": " "invoice": "1151" GET /accounts/id/charges This service retrieves the charges from all bills for this account. N/A To retrieve the all charges for account with ID 1: GET In this sample, the total is presented formatted in currency for the account. The values for currency, unitprice, product, andid are defined in the SmartCloud Entry home path/products/*.xml file. "charges": [ "currency": "USD", "total": , "unitprice": , "id": "com.ibm.cfs.cloud.openstack.products.cpu", "date": , "product": "CPU", "units": "4" "currency": "USD", "total": , "unitprice": , "id": "com.ibm.cfs.cloud.openstack.products.mem", "date": , "product": "RAM", "units": "2048" "currency": "USD", "total": 0, "unitprice": , "id": "com.ibm.cfs.cloud.openstack.products.storage", "date": , "product": "Active Disk", "units": "0" ] GET /accounts/id/credits This service retrieves the credits over all bills for this account. N/A Chapter 1. IBM Cloud Manager with OpenStack REST API reference 27

34 To retrieve the credits for account with ID 1: GET Note: The "amount" is presented formatted in currency for account. "credits":[ "currency":"usd", "amount":"10.99", "date": , "description":"credit description 1" "currency":"usd", "amount":"15.99", "date": , "description":"credit description 2" ] POST /accounts/id/credits This service adds credits to the specified account. ou can use this service to add a credit or make a payment. Payments can be added by any user. Payments are posted to the account if the payment passes the payment authorization verification. Credits can be made only by administrators. Credits are automatically added to an account when the credit is made. Name Description Default Required payment If true, then a payment authorizer is used. false No s 1. Add $ in credits to account ID 1. POST HTTP Request Body: "amount":100.00, "description":"free 100 based on coupon." 2. Make a $50 payment to account 1, using the accounts default payment system. POST HTTP Request Body: "amount":50 3. Make a $50 payment to account 1, using a provided payment system. 28 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

35 POST HTTP Request Body: "amount":50.0, "paymentauthorizer":"visa.payments" HTTP Response Body: SUCCESS: The account is credited the requested amount. Billing cloud product services IBM Cloud Manager with OpenStack provides the billing cloud product services that are listed here. Related information: Code license and disclaimer information on page 205 GET /billing/cloudproducts This service gets the summary list of all products. GET No HTTP body required. Localized values: "state" HTTP Response Body: "cloudproducts": [ "currency": "USD", "name": "Active Disk", "id": "com.ibm.cfs.cloud.openstack.products.storage", "description": "The storage space allocated to a virtual machine.", "uri": " "currency": "USD", "name": "CPU", "id": "com.ibm.cfs.cloud.vmware.products.cpu", "description": "The cpu allocated to a virtual machine.", "uri": " "currency": "USD", "name": "RAM", "id": "com.ibm.cfs.cloud.openstack.products.mem", "description": "The ram allocated to a virtual machine.", "uri": " "currency": "USD", Chapter 1. IBM Cloud Manager with OpenStack REST API reference 29

36 ] "name": "Active Disk", "id": "com.ibm.cfs.cloud.vmware.products.storage", "description": "The storage space allocated to a virtual machine.", "uri": " "currency": "USD", "name": "CPU", "id": "com.ibm.cfs.cloud.openstack.products.cpu", "description": "The cpu allocated to a virtual machine.", "uri": " "currency": "USD", "name": "RAM", "id": "com.ibm.cfs.cloud.vmware.products.memory", "description": "The ram allocated to a virtual machine.", "uri": " GET /billing/cloudproducts/prodid This service gets the information for a specific product. GET No HTTP body required. Localized values: "state" HTTP Response Body: "currency": "USD", "price": "$0.00", "actualprice": " ", "name": "RAM", "id": "com.ibm.cfs.cloud.openstack.products.mem", "description": "The ram allocated to a virtual machine.", "uri": " "priceinterval": 60 Billing payment authorizer services IBM Cloud Manager with OpenStack provides the following services that are related to payment authorizers. Related information: Code license and disclaimer information on page 205 GET /billing/paymentauthorizers This service retrieves all the payment authorizers that are defined within IBM Cloud Manager with OpenStack. 30 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

37 GET No HTTP body required. HTTP Response Body: "paymentauthorizers":[ "name":"administrator", "id":"admin", "uri":" "name":"john Doe", ] GET /billing/paymentauthorizers/id This service retrieves the properties of a specific payment authorizer by id. GET No HTTP body required. HTTP Response Body: "name":"administrator", "id":"admin", "uri":" Configuration services IBM Cloud Manager with OpenStack provides several services that are related to cloud configuration. Related information: Code license and disclaimer information on page 205 GET /configuration/properties This service retrieves the configuration properties that are specified for the framework, from all the properties files in the home directory for the framework. Chapter 1. IBM Cloud Manager with OpenStack REST API reference 31

38 N/A Get current configuration properties: GET HTTP Response Body: "product.aix1.com.ibm.ovf.vim.2.networkport.6.dns2.ip":" ", "product.aix1.com.ibm.ovf.vim.2.networkport.7.dns2.ip":" ", "admin.name":"administrator", "com.ibm.csk. .relay.host":"relay.us.ibm.com", "com.ibm.cfs.cloud.hostname":"csk-mgr.rchland.ibm.com", "product.aix1.com.ibm.ovf.vim.2.networkport.6.ip":"skc_test_vlan2", "product.aix1.com.ibm.ovf.vim.2.nim.7.nim.resource.1":"cb_lpar_fixup", "admin.username":"admin", "product.aix1.com.ibm.ovf.vim.2.networkport.7.domainname":"rchland.ibm.com", "product.aix1.com.ibm.ovf.vim.2.system.domainname":"icbvm.cloud.com", "admin.password":"admin", "product.aix1.com.ibm.ovf.vim.2.networkport.6.dns1.ip":" ", "product.aix1.com.ibm.ovf.vim.2.networkport.7.dns1.ip":" ", "com.ibm.cfs.billing.delinquency.policy":"com.ibm.cfs.services.billing.policies.shutdown", "com.ibm.cfs.cloud.mock":"true", "com.ibm.cfs.billing.enabled":"false", "authentication.secure":"true", "com.ibm.csk.deployments.threads":"4", "authentication.type":"local", "product.aix1.com.ibm.ovf.vim.2.networkport.7.ip":"skc_test_vlan3", "com.ibm.cfs.billing.account.balance.threshold.interval":"24", "virtualnetworks-1":"[network 1]=hostVnet:ETHERNET0/2", "com.ibm.cfs.cloud.username":"root", "com.ibm.csk.deployments.target.strategy":"anypoolorhost", "product.aix1.com.ibm.ovf.vim.2.networkport.6.gateway":" ", "com.ibm.cfs.request.lifecycle.enabled":"true", "com.ibm.cfs.cloud.password":"passw0rd", "com.ibm.cfs.billing.delinquency.finder.interval":"120", "product.aix1.com.ibm.ovf.vim.2.networkport.7.gateway":" ", "product.aix1.com.ibm.ovf.vim.2.networkport.6.domainname":"icbvm.cloud.com", "product.aix1.com.ibm.ovf.vim.2.networkport.6.netmask":" ", "product.aix1.com.ibm.ovf.vim.2.networkport.7.netmask":" " "product.cloud.name.replacements": "Unknown", GET /configuration/ipaddresspools This service retrieves the IP address pools for each network configuration. N/A 32 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

39 Get current configuration properties for IP address pools: GET HTTP Response Body: "ipaddresspools":[ "size":1, "id":"1", "name":"default Network Configuration", "uri":" "size":508, "id":"2", "name":"vlan1", "uri":" "size":508, "id":"3", "name":"vlan2", "uri":" ] GET /configuration/ldap.xml This service retrieves the ldap.xml file, which defines the authentication properties and authentication process that is used to connect to an LDAP server. This is an admin web service. N/A Get the ldap.xml file GET Content-Type: application/xml <?xml version="1.0"?> <config> <host>ldap://ldap.company.com</host> <adminusers>[email protected],[email protected]</adminusers> <enablesecureconn>true</enablesecureconn> <usernamecasesensitive>true</usernamecasesensitive> <step> Chapter 1. IBM Cloud Manager with OpenStack REST API reference 33

40 <authdn password=encryptedpassword>dnname</authdn> <searchfilter>( (mail=filter))</searchfilter> <searchcontext>ou=directory,o=company.com</searchcontext> <outputs> <output attribute="fullname"> <get>cn</get> </output> </outputs> </step> <step> <authdn>person_dn</authdn> </step> </config> PUT /configuration/ldap.xml This service updates the ldap.xml file, which defines the authentication properties and authentication process that is used to connect to an LDAP server. This is an admin web service. N/A Put the ldap.xml file PUT Content-Type: application/xml <?xml version="1.0"?> <config> <host>ldap://ldap.company.com</host> <enablesecureconn>true</enablesecureconn> <usernamecasesensitive>true</usernamecasesensitive> <step> <authdn password= password >dnname</authdn> <searchfilter>( (mail=filter))</searchfilter> <searchcontext>ou=directory,o=company.com</searchcontext> <outputs> <output attribute="fullname"> <get>cn</get> </output> </outputs> </step> <step> <authdn>person_dn</authdn> </step> </config> GET /configuration/ldapcert This service retrieves the LDAP certificates from the keystore file. This is an admin web service. 34 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

41 N/A Get LDAP certificates from the keystore file. GET Alias: 91fc5d38-666e-4ee8-8acb-ca4e6754bab4 Certificate: [ [ Version: V3 Subject: Signature Algorithm: SHA1withRSA, OID = Key: IBMJCE RSA Public Key: modulus: public exponent: ] PUT /configuration/ldapcert This service updates the LDAP keystore file with the certificate provided. This is an admin web service. N/A Put LDAP certificate in the keystore file. PUT Chapter 1. IBM Cloud Manager with OpenStack REST API reference 35

42 File: C:\Users\IBM_ADMIN\Documents\abcd.cer Content-Type: application/binary Cloud management services Use the services that are listed to work with clouds. Related information: Code license and disclaimer information on page 205 GET /clouds/certificate Use this service to get the SSL certificate based on the cloud group configuration. ou can apply the GET/clouds/certificate service to view a certificate before you accept the certificate for a cloud group. hostname The host name of the cloud group. port The cloud group port. GET HTTP Response Body: -"md5fingerprint": "BB:1A:9A:22:D7:99:C1:D0:C4:2A:17:32:59:BB:F7:DF", -"validfrom": , -"issuedto": " -"trusted": false, -"validto": , -"issuer": " STG, IBM, Austin, TX, US", -"subject": " STG, IBM, Austin, TX, US", -"serialnumber": "4F:56:69:B8", -"sha1fingerprint": "C1:D0:1A:98:92:44:5B:E8:A0:52:5B:A9:E2:B9:CC:18:3A:EB:36:46" POST /clouds Use this service to create cloud connections that are based on the provided cloud configuration information. By default, this service trusts the SSL certificate from the cloud provider. If you specify cloud names that are not unique, the creation of the cloud connections fails. 36 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

43 test The test parameter is set to false by default. To allow clients to test the cloud configuration, change the value to true. When the value is set to true and clients are testing the cloud connection, the SSL certificate is always trusted. trust Specifies whether to trust the SSL certificate. By default, the POST /clouds service always trusts the certificate. 1: VMware cloud Create a VMware cloud from the configuration. POST "name":"vmware-120", "description":"vmware-120", "hostname":" ", "username":"root", "password":"vmware", "cloudtype":"vmware" 1 HTTP Status: 201 Created HTTP Response Body: Location Header : "timeout":600, "iscomplete":true, "hostname":" ", "isjmsssl":false, "username":"root", "name":"vmware-120", "id":"1253", "uri":" "description":"vmware-120", "cloudtype":"vmware 2: Openstack cloud Create an Openstack cloud from the configuration. POST "name":"test Cloud", "description":"openstack Test Cloud", "hostname":" ", "username":"sceagent", "password":"openstack1", "cloudtype":"openstack", "port":"9973", "qpidusername":"qpidclient", "qpidpassword":"openstack1", "sslenabled":"true", "tenantname":"public", "timeout":"600" Chapter 1. IBM Cloud Manager with OpenStack REST API reference 37

44 2 HTTP Status: 201 Created HTTP Response Body: Location Header : "name":"test Cloud", "description":"openstack Test Cloud", "timeout":600, "port":9973, "iscomplete":true, "isjmsssl":false, "uri":" "cloudtype":"openstack", "qpidusername":"qpidclient", "hostname":" ", "tenantname":"public", "sslenabled":true, "username":"sceagent", "id":"1753" DELETE /clouds/id This service is used to remove a cloud from management. All appliances and workloads that are associated with the cloud are removed. The cloud is removed as a managed cloud. Additionally, all information that is associated with the cloud, such as deployment and network properties, is lost. N/A Delete a cloud: DELETE success GET /clouds This service is used to view the status of the current clouds that are being managed. N/A Get the configuration information and status of all clouds: GET 38 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

45 success "clouds":[ "timeout":600, "state": "label":"ok", "id":"ok" "iscomplete":true, "hostname":" ", "isjmsssl":false, "username":"root", "type":"vmware", "name":"vmware-120", "id":"1253", "description":"vmware-120", "uri":" "port": 5671, "iscomplete": true, "cloudtype": "OpenStack", "regionname": "regionone", "state": "id": "OK", "label": "OK" "hostname": " ", "qpidusername": "qpidclient", "uri": " "tenantname": "Public", "id": "352", "sslenabled": true, "username": "sceagent", "description": "", "name": "os", "isjmsssl": false, "timeout": 300 ] GET /clouds/id Use this service to view the status of a single cloud that is being managed. N/A Get the configuration information and status of a single cloud: GET success Chapter 1. IBM Cloud Manager with OpenStack REST API reference 39

46 "port": 5671, "iscomplete": true, "cloudtype": "OpenStack", "regionname": "regionone", "state": "id": "OK", "label": "OK" "hostname": " ", "qpidusername": "qpidclient", "uri": " "tenantname": "Public", "id": "352", "sslenabled": true, "username": "sceagent", "description": "", "name": "os", "isjmsssl": false, "timeout": 300 GET /clouds?types This service retrieves the supported cloud types. N/A Get the supported cloud types: GET success "cloudtypes": [ "versions": [ "type": "OpenStack" "versions": [ "type": "VMware" "uri": " GET /clouds/id/certificate This service is used to get the SSL certificate for the cloud. N/A 40 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

47 GET success "md5fingerprint":"30:1e:7e:67:b8:e4:cd:d9:97:26:df:7d:47:2c:24:e9", "validfrom": , "issuedto":" "trusted":true, "validto": , "issuer":" IBM, US", "subject":" IBM, US", "serialnumber":"44:ee:af:ee", "sha1fingerprint":"2c:a4:c8:aa:73:05:45:a8:94:b1:73:f4:fe:21:f6:17:c2:fe:01:05" PUT /clouds/id This service is used to update the cloud configuration and the cloud connection that is based on the provided cloud configuration information. By default, this service trusts the SSL certificate from the cloud provider. test Default value for this parameter is false. This gives the clients of the service the option to test the cloud configuration. By default, the SSL certificate is always trusted when testing the cloud connection. Draft comment Similar questions on this as from an earlier file. Update this when Nate responses on the other question. Note: When you have an existing connection, testing the connection is not supported. Use the test parameter only when you do not have a valid connection and want to test the new configuration. trust Specifies whether to trust the SSL certificate. By default, this service always trusts the certificate. This parameter also controls whether to trust the cloud connection. ou might choose not to trust the connection if something about the cloud configuration has changed. 1 Update the cloud name and description. PUT "name":"test Cloud Changed", "description":"test OpenStack Cloud Changed." 1 success Chapter 1. IBM Cloud Manager with OpenStack REST API reference 41

48 2 Untrust the current cloud connection and certificate. PUT 2 success Delinquency policies services IBM Cloud Manager with OpenStack provides services for managing delinquency policies. Related information: Code license and disclaimer information on page 205 GET /billing/delinquencypolicies This service retrieves all the delinquency policies that are defined within IBM Cloud Manager with OpenStack. GET No HTTP body required. HTTP Response Body: "delinquencypolicies":[ "name":"shutdown deployments", "id":"com.ibm.cfs.services.billing.policies.shutdown", "uri":" "name":"destroy deployments", "id":"com.ibm.cfs.services.billing.policies.destroy", "uri":" "name":"do nothing", "id":"com.ibm.cfs.services.billing.policies.do.nothing", "uri":" ] GET /billing/delinquencypolicies/id This service retrieves the properties of a specific delinquency policy by id. GET No HTTP body required. 42 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

49 HTTP Response Body: "name":"shutdown deployments", "id":"com.ibm.cfs.services.billing.policies.shutdown", "uri":" Event services IBM Cloud Manager with OpenStack provides the following services for events. Related information: Code license and disclaimer information on page 205 DELETE /events This service clears event messages by a specified combination of conditions. Name Description Default Required severity String of form severity=(info,warning,severe). Represents query by event severity. The severity may be a combination of values, such as any of the following: null No v severity=info,severe v severity=info,warning v severity=severe,warning v severity=info,severe,warning starttime endtime This is a timestamp that is used to specify a starting timeframe for events returned. Events that occur before this timestamp are not returned. The starttime and endtime can be used together or alone to specify a timeframe for the events returned. This value is a timestamp that is the number of milliseconds since January 1, 1970, 00:00:00 GMT. This is a timestamp that is used to specify an ending timeframe for events returned. Events that occur after this timestamp are not returned. The starttime and endtime can be used together or alone to specify a timeframe for the events returned. This value is a timestamp that is the number of milliseconds since January 1, 1970, 00:00:00 GMT. null null No es To remove events with combination of conditions: DELETE &severity=info,warning Chapter 1. IBM Cloud Manager with OpenStack REST API reference 43

50 if successful GET /events This service retrieves a list of events for the current user. The current user is defined in the request header cookie saveduserid, therefore callers must ensure that set this cookie specifies the user for which to retrieve events. The events that are retrieved are in descending order. The API current provides the following resource types for event messages (that is, the type in an element of the resources array); cloudconfiguration, workload, deploymenttarget, appliance, project, user, and virtualserver. Name Description Default Required start This is the index of the first record that is returned 1 No from the database must >=0 and Integer count This is the number of records to return after the "start" 20 No parameter record, must >0 and Integer. all If true, then all known events are retrieved for the user. false No originator String of form originator=admin or originator=rykal, null No and represents query by event originator. severity String of form severity=(info,warning,severe). null No Represents query by event severity participants String of form /participants=user:nate,sue;project:1. null No Both the Type and ids are required. starttime This is a timestamp that is used to specify a starting timeframe for events returned. Events that occur before this timestamp are not returned. The starttime and endtime can be used together or alone to specify a timeframe for the events returned. This value is a timestamp that is the number of milliseconds since January 1, 1970, 00:00:00 GMT. null No endtime order sortby This is a timestamp that is used to specify an ending timeframe for events returned. Events that occur after this timestamp are not returned. The starttime and endtime can be used together or alone to specify a timeframe for the events returned. This value is a timestamp that is the number of milliseconds since January 1, 1970, 00:00:00 GMT. This is the order that is used to specify the order direction for the events returned. Order can be descending (desc) or ascending (asc). This the sorting column that is used to retrieve the events. null desc timestamp No No No 44 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

51 GET No HTTP body required. HTTP Response Body: "events":[ "resources":[ "type":"user", "id":"test", "name":"test" "timestamp":" ", "message":"user $0 was created.", "id":"404", "uri":" "originator":"skc Administrator", "severity": "label":"info", "id":"info" "resources":[ "type":"appliance", "id":"102", "name":"myapp on AIX Image (dual-nic)" "timestamp":" ", "message":"new appliance $0 discovered in cloud.", "id":"403", "uri":" "originator":"system", "severity": "label":"info", "id":"info" "resources":[ "type":"appliance", "id":"101", "name":"myapp on SUSE Image" "timestamp":" ", "message":"new appliance $0 discovered in cloud.", "id":"402", "uri":" "originator":"system", "severity": "label":"info", "id":"info" Chapter 1. IBM Cloud Manager with OpenStack REST API reference 45

52 "resources":[ "type":"workload", "id":"251", "name":"workload 1" "timestamp":" ", "message":"new workload $0 discovered in cloud.", "id":"401", "uri":" "originator":"system", "severity": "label":"info", "id":"info" "total":"46" GET /events/eventcsv This service exports the events that are retrieved for the current user with specified conditions. The exported file is in comma-separated value (CSV) format. Name Description Default Required severity String of form severity=(info,warning,severe). Represents query by event severity. The severity might be a combination of values, such as any of the following: null No v severity=info,severe v severity=info,warning v severity=severe,warning v severity=info,severe,warning starttime endtime This is a timestamp that is used to specify a starting timeframe for events returned. Events that occur before this timestamp are not returned. The starttime and endtime can be used together or alone to specify a timeframe for the events returned. This value is a timestamp that is the number of milliseconds since January 1, 1970, 00:00:00 GMT. This is a timestamp that is used to specify an ending timeframe for events returned. Events that occur after this timestamp are not returned. The starttime and endtime can be used together or alone to specify a timeframe for the events returned. This value is a timestamp that is the number of milliseconds since January 1, 1970, 00:00:00 GMT. null null No es To export file of events that query with combination of conditions: 46 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

53 GET &severity=info,warning if successful This service creates a new CSV file and exports it to the serverhome/.skc/archives directory. The name of the file includes events_, and the file is timestamped with the creation date. Columns included in the CSV file include EventID, Event, Severity, Originator, Time. GET /events/id This service retrieves an event by its ID. This service can be used by callers if they know a specific event id to retrieve. N/A GET No HTTP body required. HTTP Response Body: "id": "404", "message": "!user.created!", "resources": [ "type": "USER", "id": "test", "name": "test" "severity": "id": "INFO", "label": "Info" "timestamp": " ", "uri": " Expiration policy services The IBM Cloud Manager with OpenStack product provides the following expiration policy services. Related information: Code license and disclaimer information on page 205 GET /expirationpolicies This service gets the expiration policies. Chapter 1. IBM Cloud Manager with OpenStack REST API reference 47

54 N/A Retrieve all the expiration policies. GET No HTTP body required. HTTP Response Body: "expirationpolicies": [ "notificationfrequency": 3, "maxexpirationperiod": 30, "deleteaftergrace": true, "notificationstart": 14, "graceperiod": 0, "id": "51", "enableextension": true, "maxextensionperiod": 30, "maxexpirationperiodwithoutsetting": 1825, "ownertype": "project", "workloadexpirationsettingappliable": false, "ownerid": "1" "notificationfrequency": 3, "maxexpirationperiod": 30, "deleteaftergrace": true, "notificationstart": 14, "graceperiod": 0, "id": "52", "enableextension": true, "maxextensionperiod": 30, "maxexpirationperiodwithoutsetting": 1825, "ownertype": "project", "workloadexpirationsettingappliable": false, "ownerid": "2" ] PUT /expirationpolicy This service updates the properties of the default expiration policy. N/A 48 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

55 Update the properties of the default expiration policy. PUT "id" :"701", "notificationfrequency":3, "notificationstart",14, "maxexpirationperiod":30, "maxexpirationperiodwithoutsetting":1825, "maxextensionperiod":30, "graceperiod" :30, "workloadexpirationsettingappliable":false, "enableextension":true, "deleteaftergrace":false GET /expirationpolicy/id This service retrieves expiration policy by the expiration policy id. N/A GET No HTTP body required. HTTP Response Body: "notificationfrequency": 3, "maxexpirationperiod": 30, "deleteaftergrace": true, "notificationstart": 14, "graceperiod": 0, "id": "52", "enableextension": true, "maxextensionperiod": 30, "maxexpirationperiodwithoutsetting": 1825, "ownertype": "project", "workloadexpirationsettingappliable": false, "ownerid": "2" PUT /expirationpolicy/id This service updates the expiration policy identified by the expiration policy id. Chapter 1. IBM Cloud Manager with OpenStack REST API reference 49

56 N/A PUT HTTP Request Body: "notificationfrequency": 5, "maxexpirationperiod": 30, "deleteaftergrace": true, "notificationstart": 14, "graceperiod": 0, "enableextension": true, "maxextensionperiod": 30, "maxexpirationperiodwithoutsetting": 1825, "workloadexpirationsettingappliable": true HTTP Response Body: "notificationfrequency": 5, "maxexpirationperiod": 30, "deleteaftergrace": true, "notificationstart": 14, "graceperiod": 0, "id": "52", "enableextension": true, "maxextensionperiod": 30, "maxexpirationperiodwithoutsetting": 1825, "ownertype": "project", "workloadexpirationsettingappliable": true, "ownerid": "2" GET /projects/id/expirationpolicy This service retrieves the expiration policy of the project. N/A GET No HTTP body required. 50 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

57 HTTP Response Body: "notificationfrequency":3, "maxexpirationperiod":30, "deleteaftergrace":true, "notificationstart":14, "graceperiod":0,"id":"52", "enableextension":true, "maxextensionperiod":30, "maxexpirationperiodwithoutsetting":1825, "ownertype":"project", "workloadexpirationsettingappliable":false, "ownerid":"1234" IaaS gateway services Before you can set up any clouds, you must configure the OpenStack Gateway. ou use IaaS gateway services to configure the OpenStack Gateway. Related information: Code license and disclaimer information on page 205 GET /iaasgateways This service retrieves all IaaS gateways. N/A GET HTTP Response Body: "iaasgateways": [ "port": 9973, "mocktype": "memory", "iscomplete": true, "state": "id": "OK", "label": "OK" "hostname": "iaas", "regions": [ "regionname": "region1" "regionname": "region2" "uri": " Chapter 1. IBM Cloud Manager with OpenStack REST API reference 51

58 ] "id": "351", "sslenabled": true, "username": "admin", "description": "it is the iaas gateway.", "name": "iassgateway", "isjmsssl": false, "timeout": 300 POST /iaasgateways This service creates a unique IaaS gateway. N/A POST "port": 9973, "sslenabled": true, "mocktype": "memory", "iscomplete": true, "username": "admin", "description": "it is the iaas gateway.", "name": "iassgateway", "hostname": "iaas", "regions": [ "isjmsssl": false, "timeout": 300 HTTP Status: 201 PUT /iaasgateways/id This service updates the specified IaaS gateway. N/A Update the IaaS gateway that has ID of 351. PUT "name": "iassgateway", "description": "it is the iaas gateway.", "hostname": "iaas", "username": "root", "mock": false, "cloudtype": "IaaSGateway", "password": "root", "port": 9973, 52 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

59 "tenantname": "public", "timeout": 300, "sslenabled": false GET /iaasgateways/id This service retrieves the specified IaaS gateway. N/A Retreive the IaaS gateway that has ID of 351. GET "port": 9973, "id": "351", "sslenabled": false, "mocktype": "memory", "iscomplete": true, "username": "root", "state": "id": "OK", "label": "OK" "hostname": "iaas", "regions": [ "regionname": "region1" "regionname": "region2" "isjmsssl": false, "uri": " "timeout": 300 DELETE /iaasgateways/id This service deletes the specified IaaS gateway. N/A Chapter 1. IBM Cloud Manager with OpenStack REST API reference 53

60 Delete the IaaS gateway that has ID of 351. DELETE Key pair services IBM Cloud Manager with OpenStack provides the following services for key pairs. These functions apply only to an OpenStack cloud. Related information: Code license and disclaimer information on page 205 GET /keypairs This service retrieves key pairs from the IBM Cloud Manager with OpenStack associated with the request authenticated user. Retrieve a listing of key pairs from the IBM SmartCloud Entry. GET No HTTP body required. HTTP Response Body: "keypairs": [ "cloudid": "301", "fingerprint": "88:c9:d3:fc:75:a3:77:da:2e:bb:54:fe:f5:70:ed:89", "publickey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDToRZem LJB5CwwN0hu9MgU0Mk1Hwbg/C7e+QgP38z8gp HrBMF3fV7HpQbB3xnkrhr/jo15qk8GPMckZ0DhzkrXQtdjm NBDESbwCWnJZEhgIePIqgBQmslhJhl FZ5ZKTaK6A7xySzFiF1HKFKoagfTMloPIBAwhQqABuyChIl DOxpvIgaP9l13x8ZKjILGP+5Rrw1dAQqa6R QWeFHX2SkXhJawFhOdmIcukQ7H7bpqASt4IZPMaE3 FZcNFieltX71+IU0T1UBd/4Kt7edK0nsK93U1xCWc6 FFazxnPp7i950yClzups91OdSigOVMNB+rTm8zmo02ux8JzJRh/ Generated by Nova\n", "name": "test_keypair1", "id": "cloud://301/test_keypair1", "privatekey": "", "uri": " "cloudid": "301", "fingerprint": "fa:95:ce:90:09:10:d2:5d:43:a9:9d:28:3f:71:9f:aa", "publickey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC702CI0gVq45Hn740s /H5EALv/yhMleCn86XWsuqjy TIFMOt1Kr23J6DNCPk2stJRpbqNSu4WF2rQyB6rdMXfiLSy3C4zQ/ 54 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

61 ] 5MJiOV8kFtZHDkjZaXKOgDZ72UWHEj7 KdDP8J7wFtWhaHR0/SwfCze5hsNMa7/ITzWdsBsb00fRQ+CmVk8x WqMovmjO2aUMagKmXIHssGnCaNuIk060yv XU06sv8MS8wfV1y5gzmojkUKKdz34BeTdCfjMTXlqAzQx2yn9j32yBVf2I0 /rwyb076pg5zkg7hujjc0q6tbbc2w NnfWHAv9x4cVyfRTbWubhy9yFqyEOAGV7NedmT Generated by Nova\n", "name": "test_keypair2", "id": "cloud://301/test_keypair2", "privatekey": "", "uri": " GET /keypairs/id This service retrieves the properties for a specific key pair from the IBM Cloud Manager with OpenStack. The key pair ID must be URL encoded. N/A GET No HTTP body required. HTTP Response Body: "cloudid": "301", "fingerprint": "88:c9:d3:fc:75:a3:77:da:2e:bb:54:fe:f5:70:ed:89", "publickey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDToRZemLJB5CwwN0hu9MgU0Mk1Hwbg/C7e+QgP38z8gp HrBMF3fV7HpQbB3xnkrhr/jo15qk8GPMckZ0DhzkrXQtdjmNBDESbwCWnJZEhgIePIqgBQmslhJhl FZ5ZKTaK6A7xySzFiF1HKFKoagfTMloPIBAwhQqABuyChIlDOxpvIgaP9l13x8ZKjILGP+5Rrw1dAQqa6 RQWeFHX2SkXhJawFhOdmIcukQ7H7bpqASt4IZPMaE3FZcNFieltX71+IU0T1UBd/4Kt7edK0nsK93U1xCWc6 FFazxnPp7i950yClzups91OdSigOVMNB+rTm8zmo02ux8JzJRh/ Generated by Nova\n", "name": "test_keypair1", "id": "cloud://301/test_keypair1", "privatekey": "" POST /keypairs This service generates or imports a key pair. N/A 1 Generate the key pair test_keypair1. POST Chapter 1. IBM Cloud Manager with OpenStack REST API reference 55

62 HTTP Request Body: "cloudid": 301, "name": "test_keypair1" 1 HTTP Status: 201 HTTP Response Body: "cloudid": "301", "fingerprint": "88:c9:d3:fc:75:a3:77:da:2e:bb:54:fe:f5:70:ed:89", "publickey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDToRZemLJB5CwwN0hu9MgU0Mk1Hwbg/C7e +QgP38z8gpHrBMF3fV7HpQbB3xnkrhr/jo15qk8GPMckZ0DhzkrXQtdjmNBDESbwCWnJZEhgIe PIqgBQmslhJhlFZ5ZKTaK6A7xySzFiF1HKFKoagfTMloPIBAwhQqABuyChIlDOxpvIgaP9l13x8 ZKjILGP+5Rrw1dAQqa6RQWeFHX2SkXhJawFhOdmIcukQ7H7bpqASt4IZPMaE3FZcNFieltX71 +IU0T1UBd/4Kt7edK0nsK93U1xCWc6FFazxnPp7i950yClzups91OdSigOVMNB+rTm8zmo02ux8JzJRh / Generated by Nova\n", "name": "test_keypair1", "id": "cloud://301/test_keypair1", "privatekey": "private key contents" 2 Import the key pair 'test_keypair2'. POST HTTP Request Body: "cloudid": 301, "name": "test_keypair2", "publickey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDToRZemLJB5CwwN0hu9MgU0Mk1Hwbg/C7e +QgP38z8gpHrBMF3fV7HpQbB3xnkrhr/ jo15qk8gpmckz0dhzkrxqtdjmnbdesbwcwnjzehg IePIqgBQmslhJhlFZ5ZKTaK6A7xySzFiF1HKFKoagfT MloPIBAwhQqABuyChIlDOxpvIgaP9l13x8ZKjILGP +5Rrw1dAQqa6RQWeFHX2SkXhJawFhOdmIcuk Q7H7bpqASt4IZPMaE3FZcNFieltX71+IU0T1UBd/ 4Kt7edK0nsK93U1xCWc6FFazxnPp7i950yClzups91Od SigOVMNB+rTm8zmo02ux8JzJRh/ Generated by Nova\n" 2 HTTP Status: 201 HTTP Response Body: "cloudid": "301", "fingerprint": "88:c9:d3:fc:75:a3:77:da:2e:bb:54:fe:f5:70:ed:89", "publickey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDToRZemLJB5CwwN0hu9MgU0Mk1Hwbg/C7e +QgP38z8gpHrBMF3fV7HpQbB3xnkrhr/ jo15qk8gpmckz0dhzkrxqtdjmnbdesbwcwnjzehg IePIqgBQmslhJhlFZ5ZKTaK6A7xySzFiF1HKFKoagf TMloPIBAwhQqABuyChIlDOxpvIgaP9l13x8ZKjILGP +5Rrw1dAQqa6RQWeFHX2SkXhJawFhOdmIcukQ 7H7bpqASt4IZPMaE3FZcNFieltX71+IU0T1UBd /4Kt7edK0nsK93U1xCWc6FFazxnPp7i950yClzups91OdSigOVMNB+rTm8zmo02ux8JzJRh /Generated by Nova\n", 56 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

63 "name": "test_keypair2", "id": "cloud://301/test_keypair2" License key services IBM Cloud Manager with OpenStack provides the following services for license keys. Related information: Code license and disclaimer information on page 205 GET /licensing This service retrieves license key information of IBM Cloud Manager with OpenStack. ou must have Administrator access to use this API. Retrieve the license key from IBM Cloud Manager with OpenStack. GET No HTTP body required. 1. This is a sample response if IBM Cloud Manager with OpenStack is configured with a license key containing an expiration date. HTTP Response Body: "product":"sce", "startdate":" ", "duration":1084, "expirationdate":" ", "type":"trial_mode_expirition_date", "leftdays":1081, "version":" " 2. This is a sample response if IBM Cloud Manager with OpenStack is configured with a license key containing a 90 day trail period. HTTP Response Body: "product":"sce", "startdate":" ", "duration":90, "expirationdate":" ", "type":"trial_mode_duration", "leftdays":90, "version":" " 3. This is a sample response if IBM Cloud Manager with OpenStack is configured with a permanent license key. HTTP Response Body: Chapter 1. IBM Cloud Manager with OpenStack REST API reference 57

64 "product":"sce", "startdate":" ", "type":"permanent", "version":" " PUT /licensing This service updates the license key. Iaasgw Note: This is an optional parameter. The default value is true. v Sample 1: The administrator only needs to update the license key of IBM Cloud Manager with OpenStack. PUT Content-Type : application/octet-stream Or application/binary, multipart/form-data(for IE9 only) v Sample 2: The administrator needs to update the license key of IBM Cloud Manager with OpenStack and the IaaS gateway. PUT Content-Type : application/octet-stream Or application/binary, multipart/form-data(for IE9 only) OK Metering data services IBM Cloud Manager with OpenStack provides the following services managing metering data. Related information: Code license and disclaimer information on page 205 GET /udrfiles This service gets the directories list containing all metering data (UDR) files. GET No HTTP body required. HTTP Response Body: "total": 2, "udrfiles": [ 58 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

65 ] "type": "directory", "name": " ", "uri": " "type": "directory", "name": " ", "uri": " GET /udrfiles/directoryname This service retrieves the files list in a specific directory. GET No HTTP body required. HTTP Response Body: "total": 2, "udrfiles": [ "type": "file", "name": "UDR_ csv", "uri":" "type": "file", "name": "UDR_ csv.digest", "uri":" ] GET /udrfiles/directoryname/filename This service retrieves the file of specific file name. GET No HTTP body required. HTTP Response Body: The specific file according the file name. GET /udrs This service gets all the universal data records (UDRs) for metering data. Chapter 1. IBM Cloud Manager with OpenStack REST API reference 59

66 GET No HTTP body required. Name Description Default Required userid Gets the UDRs that can be N/A No viewed by this userid. globalobjectid Gets the UDRs for the N/A No specified globalobjectid. cloudid Gets the UDRs for the N/A No specified cloudid. objecttype Gets the UDRs for the N/A No specified objecttype. objectid Gets the UDRs for the N/A No specified objectid. projectid Gets the UDRs the specified N/A No projectid. architecture Gets the UDRs for the N/A No specified architecture. hypervisor Gets the UDRs for the N/A No specified hypervisor. starttime Gets the UDRs for which the start time is after specified value. N/A No endtime start count sortby order cloudname Gets the UDRs for which the end time is after the specified value. This is the index of the first record that will be returned from the database. The value must be an integer greater than zero. This is the number of records to return after the "start" parameter record. The value must be an integer greater than zero. This parameter supports objectname, projectname, userid, starttime, and cloudname. Case insensitive. Specify order with ascending or descending. Parameter can be set to desc or asc. Gets the UDRs for the specified cloudname. Now No 0 No 1000 No starttime desc N/A No No No 60 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

67 HTTP Response Body "total": 2, "udrs": [ "cloudid": "352", "cloudtype": "OpenStack", "resourcevalues": "MEMOR": 1-24, "DISK": 50, "CPU": 1 "meteringinterval": 1, "endtime": , "uri": " "cloudname": "os", "id": "1405", "starttime": , "identifiervalues": "objectname": "instance ", "hypervisor": "KVM", "IP": "", "state": "id": "UNKNOWN", "label": "Unknown" "workloadname": "kvm2", "projectid": "51", "architecture": "x86", "projectname": "Public", "workloadid": "1302" "objectid": "1352", "userid": "admin", "globalobjectid": "cloud://352/8c62c2f3-ee0a-44d d35fb127b13", "objecttype": "virtual machine" "cloudid": "352", "cloudtype": "OpenStack", "resourcevalues": "MEMOR": 2048, "DISK": 100, "CPU": 2 "meteringinterval": 1, "endtime": , "uri": " "cloudname": "os", "id": "1404", "starttime": , "identifiervalues": "objectname": "instance ", "hypervisor": "KVM", "IP": " ", "state": "id": "RUNNING", "label": "Running" "workloadname": "kvm-test1", "projectid": "51", "architecture": "x86", "projectname": "Public", "workloadid": "1303" "objectid": "1353", "userid": "admin", "globalobjectid": "cloud://352/83b d-46b5-befb-ae91f4b16a07", "objecttype": "virtual machine" Chapter 1. IBM Cloud Manager with OpenStack REST API reference 61

68 "uri": " GET /udrs/id This service retrieves the UDR with the udrid. GET No HTTP body required. HTTP Response Body: "resourcevalues": "MEMOR": 1024, "CPU": 0.5, "DISK": 5120 "cloudid": "352", "cloudname": "OSCloud", "cloudtype": "OpenStack", "userid": "", "endtime": "0", "objecttype": "virtual machine", "objectid": "751", "identifiervalues": "state": "id": "RUNNING", "label": "RUNNING" "workloadname": "naj_1202", "workloadid": "701", "architecture": "x86", "projectname": "Public", "projectid": "151", "hypervisor": "KVM", "objectname": "naj " "id": "952", "uri": " "globalobjectid": "cloud://default/13227", "meteringinterval": 1, "starttime": " :12:35" Network configuration services Work with your network configuration using the services described here. Related information: Code license and disclaimer information on page 205 GET /networkconfigurations This service retrieves all network configurations. 62 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

69 Network configurations are used to automatically provide IP addresses, host names, DNS, gateway addresses, subnet masks, domain suffix search list, DHCP setting, and WINS addresses for workloads. An appliance can be configured to use a network configuration from an existing network configuration upon deployment. This is an admin web service. cloudgroupid (optional) Filters network configuration by cloudgroupid. Returns the network configurations that are valid for the specified cloudgroupid. If you specify * for the cloudgroupid, all network configurations are returned. GET No HTTP body required. Note: The IPv6 related fields are returned only when there is an IPv6 subnet configured in this network. HTTP Response Body: "networkconfigurations": [ "domainsuffixes": "value": "", "label": "Domain suffix search list" "ipaddresspooluri": " "blockedcount": 0, "freecount": 41, "domain": "value": "private.cloud.com", "label": "Domain name" "hostnameprefix": "value": "sce", "label": "Host name prefix" "dns1": "value": " ", "label": "DNS 1" "networkid": "value": "", "label": "Network ID" "dns2": "value": " ", "label": "DNS 2" "name": "Default", "uri": " "gateway1": Chapter 1. IBM Cloud Manager with OpenStack REST API reference 63

70 "value": " ", "label": "Gateway address" "gateway2": "value": "", "label": "Alternate gateway address" "workgroup": "value": "WORKGROUP", "label": "Workgroup" "usedcount": 0, "isdefault": false, "usedhcp": "value": false, "label": "Use DHCP" "computernameprefix": "value": "sce", "label": "Computer name prefix" "wins1": "value": " ", "label": "Primary WINS address" "obtainfromdns": "value": false, "label": "Obtain hostname and domain name from DNS server" "id": "151", "wins2": "value": " ", "label": "Secondary WINS address" "description": "Default Network Configuration", "subnet": "value": " ", "label": "Subnet mask" "cloudgroupuri": " "ipaddresspooluri": " "blockedcount": 0, "freecount": -1, "hostnameprefix": "value": "sce", "label": "Host name prefix" "cloudgroupid": "306", "networkid": "value": "VM Network", "label": "Network ID" "name": "DHCP", "uri": " "workgroup": "value": "WORKGROUP", "label": "Workgroup" "cloudtype": "VMware", "usedcount": -1, "cloudgroupname": "vcenter10", 64 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

71 "isdefault": false, "usedhcp": "value": true, "label": "Use DHCP" "computernameprefix": "value": "sce", "label": "Computer name prefix" "obtainfromdns": "value": false, "label": "Obtain hostname and domain name from DNS server" "id": "2052", "description": "Sample DHCP configuration", "subnet": "value": " ", "label": "Subnet mask" "cloudgroupuri": " "blockedcount": 0, "freecount": 253, "cloudgroupid": "304", "networktype": "value": "vlan", "label": "Network type" "name": "VLAN50", "cloudtype": "OpenStack", "usedcount": 0, "physicalnetwork": "value": "default", "label": "Physical network" "endallocation": "value": " ", "label": "IP allocation pool end address" "id": "304_6c72f74b-f335-4aef-bb23-9afcd89341a4", "blockedipv6count": 0, "freeipv6count": 253, "ipv6gateway": "value": "2001:db8::192:168:50:1", "label": "IPv6 gateway address" "subnet": "value": " ", "label": "Subnet mask" "vlanid": "value": 50, "label": "VLAN id" "ipv6prefixlength": "value": "120", "label": "IPv6 prefix length" "startallocation": "value": " ", "label": "IP allocation pool start address" Chapter 1. IBM Cloud Manager with OpenStack REST API reference 65

72 "ipaddresspooluri": " 304_6c72f74b-f335-4aef-bb23-9afcd89341a4/ipAddresses", "dns1": "value": " ", "label": "DNS 1" "dns2": "value": " ", "label": "DNS 2" "networkid": "value": "6c72f74b-f335-4aef-bb23-9afcd89341a4", "label": "Network ID" "usedipv6count": 0, "uri": " 304_6c72f74b-f335-4aef-bb23-9afcd89341a4", "gateway1": "value": " ", "label": "Gateway address" "ipv6dns1": "value": "2001:db8:0:0:203:0:113:100", "label": "IPv6 DNS1" "ipv6dns2": "value": "2001:db8:0:0:203:0:113:200", "label": "IPv6 DNS2" "ipv6endallocation": "value": "2001:db8:0:0:192:168:50:fe", "label": "IPv6 IP allocation pool end address" "cloudgroupname": "OpenStack", "isdefault": false, "usedhcp": "value": false, "label": "Use DHCP" "usedhcpv6": "value": false, "label": "Use IPv6 DHCP" "obtainfromdns": "value": false, "label": "Obtain hostname and domain name from DNS server" "ipv6startallocation": "2001:db8:0:0:192:168:50:2" ] The query response might include cloudgroupuri, cloudgroupid, and cloudgroupname or include none of the three if the networkconfiguration does not belong to any cloud groups. POST /networkconfigurations This service adds a network configuration. Network configuration names must be unique. If a new network configuration name conflicts with an existing network configuration name, the service responds with a 400 status code. ou can also specify some IP addresses when you create a network configuration. 66 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

73 This is an admin web service. 1 Add a network configuration named Sample Network Configuration without a cloudgroupid: POST HTTP Request Body: "name":"sample Network Configuration", "description":"sample network configuration", "networkid":"vm Network", "gateway1":" ", "subnet":" ", "dns1":" ", "domain":"private.cloud.com" 1 HTTP Status: 201 HTTP Location: URL of the new network configuration HTTP Response Body: "ipaddresspooluri": " "blockedcount": 0, "freecount": 0, "domain": "value": "private.cloud.com", "label": "Domain name" "dns1": "value": " ", "label": "DNS 1" "networkid": "value": "VM Network", "label": "Network ID" "name": "Sample Network Configuration", "uri": " "gateway1": "value": " ", "label": "Gateway address" "usedcount": 0, "isdefault": false, "usedhcp": "value": false, "label": "Use DHCP" "obtainfromdns": "value": false, "label": "Obtain hostname and domain name from DNS server" "id": "2053", "description": "Sample network configuration", "subnet": "value": " ", "label": "Subnet mask" 2 Add a network configuration for OpenStack Cloud named OpenStack VLAN10 with a cloudgroupid of 304: POST HTTP Request Body: Chapter 1. IBM Cloud Manager with OpenStack REST API reference 67

74 "name":"openstack VLAN10", "cloudgroupid":"304", "networktype":"vlan", "physicalnetwork":"default", "vlanid":10, "gateway1":" ", "subnet":" ", "startallocation":" ", "endallocation":" ", "dns1":" ", "ipv6gateway":"2001:db8:0:0:192:168:10:1", "ipv6prefixlength":"120", "ipv6startallocation":"2001:db8:0:0:192:168:10:2", "ipv6endallocation":"2001:db8:0:0:192:168:10:fe" 2 "cloudgroupuri": " "freecount": 253, "blockedcount": 0, "cloudgroupid": "304", "networktype": "value": "vlan", "label": "Network type" "name": "OpenStack VLAN10", "cloudtype": "OpenStack", "usedcount": 0, "physicalnetwork": "value": "default", "label": "Physical network" "id": "304_b45cd4b5-c4d de-e97e63c3366a", "endallocation": "value": " ", "label": "IP allocation pool end address" "freeipv6count": 253, "blockedipv6count": 0, "ipv6gateway": "value": "2001:db8:0:0:192:168:10:1", "label": "IPv6 gateway address" "subnet": "value": " ", "label": "Subnet mask" "vlanid": "value": 10, "label": "VLAN id" "ipv6prefixlength": "value": "120", "label": "IPv6 prefix length" "startallocation": "value": " ", "label": "IP allocation pool start address" "ipaddresspooluri": " 304_b45cd4b5-c4d de-e97e63c3366a/ipAddresses", "dns1": "value": " ", "label": "DNS 1" "networkid": "value": "b45cd4b5-c4d de-e97e63c3366a", "label": "Network ID" "usedipv6count": 0, 68 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

75 "uri": " 304_b45cd4b5-c4d de-e97e63c3366a", "gateway1": "value": " ", "label": "Gateway address" "ipv6endallocation": "value": "2001:db8:0:0:192:168:10:fe", "label": "IPv6 IP allocation pool end address" "cloudgroupname": "OpenStack", "isdefault": false, "usedhcpv6": "value": false, "label": "Use IPv6 DHCP" "usedhcp": "value": false, "label": "Use DHCP" "obtainfromdns": "value": false, "label": "Obtain hostname and domain name from DNS server" "ipv6startallocation": "2001:db8:0:0:192:168:10:2" GET /networkconfigurations/id This service retrieves a specific network configuration. Network configurations are used to automatically provide IP addresses, host names, DNS, gateway addresses, subnet masks, domain suffix search list, DHCP setting, and WINS addresses for workloads. An appliance can be configured to use an existing network configuration upon deployment. This service retrieves all known information about a network configuration such as DNS1, DNS2, and gateway addresses. This is an admin web service. N/A GET No HTTP body required. Note: The IPv6 related fields are returned only when there is an IPv6 subnet configured in this network. HTTP Response Body: "cloudgroupuri": " "freecount": 253, "blockedcount": 0, "cloudgroupid": "304", "networktype": "value": "vlan", "label": "Network type" Chapter 1. IBM Cloud Manager with OpenStack REST API reference 69

76 "name": "VLAN50", "cloudtype": "OpenStack", "usedcount": 0, "physicalnetwork": "value": "default", "label": "Physical network" "id": "304_6c72f74b-f335-4aef-bb23-9afcd89341a4", "endallocation": "value": " ", "label": "IP allocation pool end address" "freeipv6count": 253, "blockedipv6count": 0, "ipv6gateway": "value": "2001:db8::192:168:50:1", "label": "IPv6 gateway address" "subnet": "value": " ", "label": "Subnet mask" "vlanid": "value": 50, "label": "VLAN id" "ipv6prefixlength": "value": "120", "label": "IPv6 prefix length" "startallocation": "value": " ", "label": "IP allocation pool start address" "ipaddresspooluri": " networkconfigurations/304_6c72f74b-f335-4aef-bb23-9afcd89341a4/ipaddresses", "dns1": "value": " ", "label": "DNS 1" "dns2": "value": " ", "label": "DNS 2" "networkid": "value": "6c72f74b-f335-4aef-bb23-9afcd89341a4", "label": "Network ID" "usedipv6count": 0, "uri": " "gateway1": "value": " ", "label": "Gateway address" "ipv6dns1": "value": "2001:db8:0:0:203:0:113:100", "label": "IPv6 DNS1" "ipv6dns2": "value": "2001:db8:0:0:203:0:113:200", "label": "IPv6 DNS2" "ipv6endallocation": "value": "2001:db8:0:0:192:168:50:fe", "label": "IPv6 IP allocation pool end address" "cloudgroupname": "OpenStack", "isdefault": false, "usedhcpv6": "value": false, "label": "Use IPv6 DHCP" "usedhcp": "value": false, "label": "Use DHCP" "obtainfromdns": "value": false, 70 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

77 "label": "Obtain hostname and domain name from DNS server" "ipv6startallocation": "2001:db8:0:0:192:168:50:2" PUT /networkconfigurations/id This service updates a new network configuration. Note: ou can update only the following fields in the network configuration for an OpenStack cloud: v name v gateway1 v dns1 v dns2 v ipv6gateway v ipv6dns1 v ipv6dns2 In the OpenStack cloud network configuration, the order of the values for dns1 and dns2 might change after the values are updated. Network configurations names must be unique. If a new network configuration name conflicts with an existing network configuration name, the service responds with a 400 status code. This is an admin web service. Update a network configuration named specified by id 2053: PUT HTTP Request Body: "name":"sample Network Configuration - Renamed", "description":"sample network configuration - Description renamed", "gateway1":" ", "dns1":" ", "dns2":" ", "wins1":" ", "wins2":" " The response might include cloudgroupuri, cloudgroupid, and cloudgroupname or include none of the three if the networkconfiguration does not belong to any cloud groups. DELETE /networkconfigurations/id This service removes an existing network configuration and all of the IP addresses that it manages. If the network configuration to delete still has IP addresses in use, a 500 response is returned. Only network configurations with no used IP addresses can be deleted. This is an admin web service. Chapter 1. IBM Cloud Manager with OpenStack REST API reference 71

78 N/A Remove the network configuration with ID 2053 DELETE GET /networkconfigurations/id/ipaddresses This service retrieves all known managed IP addresses in a network configuration. A managed IP address is either used or unused as indicated by the IP addresses isused value, and blocked and unblocked is indicated by 'isblocked'. If an IP address is free, it is available for use in a workload. This is an admin web service. Name Description Default Required used The IP addresses retrieved false No should all be unused. start The index of the first item that is returned. Must be 0 and an integer. 0 No count isused isblocked ipaddress The number of items that are returned. Must be 0 and an integer. 0 = all items after starting index. Filter to limit output to only those records that match the specified value. Must be either true or false. By default, isused property is not filtered. Filter to limit output to only those records that match the specified value. Must be either true or false. By default, isblocked property is not filtered. Filter to limit output to only those records that match the specified value. By default, ipaddress property is not filtered. Filters of "." and ":" can be used to limit output to just IPv4 or IPv6 addresses. 0 No * No * No * No 72 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

79 Note: The query parameter of isused will always override the query parameter of used unless the default "*" is specified. For example: If the following value is specified: used = true used = false isused = true isused = false inused = * isused = false and used = true The query will return the following: Only those IP addresses that are in use. All IP addresses regardless of the isused setting. Only those IP addresses that are in use. Only those IP addresses that are not in use. All IP addresses. IP address that are not in use. isused property has priority. GET No HTTP body required. HTTP Response Body: "ipaddresses":[ "isblocked":false, "hostname":"skc-host1", "isused":false, "uri":" "ipaddress":" " "isblocked":false, "hostname":"skc-host2", "isused":false, "uri":" "ipaddress":" " ] POST /networkconfigurations/id/ipaddresses This service adds one or more IP addresses to the network configuration. Note: This interface is not supported for network configurations in an OpenStack cloud. All IP addresses must be defined when the OpenStack network configuration is first created. IP addresses are always created as unused and unblocked so the value of "isused" and ''isblocked'' are ignored on a POST service. If any IP addresses specified to this service are already managed, none of them are added to the pool of managed IP addresses. A 400 response is returned. To update the "isused" or ''isblocked'' values, use the PUT service. Chapter 1. IBM Cloud Manager with OpenStack REST API reference 73

80 This is an admin web service. N/A s 1. Adding an IP address to the network configuration with ID 2053: POST HTTP Request Body: "ipaddress":" ", "hostname":"cfs-221" 2. Adding multiple IP addresses to the network configuration with ID 2053: POST HTTP Request Body: [ "ipaddress":" ", "hostname":"cfs-222" "ipaddress":" ", "hostname":"cfs-223" ] 3. Adding multiple IP addresses in an address range to the network configuration with ID 2053: POST HTTP Request Body: "ipaddressrange": "start":" ", "end":" " HTTP Status: 201 HTTP Response Body: Note: The following HTTP response body is specific to sample request 2. The HTTP response body for the other sample requests is similar. "ipaddresses":[ "isblocked":false, "hostname":"cfs-222", "isused":false, "uri":" "ipaddress":" " "isblocked":false, "hostname":"cfs-223", "isused":false, 74 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

81 ] "uri":" "ipaddress":" " GET /networkconfigurations/id/ipaddresses/ip This service retrieves the properties of a specific managed IP address by IP address. If the isused and 'isblocked' values for the IP address are false, the IP is free and available for use by a workload. If the value of either isused or isblocked is true, the IP cannot be used by a workload. This is an admin web service. N/A GET No HTTP body required. HTTP Response Body: "isblocked":false, "hostname":"cfs-221", "isused":false, "uri":" "ipaddress":" " PUT /networkconfigurations/id/ipaddresses/ip This service enables updating of an existing managed IP address. The service is used to mark a managed IP address as blocked so that the IP address cannot be used in workloads. If the IP address is not in the managed IP pool, a 404 response is returned. This is an admin web service. N/A s 1. Set IP address to blocked and host name to cfs-221-blocked PUT Chapter 1. IBM Cloud Manager with OpenStack REST API reference 75

82 "isblocked":true, "hostname":"cfs-221-blocked" Note: Setting the host name of the IP address is not supported for network configurations in an OpenStack cloud. 2. Set IP addresses " " and " " to blocked PUT "isblocked":true 3. Set IP addresses that range from " " to '' '' to blocked PUT "isblocked":true, DELETE /networkconfigurations/id/ipaddresses/ip This service removes an existing IP address from the network configuration of managed IP addresses. Note: This interface is not supported for network configurations in an OpenStack cloud. IP addresses cannot be deleted from an OpenStack network configuration. If the specified IP is not in the network configuration of managed IP addresses, a 404 response is returned. This is an admin web service. N/A s 1. Remove the managed IP address " " in network configuration with ID DELETE 2. Remove the managed IP addresses " " and " " DELETE 3. Remove the managed IP addresses that range from " " to '' '' DELETE 76 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

83 Product information services Use the services listed here to obtain product information about the IBM Cloud Manager with OpenStack offering. Related information: Code license and disclaimer information on page 205 GET /productinfo/version This service retrieves the IBM Cloud Manager with OpenStack product version. N/A GET No HTTP body required GET /productinfo/shortname This service retrieves the IBM Cloud Manager with OpenStack product's short name. N/A GET No HTTP body required. SmartCloud Entry GET /productinfo/name This service retrieves the product's name. N/A GET No HTTP body required. Chapter 1. IBM Cloud Manager with OpenStack REST API reference 77

84 IBM Cloud Manager with OpenStack GET /productinfo/fullname This is a utility service that retrieves the full name and version of the IBM Cloud Manager with OpenStack product. N/A GET No HTTP body required. Content-Type: text/plain HTTP Response Body: IBM Cloud Manager with OpenStack GET /productinfo/vendorname This is a utility service that retrieves the IBM Cloud Manager with OpenStack product's vendor name. N/A GET No HTTP body required. Content-Type: text/plain HTTP Response Body: IBM GET /productinfo/vendoricon This is a utility service that retrieves the IBM Cloud Manager with OpenStack product's vendor icon. 78 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

85 N/A GET No HTTP body required. Content-Type: image/* HTTP Response Body is binary image stream. GET /productinfo/splash This is a utility service that retrieves the IBM Cloud Manager with OpenStack product's splash icon. N/A GET No HTTP body required. Content-Type: image/* HTTP Response Body is binary image stream. GET /productinfo/icontype This is a utility service that retrieves the IBM Cloud Manager with OpenStack product's icon, returns a 16x16 icon if type is small, returns a 32x32 icon if type is medium, pr returns a 48x48 icon if type is large. type, return 16x16 icon if type is small, return 32x32 icon if type is medium, return 48x48 icon if type is large GET No HTTP body required. Content-Type: image/* HTTP Response Body is binary image stream. Chapter 1. IBM Cloud Manager with OpenStack REST API reference 79

86 Project management services The IBM Cloud Manager with OpenStack product provides the following project management services. Related information: Code license and disclaimer information on page 205 GET /projects This service retrieves the list of projects in IBM Cloud Manager with OpenStack. The owner field in the returned json string is deprecated from IBM Cloud Manager with OpenStack 2.2, because there can be more than owners. Name Description Default Required user Gets the list of projects to which this user belongs N/A No role Gets the list of projects to which this user belongs and this user has the permission of specified role. This parameter should be used with the user parameter. This parameter supports OWNER, USER, and VIEWER. This parameter is case insensitive. OWNER has permission of USER and VIEWER. USER has permission of VIEWER. For example, if role is specified as USER, projects of which this user is OWNER and USER will be returned. N/A No GET No HTTP body required. HTTP Response Body: "identifier":"id", "projects":[ "isstaging":false, "usecloudapprovalpolicy": true, "ispublic":true, "isdefault":true, "name":"public", "id":"51", "description":"this is the default project for all existing Cloud resources.", 80 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

87 ] "uri":" "usecloudexpirationpolicy":true POST /projects This service creates a new project in IBM Cloud Manager with OpenStack. POST HTTP Request Body: "name":"myproject1", "description":"my number 1 project", "members":[ "username":"user1", "role":"owner" ] HTTP Status: 201 HTTP Location Header: The URI of the new project HTTP Response Body: "workloadsuri":" Header: The URI of the new project " "isstaging":false, "owner":"admin", "ispublic":false, "usersuri":"oud/api/projects/62951/workloads"> " "appliancesuri":"i/projects/62951/users"> " "isdefault":false, "name":"myproject2", "id":"62951", "description":"my number 1 project", "uri":" number 1 "usecloudexpirationpolicy":true " DELETE /projects/id This service deletes the project with the specified ID. DELETE No HTTP body required. Chapter 1. IBM Cloud Manager with OpenStack REST API reference 81

88 No HTTP response body PUT /projects/id This service updates the attributes of the project identified by ID. If the JavaScript Object Notation (JSON) in the request body does not contain a members array attribute, only the top-level project fields are synchronized. If the members array attribute is present in the incoming JSON, then the members are also synchronized. User names specified in the members array must exist as users. The implication of such is that you can update project members in bulk. s 1. Update the project with id 1234 to have the description My number 1 project. PUT HTTP Request Body: "description":"my number 1 project" 2. Update the project with id 1234 to have the name My Project, a description of A simple project, and have the project members admin and john. The underlying project members exactly match the members specified. 3. PUT HTTP Request Body: "name":"my Project", "description":"a simple description", "members":[ "username":"admin" "username":"john" ] 4. Update the project with id 1234 to have the usecloudexpirationpolicy as false. PUT HTTP Request Body: "usecloudexpirationpolicy":false No HTTP Response Body GET /projects/id This service retrieves the attributes of the project identified by id. 82 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

89 GET No HTTP body required. HTTP Response Body: "workloadsuri":" "isstaging":false, "owner":"admin", "ispublic":false, "usecloudapprovalpolicy": true, "usersuri":" "appliancesuri":" "isdefault":false, "name":"my Project", "id":"1234", "description":"a simple description", "uri":" "usecloudexpirationpolicy":true GET /projects/id/workloads This service retrieves the workloads with the specified ordering and counts associated with the project identified by id. Name Description Default Required start This is the index of the first record that will be returned from the database. If specified, the value must be an integer greater than zero. 0 No count sortby order includehidden This is the number of records to return after the "start" parameter record. The value must be an integer greater than zero. This is the sorted column in DeploymentEntity. This parameter supports EXECUTION_DATE, NAME, DESCRIPTION and STATE. This parameter is case insensitive. Specify order with ascending or descending. The parameter can be set desc or asc. Specifies whether returned workloads should include hidden workloads. 20 No EXECUTION_DATE desc false No No No Chapter 1. IBM Cloud Manager with OpenStack REST API reference 83

90 GET No HTTP body required. HTTP Response Body: "total": "2", "workloads": [ "cloudname": "zhanxin-gvttest-nodelete", "cloudgroupid": "352", "name": "zhanxin-gvttest-nodelete", "uri": " "cloudid": "cloud://352/422e40df a7c e91e74f804", "state": "label": "OK", "id": "OK" "projecturi": " "architecture": "x86", "ishidden": false, "cloudgroupname": "VMware-120", "hypervisor": "VMware", "id": "531", "description": "Workload could no longer be found in the Cloud. It could have been purposely deleted from the Cloud." "cloudname": "RHEL6_Template :41:05 test_ly_by_testuser", "cloudgroupid": "352", "name": "RHEL6_Template :41:05 test_ly_by_testuser", "uri": " "cloudid": "cloud://352/e7e213c5-4c6f-416b-9642-baa5ae6549cc", "state": "label": "OK", "id": "OK" "projecturi": " "architecture": "x86", "ishidden": false, "cloudgroupname": "VMware-120", "hypervisor": "VMware", "id": "73508", "description": "RHEL6_Template :41:05 test_ly_by_testuser" ] GET /projects/id/appliances This service retrieves the appliances that are associated with the project identified by id. GET No HTTP body required. 84 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

91 Localized values: "state" HTTP Response Body: "total": "2", "appliances": [ "cloudname": "RHEL62_Mult_NIC_template", "changeddate": , "cloudgroupid": "352", "name": "RHEL62_Mult_NIC_template", "uri": " "revisioncomments": "", "cloudid": "cloud://352/422e3a6f-48cd-7f0d-5ec7-b4e2ec4fdb7a", "state": "label": "OK", "id": "OK" "projecturi": " "architecture": "x86", "cloudgroupname": "VMware-120", "specificationversion": "vmx-08", "hypervisor": "VMware", "version": "vmx-08", "id": "55151", "revision": "", "description": "Red Hat Enterprise Linux 5 (64-bit)" "cloudname": "GVTTestLinux6.1", "changeddate": , "cloudgroupid": "352", "name": "GVTTestLinux6.1", "uri": " "revisioncomments": "", "cloudid": "cloud://352/422e0874-da6f-b06e-0f52-dacf7faa8a6d", "state": "label": "OK", "id": "OK" "projecturi": " "architecture": "x86", "cloudgroupname": "VMware-120", "specificationversion": "vmx-08", "hypervisor": "VMware", "version": "vmx-08", "id": "498", "revision": "", "description": "Red Hat Enterprise Linux 6 (64-bit)" ] GET /projects/id/users This service retrieves the users that have access to the project identified by id. GET No HTTP body required. Chapter 1. IBM Cloud Manager with OpenStack REST API reference 85

92 HTTP Response Body: "users":[ "uri":" "username":"admin", "name":"administrator", "isadmin":true, " notifications":true, "role": "id":"owner", "label":"owner" "uri":" "username":"jonest", "name":"tony Jones", "isadmin":false " notifications":true, "role": "id":"owner", "label":"owner" ] GET /projects/id/expirationpolicy This service retrieves the expiration policy of the project. N/A GET No HTTP body required. HTTP Response Body: "notificationfrequency":3, "maxexpirationperiod":30, "deleteaftergrace":true, "notificationstart":14, 86 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

93 "graceperiod":0,"id":"52", "enableextension":true, "maxextensionperiod":30, "maxexpirationperiodwithoutsetting":1825, "ownertype":"project", "workloadexpirationsettingappliable":false, "ownerid":"1234" POST /projects/id/users This service adds a user to the project identified by ID or sends the owner of the project a notification ( based as of 1.1) requesting access to the project for the specified user. For access request notification, the owner of the project must have notifications enabled to receive the access request message. Name Description Default Required requestonly Send a notification to the project owner requesting access. false No 1 Add the jonest user to project with ID POST HTTP Request Body: "username":"jonest", "role":"user" 1 HTTP Status: 201 HTTP Location Header: The URI of the added user within the project No HTTP Response Body 2 Send a notification to the owner of project 1234 requesting access for user john. The john user is not added by this call, rather the owner receiving the notification must add the user from the web interface. POST HTTP Request Body: "username":"john" 2 Chapter 1. IBM Cloud Manager with OpenStack REST API reference 87

94 PUT /projects/id/users/username This service will update a user's in the project identified by id. The role of the user may be changed to OWNER, USER, or VIEWER. The role of a project member may be changed only by an IBM SmartCloud Entry admin or the project's owner. Table 1. Name Description Required username The username of the user whose role in the project is to be updated yes Change the 'jonest' user's role to USER in project with Id '1234'. PUT HTTP Request Body: "role":"user" No HTTP response body DELETE /projects/id/users/username This service will remove the user identified by username from the project identified by id. DELETE No HTTP body required. No HTTP response body Request lifecycle services The IBM Cloud Manager with OpenStack product provides the following lifecycle services. Related information: Code license and disclaimer information on page IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

95 GET /requests This service retrieves a list of requests from the IBM Cloud Manager with OpenStack application. The service optionally allows the client to provide query parameters to retrieve specific requests by a given username or the request's resolved status. v The optional 'user' query parameter filters the list of requests by the given user. If the user is an admin or an approver all requests are returned. Otherwise only requests made by the given user are returned. v The optional 'resolved' query parameter filters the returned requests by their resolved status. If resolved is 'true' then only requests which are not in the 'PENDING' state are returned. If resolved is false only 'PENDING' requests are returned. v The optional 'parameters' query parameter filters the returned requests by parameter name, such as "deployment". Specific IDs can be specified for each given parameter, separated from the type by a colon (:). Multiple parameters can be specified by adding a semicolon (;) between them. v The optional 'state' query parameter filters the returned requests by their state, such as 'PENDING'. Multiple states can be checked for by adding a comma (,) between them to return requests that are in any of the states listed. v The user, resolved, parameter, and state query parameters can be used together. If no parameter is used, then all requests are returned unfiltered. There are other parameters related to pagination. Use the following query parameters to see more information. Name Description Default Required user Filters the list of requests by the given user. N/A No resolved Filters the lists of requests by their resolved status. N/A No parameters Filters the lists of requests by their parameter. N/A No state Filters the lists of requests by their state. N/A No start The index of the first record. 0 No count The number of records to return. 20 No sortby This parameter supports ID,REQUESTOR,STATE,ACTION, and REQUESTDATE. This parameter is case insensitive. ID No order Specify ascending (ASC) or descending (DESC) order. DESC No GET Retrieves all requests for 'myuser' which are resolved. If 'myuser' is an admin or approver of requests, then all requests are returned which are resolved. Otherwise only resolved requests are returned which were initiated by 'myuser'. No HTTP body required. GET Retrieves all PENDING or REJECTED requests that are deployments that have the ids 10,12,22. Chapter 1. IBM Cloud Manager with OpenStack REST API reference 89

96 HTTP Response Body: "total":"1", "requests":[ "state": "label":"approved", "id":"approved" "requestor":"admin", "action": "label":"deployment Executed", "id":"deploment_executed" "parameters": [ "value": "102" "name": "deployment" "id":"751", "uri":" "requestdate": "uri":" PUT /requests This service enables or disables the request lifecycle service as a whole. N/A 1 Enables the request lifecycle service as a whole. PUT "enabled":true 1 2 Disables the request lifecycle service as a whole. PUT 90 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

97 "enabled":false 2 GET /requests/id This service retrieves a specific request from IBM SmartCloud Entry by the request's id. None GET Retrieves the request which has the id of '751'. No HTTP body required. HTTP Response Body: "state": "label":"approved", "id":"approved" "requestor":"admin", "resolver":"admin", "action": "label":"deployment Executed", "id":"deploment_executed" "commentsuri":" "parametersuri":" "resolutiondate": , "name":"deploment_executed", "id":"751", "uri":" "requestdate": PUT /requests/id This service updates a specific request's status in IBM SmartCloud Entry specified by the request's id. This service cannot be use to modify other values associated with a request other than its state. Client's should use this service to approve, deny, reopen or withdraw requests. The accepted states for a request are: APPROVED - The request is approved. REJECTED - The request is rejected and cannot be completed. Chapter 1. IBM Cloud Manager with OpenStack REST API reference 91

98 WITHDRAWN - The request has been withdrawn and is no longer PENDING. PENDING - The request is open and pending approval. None s 1. Approve request 751. PUT HTTP Request Body: "state":"approved" 2. Deny request 732. PUT HTTP Request Body: "state":"rejected" HTTP Response Body: None GET /requests/id/parameters This service retrieves a specific request's parameters. None GET Retrieves the request which has the id of '751'. No HTTP body required. HTTP Response Body: "parameters":[ "value":"onedeploytest", "name":"workloadname" 92 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

99 "value":"65901", "name":"workload" "value":"workload", "name":"type" "uri":" PUT /requests/id/parameters This service updates a specific request's parameters. None Update the request parameters called cpu in request 751. PUT HTTP Request Body: "parameters": [ "name":"cpu", "value":"2"] HTTP Response Body: None GET /requests/id/comments Retrieve the comments for a specific request specified by its id. None Get the comments for request 751. GET HTTP Request Body: None Chapter 1. IBM Cloud Manager with OpenStack REST API reference 93

100 HTTP Response Body: "comments":[ "user":"admin", "date": , "comment":"this a sample comment" "user":"admin", "date": , "comment":"et another comment for request 751" "uri":" POST /requests/id/comments Add a comment to the request specified by its id. None Add a comment to request 751. POST HTTP Request Body: This is a request comment HTTP Response Body: None GET /requests/handlers Retrieves sets of the request handlers for cloud groups and projects. Request handlers are specified on a per action basis and will either be enabled or not. An enabled request handler for a specific action is used to process (handle) the request when fired within IBM Cloud Manager with OpenStack. Table 2. Query parameters Name Description Default value Required ownertype The type of object to which the handlers set belongs. Values are CLOUDGROUP or PROJECT. N/A false 94 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

101 Table 2. Query parameters (continued) Name Description Default value Required ownerid Cloud group id or project id. N/A false Get a list of the request handlers: GET HTTP Request Body: None HTTP Response Body: [ "requesthandlers": [ "enabled": false, "action": "label": "Workload expiration extend", "id": "DEPLOMENT_EXPIRATION_EXTEND" "enabled": false, "action": "label": "Virtual server detach storage request", "id": "STORAGE_DETACH_REQUEST" "enabled": false, "action": "label": "Virtual server attach storage request", "id": "STORAGE_ATTACH_REQUEST" "enabled": false, "action": "label": "Virtual server restore", "id": "VIRTUAL_SERVER_RESTORE_BACKUP" "enabled": false, "action": "label": "Virtual server save image", "id": "VIRTUAL_SERVER_CREATE_BACKUP" "enabled": false, "action": "label": "Workload resize", "id": "DEPLOMENT_RESIZE" "enabled": false, "action": "label": "Workload initiation", "id": "DEPLOMENT_EXECUTION" Chapter 1. IBM Cloud Manager with OpenStack REST API reference 95

102 ] "enabled": false, "action": "label": "Workload capture", "id": "DEPLOMENT_SNAPSHOT" "uri": " "ownertype": "CLOUDGROUP", "ownerid": "551" "requesthandlers": [ "enabled": false, "action": "label": "Workload expiration extend", "id": "DEPLOMENT_EXPIRATION_EXTEND" "enabled": false, "action": "label": "Virtual server detach storage request", "id": "STORAGE_DETACH_REQUEST" "enabled": false, "action": "label": "Virtual server attach storage request", "id": "STORAGE_ATTACH_REQUEST" "enabled": false, "action": "label": "Virtual server restore", "id": "VIRTUAL_SERVER_RESTORE_BACKUP" "enabled": false, "action": "label": "Virtual server save image", "id": "VIRTUAL_SERVER_CREATE_BACKUP" "enabled": false, "action": "label": "Workload resize", "id": "DEPLOMENT_RESIZE" "enabled": false, "action": "label": "Workload initiation", "id": "DEPLOMENT_EXECUTION" "enabled": false, "action": "label": "Workload capture", "id": "DEPLOMENT_SNAPSHOT" "uri": " "ownertype": "PROJECT", "ownerid": "1" 96 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

103 PUT /requests/handlers This service updates the handler enablement state within a specific owner scope. N/A Update the request handler called "DEPLOMENT_EXECUTION" for "CLOUDGROUP" 551 and handler "DEPLOMENT_EXPIRATION_EXTEND" for "PROJECT" 1. PUT HTTP Request Body: [ ] "requesthandlers": [ "enabled": true, "action": "DEPLOMENT_EXECUTION" "ownertype": "CLOUDGROUP", "ownerid": "551" "requesthandlers": [ "enabled": true, "action": "DEPLOMENT_EXPIRATION_EXTEND" "ownertype": "PROJECT", "ownerid": "1" HTTP Response Body: None GET /requests/requestcsv Exports requests, that are filtered by parameters, to file and saves it on a server architecture directory. Chapter 1. IBM Cloud Manager with OpenStack REST API reference 97

104 Name Description Default Required starttime Timestamp that specifies a starting timeframe for requests returned. Requests that occur before this timestamp will not be returned. The starttime and endtime can be used together to specify a timeframe for the requests returned. This value is a timestamp that is the number of milliseconds since January 1, 1970, 00:00:00 GMT. 0 No endtime state Timestamp that specifies an ending timeframe for requests returned. Requests that occur after this timestamp will not be returned. The starttime and endtime can be used together to specify a timeframe for the requests returned. This value is a timestamp that is the number of milliseconds since January 1, 1970, 00:00:00 GMT. The request s state can be PENDING, APPROVED, REJECTED, WITHDRAWN or some combination. A comma is used to concatenate them. es es GET &endtime= &state=approved,rejected if successful DELETE /requests/requstcsv Deletes requests that are filtered by parameters. 98 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

105 Name Description Default Required starttime endtime state Timestamp that specifies a starting timeframe for deletion requests. Requests that occur before this timestamp will not be deleted. The starttime and endtime can be used together to specify a timeframe for deleting the requests. This value is a timestamp that is the number of milliseconds since January 1, 1970, 00:00:00 GMT. Timestamp that specifies an ending timeframe for deletion requests. Requests that occur after this timestamp will not be deleted. The starttime and endtime can be used together to specify a timeframe for deleting the requests. This value is a timestamp that is the number of milliseconds since January 1, 1970, 00:00:00 GMT. The request s state can be PENDING, APPROVED, REJECTED, WITHDRAWN or some combination. A comma is used to concatenate them. 0 No es es DELETE &endtime= &state=approved,rejected if successful Statistics resource services The IBM Cloud Manager with OpenStack product provides the following services for gathering statistics. Related information: Code license and disclaimer information on page 205 GET /stats/free This service retrieves the statistics of all available resources in the cloud, such as CPU, memory, and storage. Chapter 1. IBM Cloud Manager with OpenStack REST API reference 99

106 The CPU statistic is measured in cores. Memory and storage are measured in Megabytes. v cloudid (optional) If you include a cloudid in the request URL, the service returns the free resource statistics for the single cloud identified. If you do not specify a cloudid, the service returns the free resource statistics for multiple clouds. Retrieve all available resources from cloud GET No HTTP body required. HTTP Response Body: uri: stats: [ architecture: "Power" resources: [ value: "24.0" label: "Processors" id: "freecpu" value: " " label: "Memory" id: "freememory" value: "13645" label: "Storage" id: "freedisk" architecture: "x86" resources: [ value: "24.0" label: "Processors" id: "freecpu" value: " " label: "Memory" id: "freememory" value: "13645" label: "Storage" id: "freedisk" 100 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

107 ] ] GET /stats/totals This service retrieves the statistics of all resources in the cloud, such as CPU, memory, and storage. The CPU statistic is measured in cores. Memory and storage are measured in Megabytes. v cloudid (optional) If you include a cloudid in the request URL, the service returns the resource statistics for the single cloud identified. If you do not specify a cloudid, the service returns the resource statistics for multiple clouds. Retrieve all available resources from the cloud GET No HTTP body required. HTTP Response Body: uri: stats: [ architecture: "Power" resources: [ value: "24.0" label: "Processors" id: "totalcpu" value: " " label: "Memory" id: "totalmemory" value: "13645" label: "Storage" id: "totaldisk" architecture: "x86" resources: [ value: "24.0" label: "Processors" id: "totalcpu" value: " " Chapter 1. IBM Cloud Manager with OpenStack REST API reference 101

108 ] ] label: "Memory" id: "totalmemory" value: "13645" label: "Storage" id: "totaldisk" GET /stats/usage This service retrieves usage resource statistics in the cloud, such as CPU, memory, and storage. The CPU statistic is measured in cores. Memory and storage are measured in Megabytes. Name Description Default Required user Get the statistic summary of resource usage by specified user. N/A No cloudid If you include a cloudid in the request URL, the service returns the usage resource statistics for the single cloud identified. If you do not specify a cloudid, the service returns the usage resource statistics for multiple clouds. N/A No 1 Retrieve all resources usage statistics from the cloud GET No HTTP body required. 1 HTTP Response Body: uri: stats: [ architecture:"power" resources: [ value:"24.0" label:"processors" id:"usagecpu" 102 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

109 ] value:" " label:"memory" id:"usagememory" value:"13645" label:"storage" id:"usagedisk" architecture:"x86" resources: [ value:"24.0" label:"processors" id:"usagecpu" value:" " label:"memory" id:"usagememory" value:"13645" label:"storage" id:"usagedisk" ] 2 Retrieve resources usage by admin GET No HTTP body required. 2 HTTP Response Body: uri: stats: [ architecture:"power" resources: [ value:"24.0" label:"processors" id:"usagecpu" value:" " label:"memory" id:"usagememory" value:"13645" label:"storage" id:"usagedisk" Chapter 1. IBM Cloud Manager with OpenStack REST API reference 103

110 ] architecture:"x86" resources: [ value:"24.0" label:"processors" id:"usagecpu" value:" " label:"memory" id:"usagememory" value:"13645" label:"storage" id:"usagedisk" ] User services The IBM Cloud Manager with OpenStack product provides the following services for managing the user registry. Related information: Code license and disclaimer information on page 205 GET /users This service retrieves all known users from the IBM SmartCloud Entry user registry. A IBM Cloud Manager with OpenStack Administrator user ('admin') is created by default and will always exist. A client can also use this service to retrieve a list of users with admin authority by using the admin query parameter. Note that a user's password is not returned in the response JSON. Name Description Default Required admin The users retrieved should have admin access. false No Retrieve a listing of all users in the IBM SmartCloud Entry user registry. GET No HTTP body required. HTTP Response Body: "users": [ " notifications": false, 104 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

111 ] "username": "admin", " ": "", "isapprover": true, "name": "Cloud Administrator", "role": "id": "ADMIN", "label": "label" "isadmin": true, "uri": " "islocked": false " notifications": false, "username": "test", "isapprover": false, "name": "test", "role": "id": "USER", "label": "label" "isadmin": false, "uri": " "islocked": false " notifications": false, "username": "xinzhan", "isapprover": false, "name": "xinzhan", "role": "id": "USER", "label": "label" "isadmin": false, "uri": " "islocked": false " notifications": false, "username": "zxx", "isapprover": false, "name": "zxx", "role": "id": "USER", "label": "label" "isadmin": false, "uri": " "islocked": false GET /users/username This service retrieves the properties for a specific user from the IBM Cloud Manager with OpenStack user registry. If a user has admin authority, the "isadmin" and "issceadmin" attributes will be set to "true". The password of users is not returned in the response JSON. N/A GET No HTTP body required. Chapter 1. IBM Cloud Manager with OpenStack REST API reference 105

112 1 HTTP Response Body: " notifications": false, "username": "admin", " ": "", "isapprover": true, "name": "Cloud Administrator", "role": "id": "ADMIN", "label": "label" "isadmin": true, "uri": " "islocked": false POST /users This service adds a user to the IBM Cloud Manager with OpenStack user registry. Note: This API applies only when the IBM Cloud Manager with OpenStack server is using the local authentication scheme. If your server is configured to use LDAP authentication, you get an error if you use this API. For more information about authentication schemes, see the IBM Cloud Manager with OpenStack Administrator Guide. A user can be added to the registry in one of two ways. v Use the POST /users service to add a user to the registry. v If a user is authenticated successfully with the /auth service, IBM Cloud Manager with OpenStack adds the authenticated user to the registry if the user does not exist. The password is not returned in the response JavaScript Object Notation (JSON). This is an admin web service. N/A Add the user [email protected] to the user registry. POST HTTP Request Body: "username":"[email protected]", "password":"fun4csk", "isadmin":false, "isapprover":true, " notifications":true, " ":"[email protected]", "name":"john Doe", "timezone": "id": "America/Chicago" 106 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

113 "locale": "id": "en-us" HTTP Status: 201 HTTP Response Body: "isadmin":false, "islocked":false, "timezone": "label":"central Standard Time", "id":"america/chicago" "locale": "label":"english (United States)", "id":"en-us" "name":"john Doe", " notifications":true, "uri":" PUT /users/username This service enables updating of an existing user in the IBM Cloud Manager with OpenStack user registry. This service does not allow you to update the username associated with an existing user in the registry. If the username needs to be updated, the caller should first DELETE the user, and then use POST to create it with the new username. The PUT/users/username service does not allow you to update the default IBM Cloud Manager with OpenStack administrator user admin. After registering, a user can update the password in the service. This is an admin Web service. N/A Update user [email protected] to have password set to new2pass and name to be Mr John Doe PUT "username":"[email protected]", "name":"mr John Doe", "isadmin":false, "isapprover":true, "islocked":false, "password":"new2pass", "oldpassword":"old2pass", "timezone": "id": "America/Chicago" Chapter 1. IBM Cloud Manager with OpenStack REST API reference 107

114 "locale": "id": "en-us" DELETE /users/username This service removes an existing user from the IBM Cloud Manager with OpenStack user registry. If the specified user does not exist in the IBM Cloud Manager with OpenStack user registry, a 404 response status is returned. Note that the default IBM Cloud Manager with OpenStack administrator user ('admin') cannot be deleted. If the specified user is the current authenticated user, a 202 response status is returned and a deletion request is created. After the approval of the IBM Cloud Manager with OpenStack administrator, the user is deleted. Note: Users (without admin authority) only can request to delete themselves. N/A Remove the user [email protected] from the user registry. DELETE When the administrator deletes other users,. When users request to delete themselves, HTTP Status: 202. Virtual server services The IBM Cloud Manager with OpenStack product provides the following services for managing virtual servers. Related information: Code license and disclaimer information on page 205 GET /workloads/id/virtualservers This service retrieves all the virtual servers within a workload by ID. Workloads that have been executed and were successful will have virtual servers associated with them. Draft or failed workloads will return an empty array. N/A 108 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

115 Get virtual servers for workload with ID 1: GET HTTP Response Body: "virtualservers": [ "cloudid": "cloud://352/e7e213c5-4c6f-416b-9642-baa5ae6549cc", "credentialsuri": " "state": "label": "Running", "id": "RUNNING" "backups": " "hostname": "testhost235", "storagesuri": " "capabilities": [ "isenabled": true, "id": "CREATE_DISK" "isenabled": false, "id": "ATTACH_DISK" "isenabled": true, "id": "DETACH_DISK" "isenabled": true, "id": "THIN_PROVISIONED" "isenabled": true, "id": "POWER_MANAGEMENT" "isenabled": true, "id": "CAPTURE" "isenabled": true, "id": "BACKUP" "isenabled": false, "id": "SUSPEND_CAPABLE" "isenabled": true, "id": "RESIZE" "isenabled": false, "id": "PIN" "isenabled": false, "id": "UNPIN" "ip": " ", "id": "73555", Chapter 1. IBM Cloud Manager with OpenStack REST API reference 109

116 ] "uri": " GET /workloads/id/virtualservers/id This service retrieves a virtual server from the virtual servers in a workload by ID. If a virtual server by the given ID doesn't exist in the workload, the service will return a 404. N/A Get virtual server with ID 2 from workload with ID 1: GET HTTP Response Body: "cloudid": "cloud://352/e7e213c5-4c6f-416b-9642-baa5ae6549cc", "credentialsuri": " "state": "label": "Running", "id": "RUNNING" "backups": " "properties": [ "value": "1024", "description": "Memory (MB)", "category": "General Information" "value": "RHEL6_Template :41:05 test_ly_by_testuser", "description": "Name", "category": "General Information" "value": "1", "description": "CPUs", "category": "General Information" "value": "1", "description": "Number of Ethernet Cards", "category": "General Information" "value": "e7e213c5-4c6f-416b-9642-baa5ae6549cc", "description": "UUID", "category": "General Information" "value": "linuxguest", "description": "Guest Operating System", "category": "General Information" "value": "rhel5_64guest", "description": "Guest ID", "category": "General Information" 110 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

117 "value": "testhost235", "description": "Guest Hostname", "category": "General Information" "value": " ", "description": "Guest IP Addresses", "category": "General Information" "value": "vm-2858", "description": "ID", "category": "General Information" "value": "Connected", "description": "Connection State", "category": "General Information" "value": "host-875", "description": "Host", "category": "General Information" "value": "Powered On", "description": "Power State", "category": "General Information" "hostname": "testhost235", "storagesuri": " "capabilities": [ "isenabled": true, "id": "CREATE_DISK" "isenabled": false, "id": "ATTACH_DISK" "isenabled": true, "id": "DETACH_DISK" "isenabled": true, "id": "THIN_PROVISIONED" "isenabled": true, "id": "POWER_MANAGEMENT" "isenabled": true, "id": "CAPTURE" "isenabled": true, "id": "BACKUP" "isenabled": false, "id": "SUSPEND_CAPABLE" "isenabled": true, "id": "RESIZE" "isenabled": false, "id": "PIN" "isenabled": false, "id": "UNPIN" Chapter 1. IBM Cloud Manager with OpenStack REST API reference 111

118 "ip": " ", "id": "73555", "uri": " GET /workloads/id/virtualservers/id/credentials This service retrieves the credentials associated with the given Virtual Server Id. These credentials are used during the capture process in order to perform the required access to capture. Note that the 'authenticated' attribute is not used for this particular service and so it can be ignored. N/A Get VS with ID 2 credentials from workload with ID 1. GET HTTP Response Body: "uri":" "user":"root", "pass":"not2pass" PUT /workloads/id/virtualservers/id/credentials This service updates the credentials associated with the given virtual server ID and workload ID. These credentials are used during the capture process in order to perform the required access to capture. This service does not update any credentials on the configured cloud. N/A Update VS with ID 2 credentials from workload with ID 1. PUT "user":"root", "password":"not2pass" 112 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

119 GET /virtualservers This service retrieves all the virtual servers in all workloads that are available to the requesting user. N/A Get virtual servers for workload with ID 1: GET HTTP Response Body: "virtualservers": [ "cloudid": "cloud://352/422e e-0af4-f3f7-603e5ff35c5f", "credentialsuri": " "state": "label": "Unknown", "id": "UNKNOWN" "backups": " "storagesuri": " "capabilities": [ "isenabled": false, "id": "CREATE_DISK" "isenabled": false, "id": "ATTACH_DISK" "isenabled": false, "id": "DETACH_DISK" "isenabled": false, "id": "THIN_PROVISIONED" "isenabled": false, "id": "POWER_MANAGEMENT" "isenabled": false, "id": "CAPTURE" "isenabled": false, "id": "BACKUP" "isenabled": false, "id": "SUSPEND_CAPABLE" "isenabled": false, "id": "RESIZE" "isenabled": false, "id": "PIN" Chapter 1. IBM Cloud Manager with OpenStack REST API reference 113

120 ] "isenabled": false, "id": "UNPIN" "ip": "", "id": "3957", "uri": " "cloudid": "cloud://352/422e0b45-fb4a af-c6d0be945fb5", "credentialsuri": " "state": "label": "Running", "id": "RUNNING" "backups": " "hostname": "CCS-hgq", "storagesuri": " "capabilities": [ "isenabled": true, "id": "CREATE_DISK" "isenabled": false, "id": "ATTACH_DISK" "isenabled": true, "id": "DETACH_DISK" "isenabled": true, "id": "THIN_PROVISIONED" "isenabled": true, "id": "POWER_MANAGEMENT" "isenabled": true, "id": "CAPTURE" "isenabled": true, "id": "BACKUP" "isenabled": false, "id": "SUSPEND_CAPABLE" "isenabled": true, "id": "RESIZE" "isenabled": false, "id": "PIN" "isenabled": false, "id": "UNPIN" "ip": " , ", "id": "3959", "uri": " GET /virtualservers/id This service retrieves a virtual server. 114 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

121 N/A Get virtual servers for workload with ID 1: GET HTTP Response Body: "cloudid": "cloud://551/40052", "credentialsuri": " "state": "label": "Running", "id": "RUNNING" "backups": " "properties": [ "value": "true", "id": "Encapsulated", "description": "Encapsulated:", "category": "General Information" "value": "TRUE", "id": "Memory.ChangeableType", "description": "Dynamic memory change capable:", "category": "Memory" "value": "1024", "id": "Memory.VirtualLimit", "description": "Maximum memory size (MB):", "category": "Memory" "value": "1024", "id": "Memory.VirtualMinimum", "description": "Minimum memory size (MB):", "category": "Memory" "value": "1024", "id": "Memory.VirtualQuantity", "description": "Assigned memory size (MB):", "category": "Memory" "value": "kaiqiang-no-delete", "id": "Name", "description": "Name:", "category": "General Information" "value": "40052", "id": "Oid", "description": "Cloud object ID:", "category": "General Information" "value": "TRUE", "id": "Processor.ChangeableType", "description": "Dynamic processor change capable:", "category": "Processor" Chapter 1. IBM Cloud Manager with OpenStack REST API reference 115

122 "value": "Shared", "id": "Processor.ConsumerVisibility", "description": "Processing mode:", "category": "Processor" "value": "0.1", "id": "Processor.Limit", "description": "Maximum processing units:", "category": "Processor" "value": "0.1", "id": "Processor.Minimum", "description": "Minimum processing units:", "category": "Processor" "value": "System", "id": "Processor.PoolID", "description": "Shared processor pool:", "category": "Processor" "value": "0.1", "id": "Processor.Reservation", "description": "Assigned processing units:", "category": "Processor" "value": "1", "id": "Processor.VirtualLimit", "description": "Maximum processors:", "category": "Processor" "value": "1", "id": "Processor.VirtualMinimum", "description": "Minimum processors:", "category": "Processor" "value": "1", "id": "Processor.VirtualQuantity", "description": "Assigned processors:", "category": "Processor" "value": "Medium(128)", "id": "Processor.Weight", "description": "Assigned share priority:", "category": "Processor" "value": "Started", "id": "State", "description": "State:", "category": "General Information" "value": "HMC", "id": "Vendorinfo.ResourceType", "description": "Host type:", "category": "Vendor Information" "value": "FALSE", "id": "Vendorinfo.VIOS", "description": "Utility virtual server:", "category": "Vendor Information" "value": "AIX or Linux", "id": "Vendorinfo.VirtualSystemType", "description": "Environment:", "category": "Vendor Information" 116 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

123 "hostname": "kaiqiang-no-delete", "storagesuri": " "capabilities": [ "isenabled": true, "id": "CREATE_DISK" "isenabled": false, "id": "ATTACH_DISK" "isenabled": false, "id": "DETACH_DISK" "isenabled": false, "id": "THIN_PROVISIONED" "isenabled": true, "id": "POWER_MANAGEMENT" "isenabled": true, "id": "CAPTURE" "isenabled": true, "id": "BACKUP" "isenabled": false, "id": "SUSPEND_CAPABLE" "isenabled": true, "id": "RESIZE" "isenabled": false, "id": "PIN" "isenabled": false, "id": "UNPIN" "ip": "", "id": "651", "uri": " PUT /virtualservers/id This service migrates the virtual server to a target host. This service migrates the virtual server to the host that is automatically selected by OpenStack. N/A 1 Migrate the virtual server to the host "samplehost" PUT HTTP Request Body: Chapter 1. IBM Cloud Manager with OpenStack REST API reference 117

124 state : MIGRATING, target : cloud://301/ HTTP Status: 201 Created HTTP Response Body: empty 2 Migrate the virtual server to the host, which is selected by the OpenStack automatically. PUT HTTP Request Body: state : MIGRATING, 2 HTTP Status: 201 Created HTTP Response Body: empty GET /virtualservers/id/log This service retrieves the console logs for a virtual server by ID. The console logs show the virtual server console output. It can provide information about how the virtual server executes. These logs, come directly from the Cloud. Note: Virtual server console logs are currently only obtained from an OpenStack cloud. N/A Get the console log for virtual server 1601 GET The following is an incomplete response shown as an example: HTTP Response Body: "log":"[ ] Initializing cgroup subsys cpu [ ] Linux version virtual (buildd@crested) (gcc version (Ubuntu/Linaro ubuntu3) ) #20Ubuntu SMP Fri Oct 7 18:19:02 UTC 2011 (Ubuntu virtual 3.0.4) 118 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

125 [ ] Command line: LABEL=cirrosrootfs ro console=tty0 console=ttys0 console=hvc0 [ ] KERNEL supported cpus: [ ] Intel GenuineIntel [ ] AMD AuthenticAMD [ ] Centaur CentaurHauls [ ] Disabled fast string operations [ ] BIOSprovided physical RAM map: [ ] BIOSe820: dc00 (usable) [ ] BIOSe820: dc a0000 (reserved) [ ] BIOSe820: f (reserved) [ ] BIOSe820: fffd000 (usable) [ ] BIOSe820: fffd (reserved) [ ] BIOSe820: fffbc (reserved)" GET /virtualservers/id/storages This service retrieves all the storage volumes attached to the virtual server. N/A Get virtual servers for workload with ID 1. GET HTTP Response Body: "storages":[ "size":0, "id":"1313", "name":"unknown Storage", "uri":" "size":12, "id":"1314", "name":"nate", "uri":" ] GET /virtualservers/id/storages/id This service retrieves a storage volume from the list of all storage volumes attached to the virtual server. N/A Get virtual servers for workload with ID 1. GET Note: The thinprovisioned attribute is returned only for VMware cloud. Chapter 1. IBM Cloud Manager with OpenStack REST API reference 119

126 HTTP Response Body: "size":12, "thinprovisioned":true, "id":"1314", "name":"nate", "uri":" POST /virtualservers/id/storages This service adds or attaches a storage volume to the virtual server. N/A 1 Add the thin provisioned storage volume 'MyDisk' of size 1024 MB (1 GB) to the virtual server. Specially, if the virtual machine belongs to VMware cloud, IBM Cloud Manager with OpenStack will choose the datastore in which the main disk of the VM is located to create the storage volume. However, if the datastore does not have enough free space to create it, IBM Cloud Manager with OpenStack will retrieve available datastores for this VM and choose the first available datastore to create a storage volume. Note: The thinprovisioned attribute is valid only for VMware cloud). POST HTTP Request Body: "name":"mydisk", "size":1024, "thinprovisioned":"true", 1 HTTP Status: 201 Created HTTP Response Body: empty 120 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

127 2 Add the thin provisioned storage volume 'MyDisk' of size 1024 MB (1 GB) to the virtual Server with specified datastore 'MyDataStore' (available only for VMware cloud). The storage volume is created in the datastore specified by the user in the request. POST HTTP Request Body: "name":"mydisk", "size":1024, "thinprovisioned":"true", "datastore":"mydatastore" 2 HTTP Status: 201 Created HTTP Response Body: empty 3 Attach the storage volume 'MyDisk' to the virtual Server with specified datastore 'MyDataStore' and path '/mydisk.vmdk' (available only for VMware cloud). POST HTTP Request Body: "name": "MyDisk", "datastore": "MyDataStore" "Path": "/mydisk.vmdk" 3 HTTP Status: 201 Created HTTP Response Body: empty DELETE /virtualservers/id/storages/id This service removes a storage volume from the virtual server. Note: The parameter detachonly can be used with this API. If it is set to true, the storage being detached will not be destroyed, otherwise, the storage being detached will be destroyed after detach action is done. N/A Chapter 1. IBM Cloud Manager with OpenStack REST API reference 121

128 Delete the storage volume with id '301' from the virtual Server. DELETE HTTP Request Body: Deleted HTTP Response Body: empty GET /virtualservers/id/networks This service retrieves all the networks attached to the virtual server. N/A Get networks for virtual servers with ID 101. GET HTTP Response Body: "networks":[ "name":"default IP Address Pool", "id":"1", "dns1": "value":" ", "label":"dns 1" "dns2": "value":" ", "label":"dns 2" "gateway1": "value":" ", "label":"gateway address" "gateway2": "value":" ", "label":"alternative gateway address" "domain": "value":"rchland.ibm.com", "label":"domain name" "domainsuffixes": "value":"ibm.com,cn.ibm.com", "label":"domain suffix search list" "subnet": 122 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

129 "value":" ", "label":"subnet mask" "networkid": "value":"123", "label":"network ID" "usedhcp": "value":true, "label":"use DHCP" "wins1": "value":" ", "label":"primary WINS address" "wins2": "value":" ", "label":"secondary WINS address" "ipaddress": "value":" ", "label":"ip address" "hostname": "value":"hostname1", "label":"host name" "computername": "value":"skc", "label":"computer name" "workgroup": "value":"group", "label":"workgroup" "name":"ip Address Pool1", "id":"1", "dns1": "value":" ", "label":"dns 1" "dns2": "value":" ", "label":"dns 2" "gateway1": "value":" ", "label":"gateway address" "gateway2": "value":" ", "label":"alternative gateway address" "domain": "value":"rchland.ibm.com", "label":"domain name" "domainsuffixes": Chapter 1. IBM Cloud Manager with OpenStack REST API reference 123

130 ] "value":"ibm.com,cn.ibm.com", "label":"domain suffix search list" "subnet": "value":" ", "label":"subnet mask" "networkid": "value":"123", "label":"network ID" "usedhcp": "value":true, "label":"use DHCP" "wins1": "value":" ", "label":"primary WINS address" "wins2": "value":" ", "label":"secondary WINS address" "ipaddress": "value":" ", "label":"ip address" "hostname": "value":"hostname1", "label":"host name" "computername": "value":"skc1", "label":"computer name" "workgroup": "value":"group2", "label":"workgroup" GET /virtualservers/id/networks/id This service retrieves a network attached to the virtual server. N/A Get networks with ID 202 for virtual servers with ID 101. GET IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

131 HTTP Response Body: "name":"default IP Address Pool", "id":"1", "dns1": "value":" ", "label":"dns 1" "dns2": "value":" ", "label":"dns 2" "gateway1": "value":" ", "label":"gateway address" "gateway2": "value":" ", "label":"alternative gateway address" "domain": "value":"rchland.ibm.com", "label":"domain name" "domainsuffixes": "value":"ibm.com,cn.ibm.com", "label":"domain suffix search list" "subnet": "value":" ", "label":"subnet mask" "networkid": "value":"123", "label":"network ID" "usedhcp": "value":true, "label":"use DHCP" "wins1": "value":" ", "label":"primary WINS address" "wins2": "value":" ", "label":"secondary WINS address" "ipaddress": "value":" ", "label":"ip address" "hostname": "value":"hostname1", "label":"host name" "computername": "value":"skc", Chapter 1. IBM Cloud Manager with OpenStack REST API reference 125

132 "label":"computer name" "workgroup": "value":"group", "label":"workgroup" GET /virtualservers/id/backups This service retrieves all saved server images associated with a virtual server. N/A Get saved server images for virtual server with the id 203. GET HTTP Response Body: "backups":[ "id":"505", "name":"os installed", "description":"rhel 5.5 installed, not configured", "uri":" "creationdate": "id":"506", "name":"after xyz was installed", "description":"", "uri":" "creationdate": ] GET /virtualservers/id/backups/id This service retrieves a specific saved server image associated with a virtual server. N/A Get saved server image with the id 505 for virtual server with the id 203. GET IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

133 HTTP Response Body: "id":"505", "name":"os installed", "description":"rhel 5.5 installed, not configured", "uri":" "creationdate": POST /virtualservers/id/backups This service creates a new saved server image for the virtual server. Note: This API cannot be used to backup an OpenStack PowerVM instance. N/A Create a new saved server image for virtual server with the id 203. POST "name" : "name for saved server image", "description" : "description of image" HTTP Status: 201 Created Response Body: empty PUT /virtualservers/id/backups/id This service restores the virtual server using the specified saved server image. Note: If this API is called to restore an OpenStack PowerVM instance by using a saved server image, an error message that this service is not supported appears. N/A Restore the virtual server with the id 203 using the saved server image with the id 505. PUT "state": "RESTORING" Chapter 1. IBM Cloud Manager with OpenStack REST API reference 127

134 OK Response Body: empty DELETE /virtualservers/id/backups/id This service deletes the specified saved server image associated with a virtual server. N/A Delete saved server image with the id 505 for virtual server with the ID 203. DELETE OK Response Body: empty GET /virtualservers/id/repositories This service retrieves all valid repositories that can be used to capture the virtual server. N/A Get valid image repositories for virtual server with ID 203. GET HTTP Response Body: "total": "1", "repositories": [ "cloudid": "11632", "name": "image_repository" "identifier": "cloudid" 128 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

135 GET /virtualservers/id/repositories/id/customization This service retrieves customization that is associated with the virtual server and the image repository. The customization includes the information that is needed to capture the virtual server to the image repository. N/A Get customization for virtual server with ID 203 and image repository with ID 102. GET HTTP Response Body: "properties": [ "values": [ "type": "SINGLE_SELECTION", "name": "ostypecapture", "description": "Specify OS Type for capture", "basic": false, "options": [ "value": "Linux", "id": "36" "value": "AIX", "id": "9" "required": false "appliance": "name": "Unknown" "instances": 1 Workload services IBM Cloud Manager with OpenStack provides the workload services listed here. Related information: Code license and disclaimer information on page 205 GET /workloads This service retrieves a list with the summary of all the known workloads available in the cloud. Chapter 1. IBM Cloud Manager with OpenStack REST API reference 129

136 Name Description Default Required user Gets the list of workloads N/A No for the specified user. includehidden Specifies whether returned workloads should include hidden workloads. false No owner start count architecture cloudgroupid Filters the list of workloads by the specified owner. The index of the first records to return. The number of records to return. Filters the list of workloads by the specified platform architecture. Filters the list of workloads by the specified cloudgroupid. * No 0 No 0 No * No * No Get all known workloads: GET HTTP Response Body: "total": "44", "workloads": [ "cloudname": "host122-win2k3_host_2_10", "cloudgroupid": "352", "name": "host122-win2k3_host_2_10", "uri": " "cloudid": "cloud://352/422ea1c0-d1ae-961e-095d-3b96ba3b1601", "state": "label": "Unknown", "id": "UNKNOWN" "projecturi": " "architecture": "x86", "ishidden": false, "cloudgroupname": "VMware-120", "hypervisor": "VMware", "id": "60351", "description": "Workload could no longer be found in the Cloud. It could have been purposely deleted from the Cloud." "cloudname": "DHCP&DNS(inner)_RHEL61_64Bit_hgq(Not Delete)", "cloudgroupid": "352", "name": "DHCP&DNS(inner)_RHEL61_64Bit_hgq(Not Delete)", "uri": " "cloudid": "cloud://352/422ed793-b6cb-46a7-53e7-59d39d66d322", "state": 130 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

137 ] "label": "OK", "id": "OK" "projecturi": " "architecture": "x86", "ishidden": false, "cloudgroupname": "VMware-120", "hypervisor": "VMware", "id": "37452", "description": "Workload could no longer be found in the Cloud. It could have been purposely deleted from the Cloud." POST /workloads This service creates a new workload. Creating a workload does not mean executing it. When a workload is created it means that a workload is prepared for its eventual execution given the current resources in the cloud. A workload has name, description, a project it belongs to and specific workload properties specific to the base appliance. The workload properties are contained in what we call a customization. Creating a workload requires a base appliance and in that case the appliance ID is required; it is also possible to create a workload from an existing workload, or recreating a workload, in that case the base workload ID is required. Important: After you create a workload, the workload will not automatically appear in the IBM Cloud Manager with OpenStack graphical user interface. The workload will also not appear in any workload lists returned by APIs. In order for the workload to appear in the graphical user interface and in lists returned by APIs, you must use the PUT /workloads/id on page 157 service to execute the workload. All workloads created under IBM Cloud Manager with OpenStack need to be associated to a project. Workloads have a visibility attribute that determined whether the workload can only be seen by the members of the project, or also by any IBM Cloud Manager with OpenStack user. The default visibility is PROJECT. N/A s 1. Create a new workload for appliance ID 133. POST "appliance": Create a new workload from an existing workload with ID 156. POST workload from an existing workload with ID 156. " "workload":156 HTTP Status: 201 HTTP Location Header: The URI of the new workload Chapter 1. IBM Cloud Manager with OpenStack REST API reference 131

138 HTTP Body: The customization to avoid back and forth requests to the server. The returned customization not only contains the customization properties from the managed clouds, but also the IBM Cloud Manager with OpenStack core generated properties that are named storagemapping-n, which stands for the storage mapping for each disk. The values field is the default value that is recommended by the IBM Cloud Manager with OpenStack core. ou can also complete the values field to specify a mapping to a specific storage pool for this disk. "target": "cloud://352/host-875", "properties": [ "values": [ "1" "classification": "label": "Network", "id": "NETWORK" "valueorigin": [ "1" "subtype": "HOST_NAME", "type": "STRING", "valuefrom": "ipaddress", "name": "linux.hostname", "description": "Host name", "category": "TCP/IP Network Settings ", "basic": true, "required": false "values": [ "1" "classification": "label": "Network", "id": "NETWORK" "valueorigin": [ "1" "subtype": "DOMAIN_NAME", "type": "STRING", "valuefrom": "domain", "name": "linux.domainname", "description": "Domain name", "category": "TCP/IP Network Settings ", "basic": true, "required": true "values": [ "1" "classification": "label": "Network", "id": "NETWORK" "valueorigin": [ "1" "subtype": "IPV4_ADDRESS", "type": "STRING", "valuefrom": "dns1", "name": "linux.dns1", "description": "Primary DNS", "category": "TCP/IP Network Settings ", "basic": false, "required": false "values": [ "1" "classification": "label": "Network", "id": "NETWORK" 132 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

139 "valueorigin": [ "1" "subtype": "IPV4_ADDRESS", "type": "STRING", "valuefrom": "dns2", "name": "linux.dns2", "description": "Backup DNS", "category": "TCP/IP Network Settings ", "basic": false, "required": false "values": [ "1" "classification": "label": "Network", "id": "NETWORK" "valueorigin": [ "1" "subtype": "DOMAIN_NAMES", "type": "STRING", "valuefrom": "domainsuffixes", "name": "dnssuffixlist", "description": "Domain name server suffix list (comma separated)", "category": "TCP/IP Network Settings ", "basic": false, "required": false "values": [ 4345 "classification": "label": "Storage", "id": "STORAGE" "rules": [ "value": "1", "id": "increment" "value": "LINEAR", "id": "incrementtype" "value": " ", "id": "max" "value": "4345", "id": "min" "type": "LONG", "name": "DiskSize.Hard disk 1", "description": "Disk Size of Hard disk 1 (MB)", "category": "Storage Settings", "basic": false, "required": false "values": [ "skc.default.storage" "classification": "label": "Storage", "id": "STORAGE" "type": "SINGLE_SELECTION", "name": "target.storage", "description": "Target Storage", "category": "Storage Settings", "basic": false, Chapter 1. IBM Cloud Manager with OpenStack REST API reference 133

140 "options": [ "value": "Default", "id": "skc.default.storage" "value": "xblade_server_01_ds5020_disk", "id": "xblade_server_01_ds5020_disk" "required": false "values": [ 1024 "classification": "label": "Hardware", "id": "HARDWARE" "rules": [ "value": "4", "id": "increment" "value": "LINEAR", "id": "incrementtype" "value": "128", "id": "min" "type": "LONG", "name": "vmware.memory", "description": "Memory (MB)", "category": "Memory and CPU Settings", "basic": true, "required": false "values": [ 1 "classification": "label": "Hardware", "id": "HARDWARE" "rules": [ "value": "1", "id": "increment" "value": "LINEAR", "id": "incrementtype" "value": "12", "id": "max" "value": "1", "id": "min" "type": "LONG", "name": "vmware.cpu", "description": "Virtual CPUs", "category": "Memory and CPU Settings", "basic": true, "required": false "values": [ "VM Network" "classification": 134 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

141 "label": "Network", "id": "NETWORK" "valueorigin": [ "VM Network" "type": "SINGLE_SELECTION", "valuefrom": "networkid", "name": "networkdevice.network adapter 1.network", "description": "Network associated with Network adapter 1", "category": "Network adapter 1", "basic": false, "options": [ "value": "VM Network", "id": "VM Network" "group": "Adapter 1", "required": true "values": [ false "classification": "label": "Network", "id": "NETWORK" "valueorigin": [ false "subtype": "DHCP_FLAG", "type": "BOOLEAN", "valuefrom": "usedhcp", "name": "networkdevice.network adapter 1.usedhcp", "description": "Use DHCP for Network adapter 1", "category": "Network adapter 1", "basic": false, "group": "Adapter 1", "required": false "values": [ "1" "classification": "label": "Network", "id": "NETWORK" "valueorigin": [ "1" "subtype": "IPV4_ADDRESS", "type": "STRING", "valuefrom": "ipaddress", "name": "networkdevice.network adapter 1.ipaddress", "description": "IP address for Network adapter 1", "category": "Network adapter 1", "basic": false, "group": "Adapter 1", "required": true "values": [ "1" "classification": "label": "Network", "id": "NETWORK" "valueorigin": [ "1" "subtype": "IPV4_SUBNET_MASK", "type": "STRING", "valuefrom": "subnet", "name": "networkdevice.network adapter 1.netmask", "description": "Subnet mask for Network adapter 1", Chapter 1. IBM Cloud Manager with OpenStack REST API reference 135

142 "category": "Network adapter 1", "basic": false, "group": "Adapter 1", "required": true "values": [ "1" "classification": "label": "Network", "id": "NETWORK" "valueorigin": [ "1" "subtype": "IPV4_ADDRESS", "type": "STRING", "valuefrom": "gateway1", "name": "networkdevice.network adapter 1.gateway1", "description": "Default gateway for Network adapter 1", "category": "Network adapter 1", "basic": false, "group": "Adapter 1", "required": false "values": [ true "classification": "label": "Network", "id": "NETWORK" "valueorigin": [ true "subtype": "DNS_FLAG", "type": "BOOLEAN", "valuefrom": "obtainfromdns", "name": "obtainfromdns.network1", "description": "Obtain hostname and domain name from DNS server", "category": "Network adapter 1", "basic": false, "group": "Adapter 1", "required": false "id": "73512", "appliance": "name": "RHEL6_Template121", "uri": " ou can view the customization details in the GET /workloads/id/customization on page 137 API description. GET /workloads/id This service retrieves a workload by ID. If the workloads was created using IBM Cloud Manager with OpenStack, the returned workload will include a customization, otherwise it won't. Workloads may or may not include a virtual server associated with them, depending on whether the workload has already been attempted or is still in draft mode, and if the workload was attempted whether or not it was successful. N/A 136 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

143 Get workload with ID 1: GET HTTP Response Body: "cloudname": "RHEL6_Template :41:05 test_ly_by_testuser", "priority": 2, "cloudgroupid": "352", "executiondate": , "virtualserversuri": " "name": "RHEL6_Template :41:05 test_ly_by_testuser", "uri": " "timestampsuri": " "cloudid": "cloud://352/e7e213c5-4c6f-416b-9642-baa5ae6549cc", "state": "label": "OK", "id": "OK" "architecture": "x86", "projecturi": " "ishidden": false, "cloudgroupname": "VMware-120", "hypervisor": "VMware", "customizationuri": " "targeturi": " "id": "73508", "description": "RHEL6_Template :41:05 test_ly_by_testuser", "logsuri": " GET /workloads/id/customization This service retrieves customization for a workload by ID. A workload's customization includes the workload's virtualization properties used to execute this particular workload on the cloud. This service can also return the dynamic virtualization properties, which are the properties that can be used to modify this workload at runtime. ou can, for example, change the allotted CPU. Name Description Default Required dynamicproperties Return the dynamic virtualization properties for this workload. false No priority Return the priority property of this workload. false No To retrieve the customization for workload with ID 1 GET customization Chapter 1. IBM Cloud Manager with OpenStack REST API reference 137

144 "target":"cloud://default/6678", "properties":[ "values":[ "1" "rules":[ "value":"1", "id":"increment" "value":"linear", "id":"incrementtype" "value":"240.0", "id":"max" "value":"1.0", "id":"min" "type":"long", "name":"cpushared", "description":"the desired number of dedicated or virtual processors to be assigned to the virtual server.", "basic":false, "required":true "values":[ "1" "rules":[ "value":"1", "id":"increment" "value":"linear", "id":"incrementtype" "value":"128.0", "id":"max" "value":"1.0", "id":"min" "type":"long", "name":"cpudedicated", "description":"the desired number of dedicated or virtual processors to be assigned to the virtual server.", "basic":false, "required":true "values":[ "SHARED" "type":"single_selection", "name":"cpumode", "description":"indicates whether the virtual server will use physical or virtual processors (dedicated or shared mode).", "basic":false, "options":[ "value":"dedicated", "id":"dedicated" "value":"shared", 138 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

145 "id":"shared" "required":true "values":[ "512" "rules":[ "value":"256", "id":"increment" "value":"linear", "id":"incrementtype" "value":" ", "id":"max" "value":"256.0", "id":"min" "type":"long", "name":"memsize", "description":"the desired amount of memory (MB) to be assigned to the virtual server.", "basic":false, "required":true "values":[ false "type":"boolean", "name":"suspendresume", "description":"the virtual server can be suspended and resumed later.", "basic":false, "required":false "values":[ "2048" "rules":[ "value":"256", "id":"increment" "value":"linear", "id":"incrementtype" "value":" ", "id":"max" "value":"256.0", "id":"min" "type":"long", "name":"memmax", "description":"the maximum amount of memory (MB) that can be assigned to the virtual server.", "basic":false, "required":true "values":[ "512" "rules":[ "value":"256", "id":"increment" Chapter 1. IBM Cloud Manager with OpenStack REST API reference 139

146 "value":"linear", "id":"incrementtype" "value":" ", "id":"max" "value":"256.0", "id":"min" "type":"long", "name":"memmin", "description":"the minimum amount of memory (MB) that can be assigned to the virtual server.", "basic":false, "required":true "values":[ "1" "rules":[ "value":"1", "id":"increment" "value":"linear", "id":"incrementtype" "value":"240.0", "id":"max" "value":"1.0", "id":"min" "type":"long", "name":"cpushmin", "description":"the minimum number of dedicated or virtual processors that can be assigned to the virtual server.", "basic":false, "required":false "values":[ "0.1" "rules":[ "value":"0.1", "id":"increment" "value":"24.0", "id":"max" "value":"0.1", "id":"min" "type":"float", "name":"cpushminu", "description":"the minimum number of processing units that can be assigned to the virtual server.", "basic":false, "required":false "values":[ "0.1" "rules":[ "value":"0.1", 140 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

147 "id":"increment" "value":"24.0", "id":"max" "value":"0.1", "id":"min" "type":"float", "name":"cpushu", "description":"the desired number of processing units to be assigned to the virtual server.", "basic":false, "required":false "values":[ "1" "rules":[ "value":"1", "id":"increment" "value":"linear", "id":"incrementtype" "value":"240.0", "id":"max" "value":"1.0", "id":"min" "type":"long", "name":"cpushmax", "description":"the maximum number of dedicated or virtual processors that can be assigned to the virtual server.", "basic":false, "required":false "values":[ "1" "rules":[ "value":"0.1", "id":"increment" "value":"24.0", "id":"max" "value":"0.1", "id":"min" "type":"float", "name":"cpushmaxu", "description":"the maximum number of processing units that can be assigned to the virtual server.", "basic":false, "required":false "values":[ "UNCAP" "type":"single_selection", "name":"cpushmode", "description":"the processing units sharing mode of the virtual server.", "basic":false, "options":[ Chapter 1. IBM Cloud Manager with OpenStack REST API reference 141

148 "value":"capped", "id":"cap" "value":"uncapped", "id":"uncap" "required":false "values":[ "128" "rules":[ "value":"1", "id":"increment" "value":"linear", "id":"incrementtype" "value":"255.0", "id":"max" "value":"0.0", "id":"min" "type":"long", "name":"cpushpri", "description":"the priority of the virtual server to available processing units in the shared processor pool.", "basic":false, "required":false "values":[ "1" "rules":[ "value":"1", "id":"increment" "value":"linear", "id":"incrementtype" "value":"24.0", "id":"max" "value":"1.0", "id":"min" "type":"long", "name":"cpudedmin", "description":"the minimum number of dedicated or virtual processors that can be assigned to the virtual server.", "basic":false, "required":false "values":[ "1" "rules":[ "value":"1", "id":"increment" "value":"linear", "id":"incrementtype" 142 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

149 "value":"128.0", "id":"max" "value":"1.0", "id":"min" "type":"long", "name":"cpudedmax", "description":"the maximum number of dedicated or virtual processors that can be assigned to the virtual server.", "basic":false, "required":false "values": [ "2" "type": "SINGLE_SELECTION", "name": "priority", "description": "Workload Priority", "basic": false, "options": [ "value": "1 (High)", "id": "1" "value": "2 (Normal)", "id": "2" "value": "3 (Low)", "id": "3" "value": "4 (Lowest)", "id": "4" "required": false "values":[ " " "classification": "label":"network", "id":"network" "valueorigin": [ "1" "subtype":"host_name", "type":"string", "valuefrom": "hostnameprefix", "name":"product.aix1.com.ibm.ovf.vim.2.system.hostname", "description":"short hostname for the system.", "category":"tcp/ip Network Settings", "basic":false, "required":false "values":[ "icb.cloud.com" "valueorigin": [ "1" "classification": "label":"network", "id":"network" "subtype":"domain_name", "type":"string", "valuefrom": "domain", "name":"product.aix1.com.ibm.ovf.vim.2.system.domainname", "description":"dns domain name for the system.", Chapter 1. IBM Cloud Manager with OpenStack REST API reference 143

150 "category":"tcp/ip Network Settings", "basic":false, "required":false "values":[ " " "classification": "label":"network", "id":"network" "valueorigin": [ "1" "subtype":"ipv4_address", "type":"string", "valuefrom": "dns1", "name":"product.aix1.com.ibm.ovf.vim.2.system.dns1.ip", "description":"ip address of primary DNS server for system.", "category":"tcp/ip Network Settings", "basic":false, "required":false "values":[ " " "classification": "label":"network", "id":"network" "valueorigin": [ "1" "subtype":"ipv4_address", "type":"string", "valuefrom": "dns2", "name":"product.aix1.com.ibm.ovf.vim.2.system.dns2.ip", "description":"ip address of secondary DNS server for system.", "category":"tcp/ip Network Settings", "basic":false, "required":false "values":[ " " "classification": "label":"network", "id":"network" "valueorigin": [ "1" "subtype":"ipv4_address", "type":"string", "valuefrom": "ipaddress", "name":"product.aix1.com.ibm.ovf.vim.2.networkport.6.ip", "description":"static IP address for the network adapter on \"Network 1\".", "category":"tcp/ip Network Settings", "basic":false, "group":"adapter 1", "required":true "values":[ "false" "type":"string", "name":"product.aix1.com.ibm.ovf.vim.2.networkport.6.ipv6autoconf", "description":"use IPv6 stateless address autoconfiguration on \"Network 1\".", "category":"tcp/ip Network Settings", "basic":false, "required":false "values":[ " " 144 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

151 "classification": "label":"network", "id":"network" "valueorigin": [ "1" "subtype":"ipv4_address", "type":"string", "name":"product.aix1.com.ibm.ovf.vim.2.networkport.6.gateway", "description":"static default gateway for the network adapter on \"Network 1\".", "category":"tcp/ip Network Settings", "basic":false, "group":"adapter 1", "required":true "values":[ " " "classification": "label":"network", "id":"network" "valueorigin": [ "1" "subtype":"ipv4_subnet_mask", "type":"string", "valuefrom": "subnet", "name":"product.aix1.com.ibm.ovf.vim.2.networkport.6.netmask", "description":"static network mask for the network adapter on \"Network 1\".", "category":"tcp/ip Network Settings", "basic":false, "group":"adapter 1", "required":true "values":[ " " "classification": "label":"network", "id":"network" "valueorigin": [ "2" "subtype":"ipv4_address", "type":"string", "valuefrom": "ipaddress", "name":"product.aix1.com.ibm.ovf.vim.2.networkport.7.ip", "description":"static IP address for the network adapter on \"Network 2\".", "category":"tcp/ip Network Settings", "basic":false, "group":"adapter 2", "required":true "values":[ "false" "type":"string", "name":"product.aix1.com.ibm.ovf.vim.2.networkport.7.ipv6autoconf", "description":"use IPv6 stateless address autoconfiguration on \"Network 2\".", "category":"tcp/ip Network Settings", "basic":false, "required":false "values":[ " " "classification": "label":"network", "id":"network" "valueorigin": [ Chapter 1. IBM Cloud Manager with OpenStack REST API reference 145

152 "2" "subtype":"ipv4_address", "type":"string", "valuefrom": "gateway1", "name":"product.aix1.com.ibm.ovf.vim.2.networkport.7.gateway", "description":"static default gateway for the network adapter on \"Network 2\".", "category":"tcp/ip Network Settings", "basic":false, "group":"adapter 2", "required":true "values":[ " " "classification": "label":"network", "id":"network" "valueorigin": [ "2" "subtype":"ipv4_subnet_mask", "type":"string", "valuefrom": "subnet", "name":"product.aix1.com.ibm.ovf.vim.2.networkport.7.netmask", "description":"static network mask for the network adapter on \"Network 2\".", "category":"tcp/ip Network Settings", "basic":false, "group":"adapter 2", "required":true "values":[ "[Network 1]=hostVnet:ETHERNET0/1" "classification": "label":"network", "id":"network" "valueorigin": [ "1" "type":"single_selection", "valuefrom": "networkid", "name":"virtualnetworks-1", "description":" Network 1\"", "basic":false, "options":[ "values":[ "value":"network 1", "description":"network Name" "value":"captured from virtual server connected to VLAN 1 on host ICB-CPT1", "description":"description" "value":"vlan 1, Bridged", "description":"virtual Networks on Host" "id":"[network1]=hostvnet:ethernet0/1" "values":[ "value":"network 1", "description":"network Name" "value":"captured from virtual server connected to VLAN 1 on host ICB-CPT1", "description":"description" "value":"vlan 2, Bridged", 146 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

153 "description":"virtual Networks on Host" "id":"[network1]=hostvnet:ethernet0/2" "values":[ "value":"network 1", "description":"network Name" "value":"captured from virtual server connected to VLAN 1 on host ICB-CPT1", "description":"description" "value":"vlan 3, Bridged", "description":"virtual Networks on Host" "id":"[network1]=hostvnet:ethernet0/3" "values":[ "value":"network 1", "description":"network Name" "value":"captured from virtual server connected to VLAN 1 on host ICB-CPT1", "description":"description" "value":"vlan 91, Not Bridged", "description":"virtual Networks on Host" "id":"[network1]=hostvnet:ethernet0/91" "values":[ "value":"network 1", "description":"network Name" "value":"captured from virtual server connected to VLAN 1 on host ICB-CPT1", "description":"description" "value":"vlan 92, Not Bridged", "description":"virtual Networks on Host" "id":"[network1]=hostvnet:ethernet0/92" "values":[ "value":"network 1", "description":"network Name" "value":"captured from virtual server connected to VLAN 1 on host ICB-CPT1", "description":"description" "value":"vlan 93, Not Bridged", "description":"virtual Networks on Host" "id":"[network1]=hostvnet:ethernet0/93" "group":"adapter 1", "required":false "values":[ Chapter 1. IBM Cloud Manager with OpenStack REST API reference 147

154 "[Network 2]=hostVnet:ETHERNET0/2" "classification": "label":"network", "id":"network" "valueorigin": [ "2" "type":"single_selection", "valuefrom": "networkid", "name":"virtualnetworks-2", "description":" Network 2\"", "basic":false, "options":[ "values":[ "value":"network 2", "description":"network Name" "value":"captured from virtual server connected to VLAN 2 on host ICB-CPT1", "description":"description" "value":"vlan 1, Bridged", "description":"virtual Networks on Host" "id":"[network2]=hostvnet:ethernet0/1" "values":[ "value":"network 2", "description":"network Name" "value":"captured from virtual server connected to VLAN 2 on host ICB-CPT1", "description":"description" "value":"vlan 2, Bridged", "description":"virtual Networks on Host" "id":"[network2]=hostvnet:ethernet0/2" "values":[ "value":"network 2", "description":"network Name" "value":"captured from virtual server connected to VLAN 2 on host ICB-CPT1", "description":"description" "value":"vlan 3, Bridged", "description":"virtual Networks on Host" "id":"[network2]=hostvnet:ethernet0/3" "values":[ "value":"network 2", "description":"network Name" "value":"captured from virtual server connected to VLAN 2 on host ICB-CPT1", "description":"description" "value":"vlan 91, Not Bridged", "description":"virtual Networks on Host" 148 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

155 "id":"[network2]=hostvnet:ethernet0/91" "values":[ "value":"network 2", "description":"network Name" "value":"captured from virtual server connected to VLAN 2 on host ICB-CPT1", "description":"description" "value":"vlan 92, Not Bridged", "description":"virtual Networks on Host" "id":"[network 2]=hostVnet:ETHERNET0/92" "values":[ "value":"network 2", "description":"network Name" "value":"captured from virtual server connected to VLAN 2 on host ICB-CPT1", "description":"description" "value":"vlan 93, Not Bridged", "description":"virtual Networks on Host" "id":"[network2]=hostvnet:ethernet0/93" "group":"adapter 2", "required":false "values":[ "1" "rules":[ "value":"1", "id":"increment" "value":"linear", "id":"incrementtype" "value":"240.0", "id":"max" "value":"1.0", "id":"min" "type":"long", "name":"cskcpu", "description":"cpu", "basic":true, "required":false "values":[ "512" "rules":[ "value":"256", "id":"increment" Chapter 1. IBM Cloud Manager with OpenStack REST API reference 149

156 "value":"linear", "id":"incrementtype" "value":" ", "id":"max" "value":"256.0", "id":"min" "type":"long", "name":"cskram", "description":"ram", "basic":true, "required":false "values":[ true "classification": "label":"network", "id":"network" "valueorigin": [ true "subtype":"dns_flag", "type":"boolean", "valuefrom": "obtainfromdns", "name":"obtainfromdns.network1", "description":"obtain hostname and domain name from DNS server", "category":"tcp/ip Network Settings", "basic":false, "group":"adapter 1", "required":false "id":"402", "appliance": "name":"newsampleimagescs", "uri":" GET /workloads/id/target This service retrieves the a workload's target for a workload by ID. A workload's target includes the id, name, and type of the target. Also, it contains any target metrics present at the time of the request. N/A To retrieve the workload target for workload with ID 1 GET HTTP Response Body: 150 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

157 "id": 5416, "name": "Host 1 (Host)", "metrics": [ "id": "342abc", "name": "CPU Utilization", "type": "Percent", "value": "30", "timestamp": "duration": "13245" "status": "Valid" "dataproperties":... ] GET /workloads/id/log This service retrieves a workload logs for a workload by ID. The workload logs show the cloud log messages for a workload execution. It may provide some more information about why a workload failed. We do not have control over these logs, they come directly from the cloud. N/A Get workload log for workload 1. GET HTTP Response Body: "log":"workload, AIX 5L for POWER Version 5.3, was created. Start asynch work run for deploy of virtual appliance :8498 Workload removed due to exception: Workload, AIX 5L for POWER Version 5.3, was deleted. Error performing asynch work run for deploy of virtual appliance :8498 Error: DNZIMN878E Command LANG=C; nim -a verbose=5 -o bos_inst -a source=mksysb -a group=nimrf res_group -a accept_licenses=yes rdpnfse0 did not run properly. New workload removed: 11738" GET /workloads/id/virtualservers This service retrieves all the virtual servers within a workload by ID. Workloads that have been executed and were successful will have virtual servers associated with them. Draft or failed workloads will return an empty array. N/A Chapter 1. IBM Cloud Manager with OpenStack REST API reference 151

158 Get virtual servers for workload with ID 1: GET HTTP Response Body: "virtualservers": [ "cloudid": "cloud://352/e7e213c5-4c6f-416b-9642-baa5ae6549cc", "credentialsuri": " "state": "label": "Running", "id": "RUNNING" "backups": " "hostname": "testhost235", "storagesuri": " "capabilities": [ "isenabled": true, "id": "CREATE_DISK" "isenabled": false, "id": "ATTACH_DISK" "isenabled": true, "id": "DETACH_DISK" "isenabled": true, "id": "THIN_PROVISIONED" "isenabled": true, "id": "POWER_MANAGEMENT" "isenabled": true, "id": "CAPTURE" "isenabled": true, "id": "BACKUP" "isenabled": false, "id": "SUSPEND_CAPABLE" "isenabled": true, "id": "RESIZE" "isenabled": false, "id": "PIN" "isenabled": false, "id": "UNPIN" "ip": " ", "id": "73555", "uri": " ] 152 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

159 GET /workloads/id/virtualservers/id This service retrieves a virtual server from the virtual servers in a workload by ID. If a virtual server by the given ID doesn't exist in the workload, the service will return a 404. N/A Get virtual server with ID 2 from workload with ID 1: GET HTTP Response Body: "cloudid": "cloud://352/e7e213c5-4c6f-416b-9642-baa5ae6549cc", "credentialsuri": " "state": "label": "Running", "id": "RUNNING" "backups": " "properties": [ "value": "1024", "description": "Memory (MB)", "category": "General Information" "value": "RHEL6_Template :41:05 test_ly_by_testuser", "description": "Name", "category": "General Information" "value": "1", "description": "CPUs", "category": "General Information" "value": "1", "description": "Number of Ethernet Cards", "category": "General Information" "value": "e7e213c5-4c6f-416b-9642-baa5ae6549cc", "description": "UUID", "category": "General Information" "value": "linuxguest", "description": "Guest Operating System", "category": "General Information" "value": "rhel5_64guest", "description": "Guest ID", Chapter 1. IBM Cloud Manager with OpenStack REST API reference 153

160 "category": "General Information" "value": "testhost235", "description": "Guest Hostname", "category": "General Information" "value": " ", "description": "Guest IP Addresses", "category": "General Information" "value": "vm-2858", "description": "ID", "category": "General Information" "value": "Connected", "description": "Connection State", "category": "General Information" "value": "host-875", "description": "Host", "category": "General Information" "value": "Powered On", "description": "Power State", "category": "General Information" "hostname": "testhost235", "storagesuri": " "capabilities": [ "isenabled": true, "id": "CREATE_DISK" "isenabled": false, "id": "ATTACH_DISK" "isenabled": true, "id": "DETACH_DISK" "isenabled": true, "id": "THIN_PROVISIONED" "isenabled": true, "id": "POWER_MANAGEMENT" "isenabled": true, "id": "CAPTURE" "isenabled": true, "id": "BACKUP" "isenabled": false, "id": "SUSPEND_CAPABLE" 154 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

161 "isenabled": true, "id": "RESIZE" "isenabled": false, "id": "PIN" "isenabled": false, "id": "UNPIN" "ip": " ", "id": "73555", "uri": " GET /workloads/id/virtualservers/id/credentials This service retrieves the credentials associated with the given Virtual Server ID. These credentials are used during the capture process to perform the required access to capture. Note: The authenticated attribute is not used for this particular service and so can be ignored. N/A Get the Virtual Server with ID 2 credentials from workload with ID 1. GET HTTP Response Body: "uri":" "user":"root", "pass":"not2pass" PUT /workloads/id/virtualservers/id/credentials This service updates the credentials associated with the given Virtual Server ID and workload ID. These credentials are used during the capture process in order to perform the required access to capture. This service does not update any credentials on the configured cloud. N/A Chapter 1. IBM Cloud Manager with OpenStack REST API reference 155

162 Update the Virtual Server with ID 2 credentials from workload with ID 1. PUT "user":"root", "password":"not2pass" GET /workloads/id/timestamps This service retrieves a workload's timestamps. All timestamps are measured in Unix time format (the number of milliseconds since January 1, :00:00 GMT) and only apply to workloads created from IBM Cloud Manager with OpenStack. For timestamps that are unset of not applicable, their values will be set to -1 which indicate to the consumer that the timestamp is not applicable. The following table outlines the current timestamps returned by this service. Name started completed deploytime uptime Description The timestamp (Date) indicating when the workload was submitted to the cloud. The timestamp (Date) indicating when the workload execution completed as successful or failed. The estimated duration (elapsed time) of the workload's execution as measured by completiondate - submissiondate. The total "uptime" (elapsed time) for a workload which is measured as the current timestamp - completiondate. This value is only applicable to workloads in the 'OK' state. Note that uptime does not take into account durations for which the workload has been stopped since execution completion. For workloads in the OK state, the executiontime measures the amount of time the workload execution took from submission to successful execution completion. For workloads in the FAILED state, the executiontime will estimate how long the workload executed before failing. If the workload is a multi-workload, the response will contain a set of timestamps for each workload in the multi-workload. In this case the consumer can correlate timestamps to workloads using the workload attribute of each timestamp element of the response which indicates the IBM Cloud Manager with OpenStack workload's name the timestamp is associated with. N/A Get the timestamps for a workload with ID 1. GET IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

163 HTTP Response Body: "uri": ody: " "timestamps":[ "workload":"sampledeployment-1", "started": , "completed": , "deploytime": , "uptime": "workload":"sampledeployment-2", "started": , "completed": , "deploytime": , "uptime": "workload":"sampledeployment-3", "started": , "completed": , "deploytime": , "uptime": "deployment":"sampledeployment-4", "started": , "completed": , "deploytime": , "uptime": ] PUT /workloads/id This service updates a workload either by changing its properties or by running it. This service can also be used to request that a workload be started or stopped in the cloud as shown in the following examples. Name Description Default Required dry The workload is not sent to the cloud although all IBM Cloud Manager with OpenStack processing is applied. The workload is marked as failed. False No s 1. Run workload with ID 1 on the cloud. PUT "state": "executing" 2. Request that the workload with ID 1 be started in the cloud. PUT Chapter 1. IBM Cloud Manager with OpenStack REST API reference 157

164 "state":"ok" 3. Request the workload with ID 1 be stopped in the cloud. PUT "state":"stopped" 4. Request the "Hidden" workload with ID 1 be shown in IBM Cloud Manager with OpenStack. PUT "state":"show" Note: If this API is used to suspend or resume an OpenStack PowerVM instance, an error that this service is not supported is displayed. 5. Update the name that is assigned to a workload with ID 1. PUT "name":"my updated deployment" 6. Update the workload properties that are assigned to a workload draft with ID 1. v For PowerVM workloads, use this request: PUT "name":"myname", "instances":"###", "project":"###", "properties":[ "name":"cpushared", "value":2 "name":"memsize", "value":2048 "name":"cskcpu", "value":2 "name":"cskram", "value":2048 "name":"vimref1disk", "basic":false,"value":5376 "state":"executing" v For KVM workloads, use this request: PUT "name":"myname", "instances":"###", "project":"###", "properties":[ "name":"cpu", 158 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

165 "value":3 "name":"memminvu", "value":1027 "name":"vimref1disk", "basic":false,"value":5376 "state":"executing" v For VMware workloads, use this request: PUT "name":"myname", "instances":"###", "project":"###", "properties":[ "name":"vmware.memory", "value":1032 "name":"vmware.cpu", "value":2 "state":"executing" v For OpenStack workloads, you can set the Quantum network uuids that you want to use for the workload with this request: PUT "name":"myname", "instances":"###", "project":"###", "properties":[ "name":"cpu", "value":3 "name":"memminvu", "value":1027 "name":"vimref1disk", "basic":false,"value":5376 "name":"networkdevice.network adapters.networks", "values":[ 25ec1f ae9-af05-279c8d8bd132, fc9d435e-c f-b517-6e6a19fb0de3 ] "state":"executing" 7. Update the project that this workload belongs to, to project with ID 45. PUT "project": 45 Chapter 1. IBM Cloud Manager with OpenStack REST API reference 159

166 8. Run workload with ID 1 on the cloud, creating five instances of this workload. PUT "state": "executing", "instances":5 9. Resize a workload with ID 1 on the cloud. Increase its VMs, CPUs, and assigned memory. PUT "state": "resizing", "properties":[ "name":"cpu", "value":3 "name":"memsize", "value":1024 ] If this is a KVM workload, the request should be: "state": "resizing", "properties":[ "name":"cpumin", "value":3 "name":"memminvu", "value":[mb]=vmemsize:1024 ] 10. Check whether the specified target is compatible with the target of workload 1. PUT "target": "45" If not compatible, a JSON string returns as the HTTP response, which contains all the incompatible properties. The HTTP status is always 200 OK whether the specified target is compatible. 11. Update the priority of this workload with ID 1 to priority 3. PUT "properties":[ "name": "priority", "basic": false, "value": "3" "state": "UPDATE_PRIORIT" 12. Enable remote restart capability of a workload when creating it. 160 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

167 "name":"myname", "instances":"###", "project":"###", "properties":[ "name":"remoterestartcapable", "value":true ] "state":"executing" Note: This property is valid only when the target is a system pool and the hypervisor is Power. For Linux Kernel-based Virtual Machine (KVM), this feature is enabled by default and not configurable. If the hypervisor is a VMware Server, the feature is not supported and the property is not valid. v OK - For property updates v HTTP Status: 202 Accepted - For workload executions, power management and resizes. DELETE /workloads/id This service is used to either 'soft delete' a workload from IBM Cloud Manager with OpenStack, or 'hard delete' it from the cloud. In the case of 'soft delete' the workload resources are not removed from the cloud, but rather the IBM Cloud Manager with OpenStack workload is marked as 'DELETED' and not returned in any service that queries workloads. In the case of 'hard delete' the workload resources (workload and virtual server) are also removed from the cloud. Name Description Default Required hard The workload resource should be removed from the Cloud if hard is set to 'true'. false No To remove workload with ID 1: DELETE (for a soft delete) HTTP Status: 202 (for a hard delete) GET /workloads/stats This service retrieves statistics about workloads. The default statistic is the states of the various workloads. Chapter 1. IBM Cloud Manager with OpenStack REST API reference 161

168 Name Description Default Required user Gets the statistics for workloads that this username can see. N/A No Get workloads statistics: GET HTTP Response Body: "groupby":"state", "uri":" "stats":[ "value":"label":"draft","id":"draft""count":1 "value":"label":"ok","id":"ok""count":1 "value":"label":"pending","id":"pending""count":2 ] GET /workloads/owners This service retrieves all the owners of workloads from the IBM SmartCloud Entry user registry. This API retrieves the list of owners of all the workloads. To retrieve only the owners of the workloads that you want, use the user parameter and specify a value. If you do not specify a value for the parameter, the owners of all the workloads in IBM Cloud Manager with OpenStack server are retrieved. Name Description Default Required user Retrieves all the owners of the workloads for the specified users. false No Retrieve a list of all owners in the IBM SmartCloud Entry user registry. GET No HTTP body required. HTTP Response Body: 162 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

169 "users": [ "islocked": false, "isadmin": true, "role": "label": "Admin", "id": "ADMIN" "username": "admin", "name": "SmartCloud Entry Administrator", " notifications": false, " ": "", "uri": " "isapprover": true "islocked": false, "isadmin": false, "role": "label": "User", "id": "USER" "username": "user1", "name": "user1", " notifications": false, "uri": " "isapprover": false "islocked": false, "isadmin": false, "role": "label": "User", "id": "USER" "username": "user2", "name": "user2", " notifications": false, "uri": " "isapprover": false ] Chapter 1. IBM Cloud Manager with OpenStack REST API reference 163

170 164 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

171 Chapter 2. IBM OpenStack REST API reference IBM Cloud Manager with OpenStack provides a set of OpenStack APIs. IBM Cloud Manager with OpenStack also provides the ability for applications that are running outside of the IBM Cloud Manager with OpenStack framework to access the OpenStack APIs. These APIs are based on the representational state transfer (REST) architecture and are accessed by using the HTTP protocol. REST refers to an architecture used to create stateless web services that are typically accessed by using the HTTP protocol. Overview of IBM OpenStack REST API reference IBM Cloud Manager with OpenStack supports the following two scenarios of using OpenStack, which can be chosen when IBM Cloud Manager with OpenStack is deployed: IBM Cloud Manager with OpenStack for OpenStack Management OpenStack is pre-configured by IBM Cloud Manager with OpenStack (users cannot configure OpenStack). Users can use the IBM Cloud Manager with OpenStack user interface and REST APIs when they use OpenStack APIs. For the IBM Cloud Manager with OpenStack for OpenStack management scenario, direct mutable operations through the OpenStack APIs bypass the following IBM Cloud Manager with OpenStack control flows: Billing and Metering, Approvals, Expiration, and Image template. OpenStack resources created in-band through IBM Cloud Manager with OpenStack must be managed by IBM Cloud Manager with OpenStack and OpenStack resources that are created out-of-band by OpenStack APIs must be managed by OpenStack APIs. For Identity Management, users can use only IBM Cloud Manager with OpenStack to manage identity resources, such as users, projects, and domains. Therefore, only immutable OpenStack APIs and some OpenStack APIs such as services or endpoints of Keystone are directly supported. IBM Cloud Manager with OpenStack for base OpenStack IaaS In this case, OpenStack is generically configured and can be customized by users within IBM Cloud Manager with OpenStack prescriptive limits (refer to IBM Cloud Manager with OpenStack Administrator Guide for more details). IBM Cloud Manager with OpenStack is disabled and full set of supported OpenStack APIs are accessible to users. Users use OpenStack for Identity Management. OpenStack APIs can be called directly or by using OpenStack CLIs. Access OpenStack APIs All OpenStack API access that includes access to CLIs must flow through the IaaS gateway. Access OpenStack APIs/CLIs through IaaS gateway IaaS gateway is a part of the IBM OpenStack distribution. OpenStack is a lightweight proxy middleware container that provides pluggable adaptation to normalize interactions across multiple IaaS cloud provider vendors. IaaS gateway has the following main features: Copyright IBM Corp. 2011,

172 A lightweight stateless API proxy A single uniform API entry point for users to work with multiple IaaS based Clouds on the backend. When users call the uniform API URL to IaaS gateway, which rewrites the URL or changes the request body to match the backend cloud format. IaaS gateway also changes the response from clouds to make them uniform and return to users. Pluggable adaptation and middleware In IaaS gateway, the middleware and adaptation feature provides ways to integrate with non-openstack-based backend IaaS providers. The federated IaaS Clouds might not support OpenStack-based APIs, or data formats. Users cannot interface with an OpenStack-based REST API while those requests are serviced in a semantically equivalent manner. Therefore, IaaS gateway provides support for only OpenStack integration. The adapters in IaaS gateway are pluggable and extendable. If the gateway does not provide the features that are needed to adapt to new rules, adding an adapter into the gateway is allowed. URL rewriting To make the URL uniform for federation clouds, URL rewriting is necessary. Gateway provides access to a virtual URI for each of the federated remote service endpoints in the federation. This hides the true remote endpoint URLs from gateway REST users. The format of the virtual URIs is as follows: http[s]://<gateway_host>:<gateway_port>/<endpoint_id>/[admin public internal]/<api_uri>. The URL format is based on OpenStack API style. Connect to a Keystone service The gateway requires a Keystone service, which is used for the service or endpoint catalog (does not use tenants or users). Gateway admin users register remote federated cloud services and their respective endpoints into the gateway of the master Keystone by using the actual endpoint URL to the remote provider. A service that is running on Linux IaaS gateway has its own service that is running on Linux, and is configured by using configuration files. Therefore, to access OpenStack APIs, use the IaaS gateway virtual URI through the IaaS gateway. For example, to authenticate with Keystone and obtain a Keystone token, call 770e010856b64d39bf7d622718c55156/public/v2.0/tokens. Using CLIs is similar to accessing APIs. The following is an example: # glance --os-username=admin --os-password=secrete --os-tenant-name=demo --os-auth-url= # nova --os-username=admin --os-password=secrete --os-tenant-name=demo --os-auth-url= v2/ffa68a e559a3d801222a59133/servers/detail # keystone --os-username=admin --os-password=secrete --os-tenant-name=demo --os-auth-url= OpenStack REST APIs The OpenStack APIs that are supported by IBM Cloud Manager with OpenStack are listed here. Only the following OpenStack projects are supported by IBM Cloud Manager with OpenStack 4.1: v Heat (Orchestration) v Horizon (Dashboard) v Keystone (Identity) 166 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

173 v Nova (Compute) v Glance (Image) v Neutron (Networking) v Cinder (Block storage) v Ceilometer (Telemetry) The specification of each supported API is not included in this guide. Refer to api-ref.html for details of the specifications. Note: For the supported APIs, any limitations or restrictions for the scenarios and hypervisors (KVM, Hyper-V, and IBM PowerVM/PowerVC) are noted. The stability of non-supported APIs or features, is not guaranteed by IBM Cloud Manager with OpenStack. Non-supported features might not be functionally complete, and are not intended for production use. IBM does not attempt to resolve any issues that customers experience when they use these features. Explanation of table headers Each supported OpenStack API is described by using a table. API The REST API list. Description The feature description of this API. SmartCloud Entry for OpenStack Management Whether this API is supported when users use IBM Cloud Manager with OpenStack to manage an OpenStack cloud API. Any limitations or notes about this API are marked. '' means that this API was tested and verified. 'N' means that this API is not supported by IBM Cloud Manager with OpenStack. SmartCloud Entry for Base OpenStack IaaS Whether this API is supported when users directly use base OpenStack IaaS cloud. Any limitations or notes about this API are marked. Hypervisor Points out the API differences between KVM, Hyper-V, and IBM PowerVM/PowerVC. IaaS gateway The IaaS gateway API is described here. Table 3. IaaS gateway API API GET /providers Description IBM Cloud Manager with OpenStack for OpenStack Management IBM Cloud Manager with OpenStack for Base OpenStack IaaS Hypervisor Gets detailed information about OpenStack Identity service catalog. GET /providers This service returns a service catalog listing the Keystone identity endpoint URLs that can be used with the IaaS gateway server. The URLs include the endpoint ID needed to access Keystone APIs through the IaaS gateway. If the Keystone server supports Keystone version 3 APIs, the corresponding version 3 URLs can be constructed by replacing the final "version 2" with "version 3". Chapter 2. IBM OpenStack REST API reference 167

174 GET HTTP Response Body: "servicecatalog" : [ "endpoints" : [ "interface" : "public", "url" : " "region" : "regionone", "id" : "7a4030cb801d46f7aad3d57a97d5c5a1" "interface" : "internal", "url" : " "region" : "regionone", "id" : "3fb86030b3aa4cf2968f66bab2d6d355" "interface" : "admin", "url" : " "region" : "regionone", "id" : "ee3df50dcf1941c89089fc978bf8eec4" "type" : "identity", "name" : "keystone" ] Keystone The services that are provided by Keystone are described here. Table 4. Keystone API services API Description IBM Cloud Manager with OpenStack for OpenStack Management IBM Cloud Manager with OpenStack for Base OpenStack IaaS Hypervisor Identity Service API v2.0 Gets an authentication token that permits access to the Compute API for 24 hours. GET v2.0 Gets detailed information about a specified version of the Identity Service API. GET v2.0/extensions GET v2.0/extensions/alias POST v2.0/tokens Lists available extensions. Gets detailed information for a specified extension. Authenticates and generates a token. N 168 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

175 Table 4. Keystone API services (continued) API Description IBM Cloud Manager with OpenStack for OpenStack Management IBM Cloud Manager with OpenStack for Base OpenStack IaaS Hypervisor Identity Service Admin API v2.0 Gets an authentication token that permits access to the Compute API for 24 hours. GET v2.0 Gets detailed information about a specified version of the Identity Service API. GET v2.0/extensions GET v2.0/extensions/alias POST v2.0/tokens GET v2.0/tokens/tokenid HEAD v2.0/tokens/tokenid GET v2.0/tokens/tokenid/ endpoints GET v2.0/users GET v2.0/users/user_id GET v2.0/tenants GET v2.0/tenants/tenantid GET v2.0/tenants/ tenantid/users/ userid/roles Lists available extensions. OS-KSADM Admin Extension Gets detailed information for a specified extension. Authenticates and generates a token. Validates a token and confirms that it belongs to a specified tenant. Validates a token and confirms that it belongs to a specified tenant, for performance. Lists the resources that are associated with a specified token. Gets detailed information about a specified user by user name. Gets detailed information about a specified user by user ID. Lists tenants to which the specified token has access. Gets detailed information about a specified tenant by ID. Lists roles for a specified user on a specified tenant. Excludes global roles. N Chapter 2. IBM OpenStack REST API reference 169

176 Table 4. Keystone API services (continued) IBM Cloud Manager API Description with OpenStack for OpenStack Management IBM Cloud Manager with OpenStack for Base OpenStack IaaS GET v2.0/users Lists users. POST v2.0/users Adds a user. N. Hypervisor Limitation: When identity driver is set to PUT v2.0/users/userid Updates a user. N. ldap([identity]driver = keystone.identity. backends.ldap.identity), the following four user attributes are ignored: enabled, , tenants, tenantid Limitation: When identity driver is set to DELETE v2.0/users/userid PUT v2.0/users/userid/os- KSADM/enabled Deletes a user. N Enables a specified user. POST v2.0/tenants Creates a tenant. N. N ldap([identity]driver = keystone.identity. backends.ldap.identity), the following four user attributes are ignored: enabled, , tenants, tenantid Limitation: When identity driver is set to ldap([identity]driver = keystone.identity. backends.ldap.identity), the following four user attributes are ignored: enabled, , tenants, tenantid 170 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

177 Table 4. Keystone API services (continued) API Description IBM Cloud Manager with OpenStack for OpenStack Management PUT Updates a tenant. N. v2.0/tenants/tenantid IBM Cloud Manager with OpenStack for Base OpenStack IaaS Limitation: When identity driver is set to Hypervisor DELETE v2.0/tenants/tenantid GET v2.0/tenants/ tenantid/users PUT v2.0/tenants/ tenantid/users/ userid/roles/os- KSADM/roleId DELETE v2.0/tenants/ tenantid/users/ userid/roles/os- KSADM/roleId GET v2.0/os-ksadm/roles POST v2.0/os-ksadm/roles GET v2.0/os-ksadm/ roles/roleid DELETE v2.0/os-ksadm/ roles/roleid GET v2.0/os-ksadm/ services POST v2.0/os-ksadm/ services GET v2.0/os-ksadm/ services/serviceid DELETE v2.0/os-ksadm/ services/serviceid Deletes a tenant. N Lists all the users for a tenant. Adds a specified role to a user for a tenant. Deletes a specified role from a user on a tenant. N N Gets a role by name. Adds a role. N Gets a role. Deletes a role. N Lists services. Adds a service. N Gets a service. Deletes a service. N ldap([identity]driver = keystone.identity. backends.ldap.identity), the following four user attributes are ignored: enabled, , tenants, tenantid Chapter 2. IBM OpenStack REST API reference 171

178 Glance The Glance API services that are supported by IBM Cloud Manager with OpenStack are described here. Table 5. Glance API services API Description IBM Cloud Manager with OpenStack for OpenStack Management IBM Cloud Manager with OpenStack for Base OpenStack IaaS Hypervisor V2.0 Creates, updates, and deletes image metadata records. Also, uploads and downloads raw image data. Note: The powervc_uuid image metadata is reserved by the PowerVC driver and must not be updated. GET v2/schemas/images Gets a json-schema document that represents an images entity GET v2/schemas/image GET v2/images POST v2/images GET v2/images/imageid PATCH v2/images/imageid DELETE v2/images/imageid Gets a json-schema document that represents an image entity. Lists public virtual machine (VM) images. Creates a virtual machine (VM) image. Gets details for a specified image. Updates a specified image. Deletes a specified image.. Limitation: 'owner' attribute must be set to tenant id instead of user ID. If set to user ID, IBM Cloud Manager with OpenStack cannot categorize the user to correct tenant, and just categorizes it to the default project. Not supported by PowerVC driver. All images must be synchronized from PowerVC to the hosting OpenStack by the PowerVC driver. Not supported by PowerVC driver.. Limitation: 'owner' attribute must be set to tenant id instead of user ID. If set to user ID, IBM Cloud Manager with OpenStack cannot categorize the user to correct tenant, and just categorizes it to the default project. 172 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

179 Table 5. Glance API services (continued) API Description PUT Uploads binary image v2/images/imageid/file data. GET v2/images/imageid/file POST v2/images/image_id/ tags/tag DELETE v2/images/image_id/ tags/tag Downloads binary image data. Adds a specified tag to a specified image. Deletes a specified tag from a specified image. IBM Cloud Manager with OpenStack for OpenStack Management IBM Cloud Manager with OpenStack for Base OpenStack IaaS Hypervisor Not supported by PowerVC driver. All images must be synchronized from PowerVC to the hosting OpenStack by the PowerVC driver. Not supported by PowerVC driver. Not supported by PowerVC driver. Neutron Provides virtual networking services among devices that are managed by the OpenStack compute service. The Networking API v2.0 combines the API v1.1 function with some essential Internet Protocol Address Management (IPAM). Enables users to associate IP address blocks and other network configuration settings with a neutron network. ou can choose a specific IP address from the block or Neutron can choose the first available IP address. Note: The PowerVC driver supports only VLAN type networks with physical network equal to default. Also, IPv6 addresses are ignored by the PowerVC driver. Table 6. Neutron API services API Description IBM Cloud Manager with OpenStack for OpenStack Management IBM Cloud Manager with OpenStack for Base OpenStack IaaS Hypervisor Network Lists, creates, deletes, and updates neutron networks, subnets, and ports. GET /networks Lists a summary of all networks that are defined in neutron that are accessible to the tenant who submits the request. GET /networks/network_id POST /networks/network_id DELETE /networks/network_id Lists detailed information for the specified network ID. Creates a neutron network. Lists detailed information for the specified network ID. Chapter 2. IBM OpenStack REST API reference 173

180 Table 6. Neutron API services (continued) API PUT /networks/network_id GET /subnets POST /subnets Description Updates the name of the specified network. Lists all subnets that are accessible to the tenant who submits the request. Creates a subnet on the specified network. IBM Cloud Manager with OpenStack for OpenStack Management. Limitation: IBM Cloud Manager with OpenStack for Base OpenStack IaaS Hypervisor Under one specific network, users can create only one IPv4 subnet or two subnets (one IPv4 and one IPv6) DELETE /subnets/subnet-id Removes the specified subnet. PUT /subnets/subnet-id Updates the specified subnet. GET /ports Lists all ports to which the tenant has access. GET /ports/port-id Shows information for the specified port. POST /ports Creates a port on the specified network. PUT /ports/port-id Updates the specified port. DELETE /ports/port-id Removes the specified port. List available Extensions. GET /2.0/extensions List available extensions. The Layer-3 Network Extension The Layer-3 networking extension enables OpenStack Networking API users to route packets between subnets, forward packets from internal networks to external ones, and access instances from external networks through floating IPs. GET /routers GET /routers/router_id Returns a list of logical routers accessible to the tenant that submits the request. Returns details about a specific logical router. N N 174 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

181 POST /routers PUT /routers/router_id DELETE /routers/router_id PUT /routers/router_id/ add_router_interface PUT /routers/router_id/ remove_router_interface GET /floatingips GET /floatingips/floating_ip POST /floatingips/floating_ip PUT /floatingips/floating_ip DELETE /floatingips/floating_ip Quotas Create a new logical router. Updates a logical router. Removes a logical router and its external gateway interface, if it exists Adds an internal interface to a logical router. Removes an internal interface from a logical router. Returns a list of floating IPs accessible to the tenant that submits the request. Returns details about a specific floating IP. Creates a floating IP and configures its association with an internal port, if the relevant information is specified Updates a floating IP and its association with an internal port, if the relevant information is specified in the request body. Removes a floating IP and its association information. N N N N N N N N N N This extension enables an admin user to define quotas values on a per-tenant basis. For example, an admin user can provide tenant A rights to create at most X networks, and provide rights to tenant B to create at most networks. GET /quotas GET /quotas/tenant_id PUT /quotas/tenant_id DELETE /quotas/tenant_id Lists quotas for tenants who have non-default quota values. Shows quotas for a specified tenant. Updates quotas for a specified tenant. Use when non-default quotas are wanted. Resets quotas to default values for a specified tenant. N N N N Chapter 2. IBM OpenStack REST API reference 175

182 Security Groups and Rules Creates, modifies, and deletes OpenStack Networking security groups and rules. Note: Security Groups and Rules are not supported by PowerVC driver. GET /security-groups POST /security-groups GET /security-groups/ security_group_id DELETE /security-groups/ security_group_id GET /security-group-rules POST /security-group-rules GET /security-group-rules/ rule_id DELETE /security-group-rules/ rule_id Agent Management Lists a summary of all OpenStack Networking security groups that the specified tenant can access. Creates an OpenStack Networking security group. Shows information for a specified security group. Deletes an OpenStack Networking security group. Lists a summary of allopenstack Networking security group rules that the specified tenant can access. Creates an OpenStack Networking security group rule. Shows detailed information for a specified security group rule. Deletes a specified rule from an OpenStack Networking security group. N N N N N N N N In a typical OpenStack Networking deployment, some agents run on network or compute nodes, such as neutron-dhcp-agent, neutron-ovs-agent, and neutron-l3-agent. This extension provides a way for administrators (enforced by the policy engine) to view their status and update their attributes. Updating agent management API attributes affect operations of other components such as OpenStack Networking schedulers. For instance, when administrators disable a certain agent, OpenStack Networking schedulers do not schedule resources to it. GET /agents GET /agents/agent_id PUT /agents/agent_id DELETE /agents/agent_id List agents that report their status to OpenStack Networking server. Show information of the specified agent. Update the agent's admin status and description. Delete the specified agent. N N N N 176 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

183 The Load Balancer as a Service Extension The LBaaS extension provides OpenStack tenants with a feature of balancing traffic to their VMs. GET /lb/vips Lists vips. N GET /lb/vips/vip-id Returns details about N a specific vip. POST /lb/vips Create a load N balancer vip. PUT /lb/vips/vip-id Updates a load balancer vip. N DELETE /lb/vips/vip-id Removes a load balancer vip. GET /lb/pools Lists pools. N GET /lb/pools/pool-id Returns details about N a specific pool. POST /lb/pools Create a load N balancer pool. PUT /lb/pools/pool-id Updates a load balancer pool. N DELETE /lb/pools/pool-id Removes a load balancer pool. GET /lb/members Lists members. N GET /lb/members/memberid POST /lb/members PUT /lb/members/memberid DELETE /lb/members/memberid GET /lb/health_monitors GET /lb/health_monitors/ monitor_id POST /lb/health_monitors PUT /lb/health_monitors/ monitor_id DELETE /lb/health_monitors/ monitor_id POST /lb/pools/pool-id/ health_monitors Returns details about a specific member. Create a load balancer member. Updates a load balancer member. Removes a load balancer member. N N N N N N Lists health monitors. N Returns details about a specific health monitor. Create a load balancer health monitor. Updates a load balancer health monitor. N N N Delete health monitor. N Associate health monitor with the pool. N Chapter 2. IBM OpenStack REST API reference 177

184 DELETE /lb/pools/pool-id/ health_monitors/ monitor_id Disassociate health monitor from the pool. The Agent Schedulers Extension N The agent schedulers extension schedules resources among agents on top of the agent management extension. GET /agents/agent_id/dhcpnetworks GET /networks/network_id/ dhcp_agents POST /agents/agent_id/dhcpnetworks DELETE /agents/agent_id/dhcpnetworks/network_id GET /agents/agent_id/l3- routers GET /agents/agent_id/l3- routers/router_id POST /agents/agent_id/l3- routers DELETE /agents/agent_id/l3- routers/router_id List networks the specified DHCP agent is hosting. List DHCP agent that hosts the specified network. Schedule the network to the DHCP agent. Remove the network from the DHCP agent. List routers the L3 agent is hosting. List L3 agents that hosts the router. Schedule the router to the L3 agent. Remove the router from the L3 agent. The Virtual Private Network As a Service Extension N N N N N N N N The VPNaaS extension provides OpenStack tenants with the ability to extend private networks across the public telecommunication infrastructure. GET /vpn/vpnservices Lists VPN services. N GET /vpn/vpnservices/ service-id POST /vpn/vpnservices PUT /vpn/vpnservices/ service-id DELETE /vpn/vpnservices/ service-id Returns details about a specific VPN service. Creates a VPN service. Updates a VPN service, provided status is not indicating a PENDING_* state. Removes a VPN service. GET /vpn/ikepolicies Lists IKE policies. N GET /vpn/ikepolicies/ ikepolicy-id Returns details about a specific IKE policy. N N N N N 178 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

185 POST /vpn/ikepolicies Creates an IKE policy. N PUT /vpn/ikepolicies/ ikepolicy-id DELETE /vpn/ikepolicies/ ikepolicy-id Updates an IKE policy. Removes an IKE policy. GET /vpn/ipsecpolicies Lists IPSec policies. N GET /vpn/ipsecpolicies/ ipsecpolicy-id Returns details about a specific IPSec policy. POST /vpn/ipsecpolicies Creates an IPSec policy. PUT /vpn/ipsecpolicies/ ipsecpolicy-id DELETE /vpn/ipsecpolicies/ ipsecpolicy-id GET /vpn/ipsec-siteconnections GET /vpn/ipsec-siteconnections/ connection-id POST /vpn/ipsec-siteconnections PUT /vpn//ipsec-siteconnections/ connection-id DELETE /vpn//ipsec-siteconnections/ connection-id Updates a IPSec policy. Removes a IPSec policy. Lists the IPSec site-to-site connections. Returns details about a specific IPSec site-to-site connection. Creates an IPSec site connection. Updates an IPSec site-to-site connection, provided status is not indicating a PENDING_* state. Deletes a IPSec site-to-site connection. N N N N N N N N N N N Cinder The Cinder API services that are supported by IBM Cloud Manager with OpenStack are described here. Table 7. Cinder API services API Description IBM Cloud Manager with OpenStack for OpenStack Management IBM Cloud Manager with OpenStack for Base OpenStack IaaS Hypervisor V2 Manages volumes and snapshots for use with the Block Storage Service API (cinder services). POST v2tenant_id/volumes Creates a volume. Chapter 2. IBM OpenStack REST API reference 179

186 Table 7. Cinder API services (continued) API GET v2tenant_id/volumes GET v2tenant_id/volumes/ detail GET v2tenant_id/volumes/ volume_id PUT v2tenant_id/volumes/ volume_id DELETE v2tenant_id/volumes/ volume_id GET v2tenant_id/ volume_types GET v2tenant_id/ volume_types/type_id POST v2tenant_id/snapshots GET v2tenant_id/snapshots GET v2tenant_id/ snapshots/detail GET v2tenant_id/ snapshots/snapshot_id Description Lists summary information for all Cinder volumes that are accessible to the tenant who submits the request. Lists detailed information for all Cinder volumes that are accessible to the tenant who submits the request. Shows information about a specified volume. IBM Cloud Manager with OpenStack for OpenStack Management Updates a volume. Deletes a specified volume. Lists volume types. Shows information about a specified volume type. Creates a snapshot, which is a point-in-time copy of a volume. ou can create a new volume from the snapshot. Lists summary information for all Cinder snapshots that are accessible to the tenant who submits the request. Lists detailed information for all Cinder snapshots that are accessible to the tenant who submits the request. Shows information for a specified snapshot. IBM Cloud Manager with OpenStack for Base OpenStack IaaS Hypervisor Not supported by PowerVC driver. Not supported by PowerVC driver. Not supported by PowerVC driver. Not supported by PowerVC driver. 180 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

187 Table 7. Cinder API services (continued) API PUT v2tenant_id/ snapshots/snapshot_id DELETE v2tenant_id/ snapshots/snapshot_id Description Updates a specified snapshot. Deletes a specified snapshot. IBM Cloud Manager with OpenStack for OpenStack Management IBM Cloud Manager with OpenStack for Base OpenStack IaaS Hypervisor Not supported by PowerVC driver. Not supported by PowerVC driver. Nova The Nova API services that are supported by IBM Cloud Manager with OpenStack are described here. Table 8. Nova API services API Versions GET v2 Description Gets details about this specific version of the API. IBM Cloud Manager with OpenStack for OpenStack Management IBM Cloud Manager with OpenStack for Base OpenStack IaaS Hypervisor Extensions Note: The PowerVC driver added an extended_powervm server extension to the Nova './api/openstack/ compute/contrib/' directory. This extension provides unique server attributes to PowerVM by using the IBM-PVM prefix. GET v2/tenant_id/ extensions GET v2/tenant_id/ extensions/alias Limits GET v2/tenant_id/limits Servers GET v2/tenant_id/servers POST v2/tenant_id/servers GET v2/tenant_id/servers/ detail GET v2/tenant_id/servers/ server_id PUT v2/tenant_id/servers/ server_id Lists all available extensions. Gets details about the specified extension. Returns current limits for the account. Lists IDs, names, and links for all servers. Creates a server. Lists details for all servers. Gets details for a specified server. Updates the editable attributes of the specified server. Not supported by PowerVC driver. Chapter 2. IBM OpenStack REST API reference 181

188 Table 8. Nova API services (continued) API Description IBM Cloud Manager with OpenStack for OpenStack Management IBM Cloud Manager with OpenStack for Base OpenStack IaaS Hypervisor DELETE v2/tenant_id/servers/ server_id Deletes a specified server.. Limitation: If users delete or force-delete a server on OpenStack Cloud, the server is displayed with "unknown" status at IBM Cloud Manager with OpenStack side. Server Metadata Sets, lists, gets details for, and deletes server metadata or metadata items. Note: The pvc_id server metadata is reserved by the PowerVC driver and must not be updated. GET v2/tenant_id/servers/ server_id/metadata POST v2/tenant_id/servers/ server_id/metadata PUT v2/tenant_id/servers/ server_id/metadata GET v2/tenant_id/servers/ server_id/metadata/ key Lists metadata for the specified resource. Updates metadata items by key for the specified resource. Sets metadata for the specified resource. Gets a metadata item by key for the specified resource.. Limitation: IBM Cloud Manager with OpenStack sets only the server metadata when deploying a virtual server, and then any changes to metadata in OpenStack will not be synchronized to IBM Cloud Manager with OpenStack. 182 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

189 Table 8. Nova API services (continued) API PUT v2/tenant_id/servers/ server_id/metadata/ key DELETE v2/tenant_id/servers/ server_id/metadata/ key Server Addresses GET v2/tenant_id/ips/ network_id GET v2/tenant_id/ips Server Actions Description Sets a metadata item by key for the specified resource. Deletes a metadata item by key for the specified resource. Lists addresses for a specified server ID and network label. Lists addresses for a specified server ID. IBM Cloud Manager with OpenStack for OpenStack Management. Limitation: IBM Cloud Manager with OpenStack sets only the server metadata when deploying a virtual server, and then any changes to metadata in OpenStack will not be synchronized to IBM Cloud Manager with OpenStack. IBM Cloud Manager with OpenStack for Base OpenStack IaaS Hypervisor Performs actions for a specified server, including changing administrator password, rebooting, rebuilding, resizing, and creating image from server. POST v2/tenant_id/servers/ action POST v2/tenant_id/servers/ action Changes the password for a server. Specify the changepassword action in the request body. Reboots the specified server. Specify the reboot action in the request body. N. All change server password REST APIs are invalid to IBM Cloud Manager with OpenStack. These changes cannot be synchronized to IBM Cloud Manager with OpenStack, as IBM Cloud Manager with OpenStack does not collect the administrative password from the cloud side. Not supported by PowerVC driver. Not supported by PowerVC driver. Chapter 2. IBM OpenStack REST API reference 183

190 Table 8. Nova API services (continued) API POST v2/tenant_id/servers/ action POST v2/tenant_id/servers/ action POST v2/tenant_id/servers/ action POST v2/tenant_id/servers/ action POST v2/tenant_id/servers/ action Flavors Description Rebuilds the specified server. Specify the rebuild action in the request body. Resizes the specified server. Specify the resize action in the request body. Confirms a pending resize action. Specify the confirmresize action in the request body. Cancels and reverts a pending resize action. Specify the revertresize action in the request body. Creates a new image. Specify the createimage action in the request body. IBM Cloud Manager with OpenStack for OpenStack Management. Limitation: The following properties cannot be synchronized to IBM Cloud Manager with OpenStack: Metadata, adminpass, personality. N. The "resize" and "confirm resize" actions in IBM Cloud Manager with OpenStack are atomic operations. IBM Cloud Manager with OpenStack for Base OpenStack IaaS Hypervisor Not supported by PowerVC driver. Lists available flavors and gets details for a specified flavor. A flavor is a hardware configuration for a server. Each flavor is a unique combination of disk space and memory capacity. GET v2/flavors Lists IDs, names, and links for available flavors. GET v2/flavors/detail GET v2/flavors/ flavor_id Lists all details for available flavors. Gets details for a specified flavor.. Note: A deleted flavor still might be shown. ( bugs.launchpad.net/ nova/+bug/ ) 184 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

191 Table 8. Nova API services (continued) API Description IBM Cloud Manager with OpenStack for OpenStack Management IBM Cloud Manager with OpenStack for Base OpenStack IaaS Hypervisor Images Lists available images, gets details for a specified image, and deletes an image. Also, sets, lists, gets details for, and deletes image metadata. An image is a collection of files that you use to create or rebuild a server. By default, operators provide prebuilt operating system images. ou can also create custom images. GET v2/images GET v2/images/detail GET v2/images/image_id DELETE v2/images/image_id Image Metadata Lists IDs, names, and links for available images. Lists all details for available images. Gets details for a specified image. Deletes a specified image. Sets, lists, gets details for, and deletes image metadata or metadata items. Note: The powervc_uuid image metadata is reserved by the PowerVC driver and must not be updated. GET v2/images/image_id/ metadata POST v2/images/image_id/ metadata PUT v2/images/image_id/ metadata GET v2/images/image_id/ metadata/key PUT v2/images/image_id/ metadata/key DELETE v2/images/image_id/ metadata/key Server Admin Actions Lists metadata for the specified resource. Updates metadata items by key for the specified resource. Sets metadata for the specified resource. Gets a metadata item by key for the specified resource. Sets a metadata item by key for the specified resource. Deletes a metadata item by key for the specified resource. Permits administrators to perform actions on a server. Chapter 2. IBM OpenStack REST API reference 185

192 Table 8. Nova API services (continued) API POST v2/tenant_id/servers/ server_id/action POST v2/tenant_id/servers/ server_id/action POST v2/tenant_id/servers/ server_id/action POST v2/tenant_id/servers/ server_id/action POST v2/tenant_id/servers/ server_id/action POST v2/tenant_id/servers/ server_id/action POST v2/tenant_id/servers/ server_id/action Description Pauses a server and changes its status to PAUSED. Specify the pause action in the request body. Unpauses a PAUSED server and changes its status to ACTIVE. Specify the unpause action in the request body. Suspends a server and changes its status to SUSPENDED. Specify the suspend action in the request body. Resumes a SUSPENDED server and changes its status to ACTIVE. Specify the resume action in the request body. Locks a server. Specify the lock action in the request body. Unlocks a server. Specify the unlock action in the request body. Backs up a server instance. Specify the createbackup action in the request body. IBM Cloud Manager with OpenStack for OpenStack Management When the specified server is in "PAUSED" state on OpenStack side, the state of the server in IBM Cloud Manager with OpenStack side is "SUSPENDED". This is the same state after the server was suspended. IBM Cloud Manager with OpenStack for Base OpenStack IaaS Hypervisor Not supported by PowerVC driver. Not supported by PowerVC driver. Not supported by PowerVC driver. Not supported by PowerVC driver.. Limitation: Directly backing up an instance fromopenstack side creates an image of type backup. But from IBM Cloud Manager with OpenStack side, it will be an image after synchronization. Not supported by PowerVC driver. 186 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

193 Table 8. Nova API services (continued) API POST v2/tenant_id/servers/ server_id/action POST v2/tenant_id/servers/ server_id/action POST v2/tenant_id/servers/ server_id/action Host Aggregates Description Live-migrates a server to a new host without rebooting. Specify the os-migratelive action in the request body. Resets the state of a server to a specified state. Specify the os-resetstate action in the request body. Evacuates a server from failed host. Specify the evacuate action in the request body. IBM Cloud Manager with OpenStack for OpenStack Management IBM Cloud Manager with OpenStack for Base OpenStack IaaS Hypervisor Hyper-V and PowerVC drivers do not support this function. Hyper-V and PowerVC drivers do not support this function. Hyper-V and PowerVC drivers do not support "evacuate" function. Creates and manages host aggregates. An aggregate assigns metadata to groups of compute nodes. Aggregates are only visible to the cloud provider. GET v2/tenant_id/osaggregates Lists all aggregates. POST v2/tenant_id/osaggregates DELETE v2/tenant_id/osaggregates/ aggregate_id GET v2/tenant_id/osaggregates/ aggregate_id PUT v2/tenant_id/osaggregates/ aggregate_id POST v2/tenant_id/osaggregates/ aggregate_id/action POST v2/tenant_id/osaggregates/ aggregate_id/action Creates an aggregate. Deletes an aggregate. Gets details about a specified aggregate. Updates the name, and optionally the availability zone, for a specified aggregate. Sets metadata for an aggregate. Adds a host to an aggregate. N N Both Hyper-V and Libvirt drivers in OpenStack do not implement this function. N N Both Hyper-V and Libvirt drivers in OpenStack do not implement this function. Chapter 2. IBM OpenStack REST API reference 187

194 Table 8. Nova API services (continued) API POST v2/tenant_id/osaggregates/ aggregate_id/action Server Console Output Description Removes a host from an aggregate. IBM Cloud Manager with OpenStack for OpenStack Management IBM Cloud Manager with OpenStack for Base OpenStack IaaS Hypervisor N N Both Hyper-V and Libvirt drivers in OpenStack do not implement this function. Gets the output from the console log for a server. POST v2/tenant_id/servers/ server_id/action Server Extended Create Gets console output. Not supported by PowerVC driver. Shows extra information when you create a server. POST v2/tenant_id/servers GET v2/tenant_id/servers/ server_id GET v2/tenant_id/servers/ detail Server Force Delete or Restore Creates a server with the config_drive extended attribute. Shows information for a specified server, including the config_drive extended attribute. Lists details for all servers, including the config_drive extended attribute. Config drive is not supported by PowerVC driver. Config drive is not supported by PowerVC driver. Config drive is not supported by PowerVC driver. Restores or force-deletes a server when you deploy nova with deferred delete on. Note: Soft delete (that is deferred delete) is not supported by PowerVC driver. POST v2/tenant_id/servers/ server_id/action Force-deletes a server. POST v2/tenant_id/servers/ server_id/action Disk Config Reverses the deletion of a server. Extends servers and images with a diskconfig attribute. Note: Automatic disk configuration is not supported bypowervc driver. POST v2/tenant_id/servers Creates a server. GET v2/tenant_id/servers/ server_id PUT v2/tenant_id/servers/ server_id Shows information for a specified server. Updates a specified server. 188 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

195 Table 8. Nova API services (continued) API POST v2/tenant_id/servers/ server_id/action POST v2/tenant_id/servers/ server_id/action GET v2/tenant_id/servers/ detail GET v2/tenant_id/images/ image_id GET v2/tenant_id/images/ detail Extended Availability Zones Description IBM Cloud Manager with OpenStack for OpenStack Management Resizes a server. Rebuilds a specified server. Lists servers. Describes a specific image. Lists images. IBM Cloud Manager with OpenStack for Base OpenStack IaaS Hypervisor Shows the instance availability zone for compute nodes (nova-compute). Internal services appear in their own availability zone. GET v2/tenant_id/servers/ server_id GET v2/tenant_id/servers/ detail Image Size Gets the availability zone for the specified instance. Lists the details for all servers. Includes their current availability zone. Lists details for available images or gets details for a specified image. Includes the OS-EXT-IMG-SIZE:size extended attribute, which shows the image size. GET v2/tenant_id/v2/ images/detail GET v2/tenant_id/v2/ image/image_id Server IP Type Lists details for available images. Includes the image size. Gets details for a specified image. Includes the image size. Shows the type of the IP addresses assigned to an instance. Type is either fixed or floating. GET v2/tenant_id/servers/ server_id/action Shows the type of IP assigned to a specified server, either fixed or floating. Chapter 2. IBM OpenStack REST API reference 189

196 Table 8. Nova API services (continued) API Description IBM Cloud Manager with OpenStack for OpenStack Management IBM Cloud Manager with OpenStack for Base OpenStack IaaS Hypervisor GET v2/tenant_id/servers/ detail Lists all servers and show their IPs by type, either fixed or floating. Server Extended Attributes Shows metadata for servers. GET v2/servers Shows detailed extended server attribute information for all servers. GET v2/servers/server_id Shows extended server attributes for a specified server. Server Extended Status Shows extended status information, vm_state, task_state, and power_state, in detailed server responses. GET v2/tenant_id/servers/ server_id GET v2/tenant_id/servers/ detail Fixed IPs Shows the extended status attributes - vm_state, power_state, and task_state - in the response for a specified server. Shows the extended status attributes - vm_state, power_state, and task_state - in the detailed response for all servers. Shows data for a specified fixed IP, such as host name, CIDR, and address. Also, reserves or frees a fixed IP. GET v2/tenant_id/os-fixedips/fixed-ip POST v2/tenant_id/os-fixedips/fixed-ip/action Gets data about a specified fixed IP address. N. Reserves a fixed IP. N. This API is only supported by Nova-Network. Neutron does not support it. This API is only supported by Nova-Network. Neutron does not support it. N. This API is only supported by Nova-Network. Neutron does not support it. N. This API is only supported by Nova-Network. Neutron does not support it. 190 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

197 Table 8. Nova API services (continued) API POST v2/tenant_id/os-fixedips/fixed-ip/action Flavor Access Description Unreserves a fixed IP. N. IBM Cloud Manager with OpenStack for OpenStack Management This API is only supported by Nova-Network. Neutron does not support it. IBM Cloud Manager with OpenStack for Base OpenStack IaaS N. This API is only supported by Nova-Network. Neutron does not support it. Hypervisor Creates and gets details for private flavors. Also, lists, adds, and removes tenant access to private flavors. GET v2/tenant_id/flavors POST v2/tenant_id/flavors GET v2/tenant_id/flavors/ flavor_id GET v2/tenant_id/flavors/ flavor_id/os-flavoraccess POST v2/tenant_id/flavors/ flavor_id/action POST v2/tenant_id/flavors/ flavor_id/action Flavor Extra-Specs Lists all flavors. Includes the access type, which is public or private. Creates a private flavor. Gets the flavor access type, which is either public or private. Lists tenants with access to the specified private flavor. Gives the specified tenant access to the specified private flavor. Revokes access from the specified tenant for the specified private flavor. Lists, creates, and updates the extra-specs or keys for a flavor. GET v2/tenant_id/flavors/ flavor_id/osextra_specs POST v2/tenant_id/flavors/ flavor_id/osextra_specs PUT v2/tenant_id/flavors/ flavor_id/osextra_specs GET v2/tenant_id/flavors/ flavor_id/osextra_specs/key Lists the extra-specs or keys for the specified flavor. Creates extra-specs or keys for the specified flavor. Updates the value of the specified extra-spec or key. Gets the value of the specified key. Chapter 2. IBM OpenStack REST API reference 191

198 Table 8. Nova API services (continued) API Description IBM Cloud Manager with OpenStack for OpenStack Management IBM Cloud Manager with OpenStack for Base OpenStack IaaS Hypervisor Flavors with rxtx_factor Extended Attribute Creates a flavor, gets details for a specified flavor, and lists details for available flavors. Includes the extended attribute, which is related to configured bandwidth cap values. POST v2/tenant_id/flavors GET v2/tenant_id/flavors/ flavor_id GET v2/tenant_id/flavors/ detail Creates a flavor. Includes the rxtx_factor extended attribute. Gets details for a specified flavor. Includes the rxtx_factor extended attribute. Lists details for available flavors. Includes the rxtx_factor extended attribute. Flavors with Extended Attributes Creates a flavor, gets details for a flavor, and lists details for available flavors. Includes the rxrx_factor, OS-FLV-EXT-DATA:ephemeral, and swap extended attributes. POST v2/tenant_id/flavors GET v2/tenant_id/flavors/ flavor_id GET v2/tenant_id/flavors/ detail Flavors Create or Delete Creates a flavor. Includes the rxtx_factor, OS-FLV-EXT- DATA:ephemeral, and swap extended attributes. Gets details for a specified flavor. Includes the rxtx_factor, OS-FLV-EXT- DATA:ephemeral, and swap extended attributes. Lists details for available flavors. Includes the rxtx_factor, OS-FLV-EXT- DATA:ephemeral, and swap extended attributes. Creates or deletes flavors. POST v2/tenant_id/flavors Creates a flavor. 192 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

199 Table 8. Nova API services (continued) API DELETE v2/tenant_id/flavors/ flavor_id Hosts Description IBM Cloud Manager with OpenStack for OpenStack Management Deletes a flavor. IBM Cloud Manager with OpenStack for Base OpenStack IaaS Hypervisor Manages physical hosts. GET v2/tenant_id/os-hosts Lists all hosts. GET v2/tenant_id/hostname PUT v2/tenant_id/hostname POST v2/tenant_id/hostname POST v2/tenant_id/hostname POST v2/tenant_id/hostname Hypervisors Shows information for a specified host. Enables a host or puts it in maintenance mode. N N Both Hyper-V and KVM drivers do not implement this function on OpenStack Starts a host. N N Both Hyper-V and KVM drivers do not implement this function on OpenStack Shuts down a host. N N Both Hyper-V and KVM drivers do not implement this function on OpenStack Reboots a host. N N Both Hyper-V and KVM drivers do not implement this function on OpenStack Displays extra statistical information from the system that hosts the hypervisor through the API for the hypervisor (XenAPI or KVM/libvirt). GET v2/tenant_id/oshypervisors GET v2/tenant_id/oshypervisors/hostname/servers Lists hypervisors information for each server that is obtained through the hypervisor-specific API, such as libvirt or XenAPI. Shows detailed hypervisors API information for each server. Typically configured as an admin-only extension by using policy.json settings. Chapter 2. IBM OpenStack REST API reference 193

200 Table 8. Nova API services (continued) API Description IBM Cloud Manager with OpenStack for OpenStack Management IBM Cloud Manager with OpenStack for Base OpenStack IaaS Hypervisor Server List Actions or Get Action Details Provides rights to all users to list available actions for a specified server. Provides permissions for administrators to get details for a specified action for a specified server. GET v2/tenant_id/servers/ server_id/os-instanceactions GET v2/tenant_id/servers/ server_id/os-instanceactions/action_id Keypairs Lists available actions for a specified server. Deployers set permissions for this request in the file. By default, all users can list actions. Gets details for a specified action for a specified server instance. Deployers set permissions for this request in the file. By default, only administrators can get details for an action. Generates, imports, and deletes SSH keys. GET v2/tenant_id/oskeypairs POST v2/tenant_id/oskeypairs DELETE v2/tenant_id/oskeypairs/keypair_name GET v2/tenant_id/oskeypairs/keypair_name Server Multiple Create Lists keypairs associated with the account. Generates or imports a keypair. Not supported by PowerVC driver. Not supported by PowerVC driver. Deletes a keypair. Not supported by PowerVC driver. Shows a keypair that is associated with the account. Not supported by PowerVC driver. Creates one or more servers with an optional reservation ID. The request and response examples show how to create multiple servers with or without a reservation ID. POST v2/tenant_id/servers Quota Sets Creates one or more servers with an optional reservation ID. Permits administrators, depending on policy settings, to view quotas for a tenant and view and update default quotas. To use quotas, The quota_driver has to be set to nova.quota.dbquotadriver. 194 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

201 Table 8. Nova API services (continued) API Description IBM Cloud Manager with OpenStack for OpenStack Management IBM Cloud Manager with OpenStack for Base OpenStack IaaS Hypervisor GET v2/tenant_id/os-quotasets/tenant_id Shows quotas for a tenant. POST v2/tenant_id/os-quotasets/tenant_id Updates quotas for a tenant. GET v2/tenant_id/os-quotasets/tenant_id/defaults Gets default quotas for a tenant. Server Rescue Rescues or unrescues a server. POST v2/tenant_id/servers/ server_id/action POST v2/tenant_id/servers/ server_id/action Scheduler Hints Puts a server in rescue mode. Changes status to RESCUE. Returns a server to its state before it was rescued. Not supported by PowerVC driver. Not supported by PowerVC driver. Provides information directly to the scheduler when you create a server. POST v2/tenant_id/servers Security Groups Creates a server by using scheduler hints. Creates, modifies, and deletes security groups and rules. Note: The PowerVC driver does not support adding or removing security groups to and from an instance. In general, security groups and security group rules are not supported by PowerVC driver currently. GET v2/tenant_id/ossecurity-groups Lists security groups. POST v2/tenant_id/ossecurity-groups GET v2/tenant_id/ossecurity-groups/ security_group_id DELETE v2/tenant_id/ossecurity-groups/ security_group_id POST v2/tenant_id/ossecurity-group-rules Creates a security group. Gets information for a specified security group. Deletes a specified security group. Creates a security group rule. Chapter 2. IBM OpenStack REST API reference 195

202 Table 8. Nova API services (continued) API Description IBM Cloud Manager with OpenStack for OpenStack Management IBM Cloud Manager with OpenStack for Base OpenStack IaaS Hypervisor POST v2/tenant_id/ossecurity-group-rules/ rule_id Deletes a security group rule. GET v2/tenant_id/servers/ server_id/os-securitygroups Lists security groups for a specified server. Server Start or Stop Starts or stops a server. POST v2/tenant_id/servers/ server_id/action Halts a running server. Changes status to STOPPED. POST v2/tenant_id/servers/ server_id/action Returns a STOPPED server to ACTIVE status. Manage Services Lists, enables, and disables Nova services in all hosts. GET v2/tenant_id/osservices PUT v2/tenant_id/osservices PUT v2/tenant_id/osservices Usage Reports Lists all running services. Enables scheduling for a service. Disables scheduling for a service. Reports usage statistics on compute and storage resources. GET v2/tenant_id/ossimple-tenant-usage GET v2/tenant_id/ossimple-tenant-usage/ tenant_id Virtual Interfaces Lists usage information for all tenants. Gets usage information for a tenant. Lists the virtual interfaces for a specified server instance. GET v2/tenant_id/servers/ server_id/os-vertualinterfaces Lists the virtual interfaces for a specified instance. 196 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

203 Table 8. Nova API services (continued) API Description IBM Cloud Manager with OpenStack for OpenStack Management IBM Cloud Manager with OpenStack for Base OpenStack IaaS Hypervisor Volume Attachments Attaches volumes created through the volume API to server instances. Also, lists volume attachments for a server instance, gets volume details for a volume attachment, and deletes a volume attachment. POST v2/servers/server_id/ os-volume_attachments GET v2/servers/server_id/ os-volume_attachments GET v2/servers/server_id/ os-volume_attachments/ attachment_id DELETE v2/servers/server_id/ os-volume_attachments/ attachment_id Attaches a volume to the specified server. Lists the volume attachments for the specified server. Lists volume details for the specified volume attachment ID. Deletes the specified volume attachment from the specified server. Chapter 2. IBM OpenStack REST API reference 197

204 198 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

205 Related information Find information related to this publication. IBM Knowledge Center IBM Cloud Manager with OpenStack Copyright IBM Corp. 2011,

206 200 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

207 Accessibility IBM Cloud Manager with OpenStack does not interfere with the accessibility features for supported browsers. For a comprehensive list of accessibility features please visit the accessibility support page for the supported browser that you are using. For a list of supported browsers, see Supported web browsers. No hardcopy publications are shipped with this program. The IBM Knowledge Center is a worldwide central repository of IBM technical publications hosted in a single application, located at a single URL: Find and navigate technical content more efficiently and easily with improved search, filtering and user experience. Create your own collections of IBM documents with PDF output on-demand. Note: ou can find the IBM Cloud OpenStack Platform product collection here: When you send information to IBM, you grant IBM a nonexclusive right to use or distribute the information in any way it believes appropriate without incurring any obligation to you. Copyright IBM Corp. 2011,

208 202 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

209 Notices This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-ibm product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. ou can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, N U.S.A. The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANT OF AN KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILIT OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you. This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice. Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact: IBM Corporation Dept. LRAS/Bldg Burnet Road Austin, TX U.S.A. Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee. The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us. Copyright IBM Corp. 2011,

210 For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to: Intellectual Property Licensing Legal and Intellectual Property Law IBM Japan, Ltd , Nihonbashi-Hakozakicho, Chuo-ku Tokyo , Japan IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you. Information concerning non-ibm products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-ibm products. Questions on the capabilities of non-ibm products should be addressed to the suppliers of those products. Any references in this information to non-ibm Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk. This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. Trademarks IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business Machines Corporation in the United States, other countries, or both. If these and other IBM trademarked terms are marked on their first occurrence in this information with a trademark symbol ( and ), these symbols indicate U.S. registered or common law trademarks owned by IBM at the time this information was published. Such trademarks may also be registered or common law trademarks in other countries. A current list of IBM trademarks is available on the Web at Copyright and trademark information at Adobe, the Adobe logo, PostScript, and the PostScript logo are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States, and/or other countries. Intel, Intel logo, Intel Inside, Intel Inside logo, Intel Centrino, Intel Centrino logo, Celeron, Intel Xeon, Intel SpeedStep, Itanium, and Pentium are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States and other countries. Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates. Linux is a trademark of Linus Torvalds in the United States, other countries, or both. Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both. 204 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

211 UNIX is a registered trademark of The Open Group in the United States and other countries. Other company, product, or service names may be trademarks or service marks of others. Privacy policy considerations IBM Software products, including software as a service solutions, ( Software Offerings ) may use cookies or other technologies to collect product usage information, to help improve the end user experience, to tailor interactions with the end user or for other purposes. In many cases no personally identifiable information is collected by the Software Offerings. Some of our Software Offerings can help enable you to collect personally identifiable information. If this Software Offering uses cookies to collect personally identifiable information, specific information about this offering s use of cookies is set forth below. Depending upon the configurations deployed, this Software Offering may use session and persistent cookies that collect each user s user name and password for purposes of session management, authentication, and enhanced user usability. These cookies cannot be disabled. If the configurations deployed for this Software Offering provide you as customer the ability to collect personally identifiable information from end users via cookies and other technologies, you should seek your own legal advice about any laws applicable to such data collection, including any requirements for notice and consent. For more information about the use of various technologies, including cookies, for these purposes, See IBM s Privacy Policy at and IBM s Online Privacy Statement at the section entitled Cookies, Web Beacons and Other Technologies and the IBM Software Products and Software-as-a-Service Privacy Statement at Code license and disclaimer information IBM grants you a nonexclusive copyright license to use all programming code examples from which you can generate similar function tailored to your own specific needs. SUBJECT TO AN STATUTOR WARRANTIES WHICH CANNOT BE EXCLUDED, IBM, ITS PROGRAM DEVELOPERS AND SUPPLIERS MAKE NO WARRANTIES OR CONDITIONS EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OR CONDITIONS OF MERCHANTABILIT, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT, REGARDING THE PROGRAM OR TECHNICAL SUPPORT, IF AN. UNDER NO CIRCUMSTANCES IS IBM, ITS PROGRAM DEVELOPERS OR SUPPLIERS LIABLE FOR AN OF THE FOLLOWING, EVEN IF INFORMED OF THEIR POSSIBILIT: 1. LOSS OF, OR DAMAGE TO, DATA; 2. DIRECT, SPECIAL, INCIDENTAL, OR INDIRECT DAMAGES, OR FOR AN ECONOMIC CONSEQUENTIAL DAMAGES; OR 3. LOST PROFITS, BUSINESS, REVENUE, GOODWILL, OR ANTICIPATED SAVINGS. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OR LIMITATION OF DIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, SO SOME OR ALL OF THE ABOVE LIMITATIONS OR EXCLUSIONS MA NOT APPL TO OU. Notices 205

212 206 IBM Cloud Manager with OpenStack: REST API Reference, version 4.1

213

214 Printed in USA