StarlingX API Documentation

this page last updated: 2019-04-10 18:55:43.660307

Dcmanager API v1¶

Manage distributed cloud operations with the dcmanager API.

The typical port used for the dcmanager REST API is 8119. However, proper technique would be to look up the dcmanager service endpoint in Keystone.

API versions¶

GET

Lists information about all dcmanager API versions

Normal response codes

200, 300

Error response codes

itemNotFound (404), badRequest (400), unauthorized (401), forbidden (403), badMethod (405), HTTPUnprocessableEntity (422), internalServerError (500), serviceUnavailable (503)

{
  "versions": [
    {
      "status": "CURRENT",
      "updated": "2017-10-2",
      "id": "v1.0",
      "links": [
        {
          "href": "http://192.168.204.2:8119/v1.0/",
          "rel": "self"
        }
      ]
    }
  ]
}

This operation does not accept a request body.

Subclouds¶

Subclouds are systems managed by a central System Controller.

GET

/v1.0/subclouds

Lists all subclouds

Normal response codes

200

Error response codes

itemNotFound (404), badRequest (400), unauthorized (401), forbidden (403), badMethod (405), HTTPUnprocessableEntity (422), internalServerError (500), serviceUnavailable (503)

Response parameters

Parameter	Style	Type	Description
subclouds (Optional)	plain	xsd:list	The list of subclouds.
id (Optional)	plain	xsd:int	The unique identifier for this object.
created_at (Optional)	plain	xsd:dateTime	The time when the object was created.
updated_at (Optional)	plain	xsd:dateTime	The time when the object was last updated.
name (Optional)	plain	xsd:string	The name provisioned for the subcloud.
management (Optional)	plain	xsd:string	Management state of the subcloud.
availability (Optional)	plain	xsd:string	Availability status of the subcloud.
management-subnet (Optional)	plain	xsd:string	Management subnet for subcloud in CIDR format.
management-start-ip (Optional)	plain	xsd:string	Start of management IP address range for subcloud.
management-end-ip (Optional)	plain	xsd:string	End of management IP address range for subcloud.
systemcontroller-gateway-ip (Optional)	plain	xsd:string	Systemcontroller gateway IP Address.
endpoint_sync_status (Optional)	plain	xsd:list	The list of endpoint sync statuses.
platform_sync_status (Optional)	plain	xsd:string	The platform sync status of the subcloud.
volume_sync_status (Optional)	plain	xsd:string	The volume sync status of the subcloud.
compute_sync_status (Optional)	plain	xsd:string	The compute sync status of the subcloud.
network_sync_status (Optional)	plain	xsd:string	The network sync status of the subcloud.
patching_sync_status (Optional)	plain	xsd:string	The patching sync status of the subcloud.

{
  "subclouds": [
    {
       "description": None,
       "management-start-ip": "192.168.204.50",
       "sync_status": "unknown",
       "updated-at": None,
       "software-version": "18.01",
       "management-state": "unmanaged",
       "availability-status": "offline",
       "management-subnet": "192.168.204.0/24",
       "systemcontroller-gateway-ip": "192.168.204.101",
       "subcloud_id": 1,
       "location": None,
       "endpoint_sync_status": [
         {
           "sync_status": "unknown",
           "endpoint_type": "platform"
         },
         {
           "sync_status": "unknown",
           "endpoint_type": "volume"
         },
         {
           "sync_status":  "unknown",
           "endpoint_type":  "compute"
         },
         {
           "sync_status": "unknown",
           "endpoint_type": "network"
         },
         {
           "sync_status": "unknown",
           "endpoint_type": "patching"
         },
       "created-at": u"2018-02-25 19:06:35.208505",
       "management-gateway-ip": u"192.168.204.1",
       "management-end-ip": u"192.168.204.100",
       "id": 1,
       "name": "subcloud6"
    },
    {
       "description": "test subcloud",
       "management-start-ip": "192.168.205.50",
       "sync_status": "in-sync",
       "updated-at": None,
       "software-version": "18.01",
       "management-state": "managed",
       "availability-status": "online",
       "management-subnet": "192.168.205.0/24",
       "systemcontroller-gateway-ip": "192.168.205.101",
       "subcloud_id": 2,
       "location": "Ottawa,
       "endpoint_sync_status": [
         {
           "sync_status": "in-sync",
           "endpoint_type": "platform"
         },
         {
           "sync_status": "in-sync",
           "endpoint_type": "volume"
         },
         {
           "sync_status":  "in-sync",
           "endpoint_type":  "compute"
         },
         {
           "sync_status": "in-sync",
           "endpoint_type": "network"
         },
         {
           "sync_status": "out-of-sync",
           "endpoint_type": "patching"
         },
       "created-at": "2018-02-25 19:06:35.208505",
       "management-gateway-ip": "192.168.205.1",
       "management-end-ip": "192.168.205.100",
       "id": 2,
       "name": "subcloud7"
    },
  ]
}

This operation does not accept a request body.

POST

/v1.0/subclouds

Creates a subcloud

Normal response codes

200

Error response codes

badRequest (400), unauthorized (401), forbidden (403), badMethod (405), HTTPUnprocessableEntity (422), internalServerError (500), serviceUnavailable (503)

Request parameters

Parameter	Style	Type	Description
name	plain	xsd:string	The name for the subcloud. Must be a unique name.
description (Optional)	plain	xsd:string	The description of the subcloud.
location (Optional)	plain	xsd:string	The location of the subcloud.
management-subnet	plain	xsd:string	Management subnet for subcloud in CIDR format. Must be unique.
management-start-ip	plain	xsd:string	Start of management IP address range for subcloud.
management-end-ip	plain	xsd:string	End of management IP address range for subcloud.
systemcontroller-gateway-ip	plain	xsd:string	Systemcontroller gateway IP Address.

Response parameters

Parameter	Style	Type	Description
id (Optional)	plain	xsd:int	The unique identifier for this object.
created_at (Optional)	plain	xsd:dateTime	The time when the object was created.
updated_at (Optional)	plain	xsd:dateTime	The time when the object was last updated.
name (Optional)	plain	xsd:string	The name provisioned for the subcloud.
management (Optional)	plain	xsd:string	Management state of the subcloud.
availability (Optional)	plain	xsd:string	Availability status of the subcloud.
management-subnet (Optional)	plain	xsd:string	Management subnet for subcloud in CIDR format.
management-start-ip (Optional)	plain	xsd:string	Start of management IP address range for subcloud.
management-end-ip (Optional)	plain	xsd:string	End of management IP address range for subcloud.
systemcontroller-gateway-ip (Optional)	plain	xsd:string	Systemcontroller gateway IP Address.

{
  "name": "subcloud7",
  "management-start-ip": "192.168.205.110",
  "systemcontroller-gateway-ip": "192.168.204.102",
  "location": "West Ottawa",
  "management-subnet": "192.168.205.0/24",
  "management-gateway-ip": "192.168.205.1",
  "management-end-ip": "192.168.205.160",
  "description": "new subcloud"
}

{
  "description": None,
  "management-start-ip": "192.168.205.110",
  "created-at": "2018-02-25T22:17:11.845596",
  "updated-at": None,
  "software-version": "18.01",
  "management-state": "unmanaged",
  "availability-status": "offline",
  "systemcontroller-gateway-ip": "192.168.204.102",
  "location": None,
  "management-subnet": "192.168.205.0/24",
  "management-gateway-ip": "192.168.205.1",
  "management-end-ip": "192.168.205.160",
  "id": 4,
  "name": "subcloud7"
}

GET

/v1.0/subclouds/{subcloud}

Shows detailed information about a specific subcloud

Normal response codes

200

Error response codes

itemNotFound (404), badRequest (400), unauthorized (401), forbidden (403), badMethod (405), HTTPUnprocessableEntity (422), internalServerError (500), serviceUnavailable (503)

Request parameters

Parameter	Style	Type	Description
subcloud	URI	xsd:string	The subcloud reference, name or id.

Response parameters

Parameter	Style	Type	Description
id (Optional)	plain	xsd:int	The unique identifier for this object.
created_at (Optional)	plain	xsd:dateTime	The time when the object was created.
updated_at (Optional)	plain	xsd:dateTime	The time when the object was last updated.
name (Optional)	plain	xsd:string	The name provisioned for the subcloud.
management (Optional)	plain	xsd:string	Management state of the subcloud.
availability (Optional)	plain	xsd:string	Availability status of the subcloud.
management-subnet (Optional)	plain	xsd:string	Management subnet for subcloud in CIDR format.
management-start-ip (Optional)	plain	xsd:string	Start of management IP address range for subcloud.
management-end-ip (Optional)	plain	xsd:string	End of management IP address range for subcloud.
systemcontroller-gateway-ip (Optional)	plain	xsd:string	Systemcontroller gateway IP Address.
endpoint_sync_status (Optional)	plain	xsd:list	The list of endpoint sync statuses.
platform_sync_status (Optional)	plain	xsd:string	The platform sync status of the subcloud.
volume_sync_status (Optional)	plain	xsd:string	The volume sync status of the subcloud.
compute_sync_status (Optional)	plain	xsd:string	The compute sync status of the subcloud.
network_sync_status (Optional)	plain	xsd:string	The network sync status of the subcloud.
patching_sync_status (Optional)	plain	xsd:string	The patching sync status of the subcloud.

{
  "description": "test subcloud",
  "management-start-ip": "192.168.204.50",
  "created-at": "2018-02-25 19:06:35.208505",
  "updated-at": "2018-02-25 21:35:59.771779",
  "software-version": "18.01",
  "management-state": "unmanaged",
  "availability-status": "offline",
  "management-subnet": "192.168.204.0/24",
  "systemcontroller-gateway-ip": "192.168.204.101",
  "location": "ottawa",
  "endpoint_sync_status": [
    {
      "sync_status": "in-sync",
      "endpoint_type": "compute"
    },
    {
      "sync_status": "in-sync",
      "endpoint_type": "network"
    },
    {
      "sync_status": "in-sync",
      "endpoint_type": "patching"
    },
    {
      "sync_status": "in-sync",
      "endpoint_type": "platform"
    },
    {
      "sync_status": "in-sync",
      "endpoint_type": "volume"
    }
  ],
  "management-gateway-ip": "192.168.204.1",
  "management-end-ip": "192.168.204.100",
  "id": 1,
  "name": "subcloud6"
}

This operation does not accept a request body.

PATCH

/v1.0/subclouds/{subcloud}

Modifies a specific subcloud

The attributes of a subcloud which are modifiable:

description
location
management-state

Normal response codes

200

Error response codes

badRequest (400), unauthorized (401), forbidden (403), badMethod (405), HTTPUnprocessableEntity (422), internalServerError (500), serviceUnavailable (503)

Request parameters

Parameter	Style	Type	Description
subcloud	URI	xsd:string	The subcloud reference, name or id.
description (Optional)	plain	xsd:string	The description of the subcloud.
location (Optional)	plain	xsd:string	The location of the subcloud.
management-state (Optional)	plain	xsd:string	The management-state of the subcloud, `managed` or `unmanaged`. The subcloud must be online before this can be modified to managed.

Response parameters

Parameter	Style	Type	Description
id (Optional)	plain	xsd:int	The unique identifier for this object.
created_at (Optional)	plain	xsd:dateTime	The time when the object was created.
updated_at (Optional)	plain	xsd:dateTime	The time when the object was last updated.
name (Optional)	plain	xsd:string	The name provisioned for the subcloud.
management (Optional)	plain	xsd:string	Management state of the subcloud.
availability (Optional)	plain	xsd:string	Availability status of the subcloud.
management-subnet (Optional)	plain	xsd:string	Management subnet for subcloud in CIDR format.
management-start-ip (Optional)	plain	xsd:string	Start of management IP address range for subcloud.
management-end-ip (Optional)	plain	xsd:string	End of management IP address range for subcloud.
systemcontroller-gateway-ip (Optional)	plain	xsd:string	Systemcontroller gateway IP Address.

{
  "description": "new description",
  "location": "new location",
  "management-state": "managed"
}

{
  "description": "new description",
  "management-start-ip": "192.168.204.50",
  "created-at": "2018-02-25T19:06:35.208505",
  "updated-at": "2018-02-25T23:01:17.490090",
  "software-version": "18.01",
  "management-state": "unmanaged",
  "availability-status": "offline",
  "systemcontroller-gateway-ip": "192.168.204.101",
  "location": "new location",
  "management-subnet": "192.168.204.0/24",
  "management-gateway-ip": "192.168.204.1",
  "management-end-ip": "192.168.204.100",
  "id": 1,
  "name": "subcloud6"
}

DELETE

/v1.0/subclouds/{subcloud}

Deletes a specific subcloud

Normal response codes

204

Request parameters

Parameter	Style	Type	Description
subcloud	URI	xsd:string	The subcloud reference, name or id.

This operation does not accept a request body.

POST

/v1.0/subclouds/{subcloud}/config

Generates the configuration of a specific subcloud

Normal response codes

200

Error response codes

badRequest (400), unauthorized (401), forbidden (403), badMethod (405), HTTPUnprocessableEntity (422), internalServerError (500), serviceUnavailable (503)

Request parameters

Parameter	Style	Type	Description
subcloud	URI	xsd:string	The subcloud reference, name or id.
pxe-subnet (Optional)	plain	xsd:string	PXE boot boot subnet for subcloud in CIDR format.
management-vlan (Optional)	plain	xsd:string	VLAN for subcloud management network.
management-interface-port (Optional)	plain	xsd:string	Subcloud management interface port.
management-interface-mtu (Optional)	plain	xsd:string	Subcloud management interface mtu.
oam-subnet (Optional)	plain	xsd:string	OAM subnet for subcloud in CIDR format.
oam-gateway-ip (Optional)	plain	xsd:string	OAM gateway IP for subcloud.
oam-floating-ip (Optional)	plain	xsd:string	OAM floating IP address for subcloud.
oam-unit-0-ip (Optional)	plain	xsd:string	OAM unit 0 IP address for subcloud.
oam-unit-1-ip (Optional)	plain	xsd:string	OAM unit 1 IP address for subcloud.
oam-interface-port (Optional)	plain	xsd:string	Subcloud OAM interface port.
oam-interface-mtu (Optional)	plain	xsd:string	Subcloud OAM interface mtu.
system-mode (Optional)	plain	xsd:string	System mode, `simplex, duplex, or duplex-direct`.

{
  "oam-gateway-ip": "10.10.20.1",
  "oam-interface-mtu": "1500",
  "oam-subnet": "10.10.20.0/24",
  "management-interface-port": "enp0s3",
  "system-mode": "duplex",
  "management-interface-mtu": "1500",
  "oam-unit-1-ip": "10.10.20.4",
  "oam-interface-port": "enp0s8",
  "management-vlan": "10",
  "pxe-subnet": "192.168.205.0/24",
  "oam-unit-0-ip": "10.10.20.3",
  "oam-floating-ip": "10.10.20.2"
}

{
  "config": "[SYSTEM]\nSYSTEM_MODE=duplex\n[REGION2_PXEBOOT_NETWORK]\nPXEBOOT_CIDR = 192.168.205.0/24\n[MGMT_NETWORK]\nVLAN = 10\nCIDR = 192.168.204.0/24\nGATEWAY = 192.168.204.1\nIP_START_ADDRESS = 192.168.204.50\nIP_END_ADDRESS = 192.168.204.100\nDYNAMIC_ALLOCATION = Y\nLOGICAL_INTERFACE = LOGICAL_INTERFACE_1\n[LOGICAL_INTERFACE_1]\nLAG_INTERFACE = N\nINTERFACE_MTU = 1500\nINTERFACE_PORTS = enp0s3\n[OAM_NETWORK]\nCIDR = 10.10.20.0/24\nGATEWAY = 10.10.20.1\nIP_FLOATING_ADDRESS = 10.10.20.2\nIP_UNIT_0_ADDRESS = 10.10.20.3\nIP_UNIT_1_ADDRESS = 10.10.20.4\nLOGICAL_INTERFACE = LOGICAL_INTERFACE_2\n[LOGICAL_INTERFACE_2]\nLAG_INTERFACE = N\nINTERFACE_MTU = 1500\nINTERFACE_PORTS = enp0s8\n[SHARED_SERVICES]\nSYSTEM_CONTROLLER_SUBNET = 192.168.204.0/24\nSYSTEM_CONTROLLER_FLOATING_ADDRESS = 192.168.204.2\nREGION_NAME = RegionOne\nADMIN_PROJECT_NAME = admin\nADMIN_USER_NAME = admin\nADMIN_PASSWORD = Li69nux*\nKEYSTONE_ADMINURL = http://192.168.204.2:5000/v3\nKEYSTONE_SERVICE_NAME = keystone\nKEYSTONE_SERVICE_TYPE = identity\nGLANCE_SERVICE_NAME = glance\nGLANCE_SERVICE_TYPE = image\nGLANCE_CACHED = True\n[REGION_2_SERVICES]\nREGION_NAME = subcloud6\n[VERSION]\nRELEASE = 18.01\n"
}

Subcloud Alarms¶

Subcloud alarms are aggregated on the System Controller.

GET

/v1.0/alarms

Summarizes alarms from all subclouds

Normal response codes

200

Error response codes

itemNotFound (404), badRequest (400), unauthorized (401), forbidden (403), badMethod (405), HTTPUnprocessableEntity (422), internalServerError (500), serviceUnavailable (503)

Response parameters

Parameter	Style	Type	Description
alarm_summary (Optional)	plain	xsd:list	The list of alarm summaries.
uuid (Optional)	plain	csapi:UUID	The unique identifier for this object.
region_name (Optional)	plain	xsd:string	The name provisioned for the subcloud (synonym for subcloud name).
cloud_status (Optional)	plain	xsd:string	The overall alarm status of the cloud.
warnings (Optional)	plain	xsd:int	The number of warnings for the cloud (-1 when the cloud_status is disabled).
minor_alarms (Optional)	plain	xsd:int	The number of minor alarms for the cloud (-1 when the cloud_status is disabled).
critical_alarms (Optional)	plain	xsd:int	The number of critical alarms for the cloud (-1 when the cloud_status is disabled).
major_alarms (Optional)	plain	xsd:int	The number of major alarms for the cloud (-1 when the cloud_status is disabled).

{
  "alarm_summary": [
    {
      "cloud_status": "disabled",
      "region_name": "subcloud6",
      "warnings": -1,
      "minor_alarms": -1,
      "critical_alarms": -1,
      "major_alarms": -1,
      "uuid": "32b9233e-d993-45fb-96eb-5bfa9b1cad5d"
    }
  ]
}

This operation does not accept a request body.

Subcloud Patch Strategy¶

The Subcloud patch strategy is configurable.

GET

/v1.0/sw-update-strategy

Shows the details of the patch strategy

Normal response codes

200

Error response codes

itemNotFound (404), badRequest (400), unauthorized (401), forbidden (403), badMethod (405), HTTPUnprocessableEntity (422), internalServerError (500), serviceUnavailable (503)

Response parameters

Parameter	Style	Type	Description
subcloud-apply-type (Optional)	plain	xsd:string	Subcloud apply type
state (Optional)	plain	xsd:string	The state of patching.
stop-on-failure (Optional)	plain	xsd:string	Whether to stop patching on failure or not.
type (Optional)	plain	xsd:string	Will be set to: `patch`.
max-parallel-subclouds (Optional)	plain	xsd:int	The number of subclouds to patch in parallel.
id (Optional)	plain	xsd:int	The unique identifier for this object.
created_at (Optional)	plain	xsd:dateTime	The time when the object was created.
updated_at (Optional)	plain	xsd:dateTime	The time when the object was last updated.

{
  "max-parallel-subclouds": 2,
  "updated-at": None,
  "created-at": "2018-02-25T23:23:53.852473",
  "subcloud-apply-type": "serial",
  "state": "initial",
  "stop-on-failure": True,
  "type": "patch",
  "id": 2
}

This operation does not accept a request body.

POST

/v1.0/sw-update-strategy

Creates the patch strategy

subcloud-apply-type,
max-parallel-subclouds,
stop-on-failure,
cloud_name,

Normal response codes

200

Error response codes

badRequest (400), unauthorized (401), forbidden (403), badMethod (405), HTTPUnprocessableEntity (422), internalServerError (500), serviceUnavailable (503)

Request parameters

Parameter	Style	Type	Description
subcloud-apply-type (Optional)	plain	xsd:string	Subcloud apply type, `parallel` or `serial`.
max-parallel-subclouds (Optional)	plain	xsd:string	Maximum number of parallel subclouds.
stop-on-failure (Optional)	plain	xsd:string	Whether stop patching any additional subclouds after a failure or not, `True` or `False`.
cloud_name (Optional)	plain	xsd:string	Name of a single cloud to patch.
type (Optional)	plain	xsd:string	Must be set to: `patch`.

Response parameters

Parameter	Style	Type	Description
subcloud-apply-type (Optional)	plain	xsd:string	Subcloud apply type
state (Optional)	plain	xsd:string	The state of patching.
stop-on-failure (Optional)	plain	xsd:string	Whether to stop patching on failure or not.
type (Optional)	plain	xsd:string	Will be set to: `patch`.
max-parallel-subclouds (Optional)	plain	xsd:int	The number of subclouds to patch in parallel.
id (Optional)	plain	xsd:int	The unique identifier for this object.
created_at (Optional)	plain	xsd:dateTime	The time when the object was created.
updated_at (Optional)	plain	xsd:dateTime	The time when the object was last updated.

{
  "subcloud-apply-type": "serial",
  "type": "patch",
  "stop-on-failure": "true",
  "max-parallel-subclouds": 2
}

{
  "max-parallel-subclouds": 2,
  "updated-at": None,
  "created-at": "2018-02-25T23:23:53.852473",
  "subcloud-apply-type": "serial",
  "state": "initial",
  "stop-on-failure": True,
  "type": "patch",
  "id": 2
}

DELETE

/v1.0/sw-update-strategy

Deletes the patch strategy from the database

Normal response codes

204

This operation does not accept a request body.

Subcloud Patch Strategy Actions¶

Subcloud patch strategy can be actioned.

POST

/v1.0/sw-update-strategy/actions

Executes an action on a patch strategy

Normal response codes

200

Error response codes

badRequest (400), unauthorized (401), forbidden (403), badMethod (405), HTTPUnprocessableEntity (422), internalServerError (500), serviceUnavailable (503)

Request parameters

Parameter	Style	Type	Description
action (Optional)	plain	xsd:string	Perform one of the following actions on the patch strategy: Valid values are: `apply`, or `abort`.

Response parameters

Parameter	Style	Type	Description
subcloud-apply-type (Optional)	plain	xsd:string	Subcloud apply type
state (Optional)	plain	xsd:string	The state of patching.
stop-on-failure (Optional)	plain	xsd:string	Whether to stop patching on failure or not.
type (Optional)	plain	xsd:string	Will be set to: `patch`.
max-parallel-subclouds (Optional)	plain	xsd:int	The number of subclouds to patch in parallel.
id (Optional)	plain	xsd:int	The unique identifier for this object.
created_at (Optional)	plain	xsd:dateTime	The time when the object was created.
updated_at (Optional)	plain	xsd:dateTime	The time when the object was last updated.

{
  "action": "apply",
}

{
  "max-parallel-subclouds": 2,
  "updated-at": None,
  "created-at": "2018-02-25T23:23:53.852473",
  "subcloud-apply-type": "serial",
  "state": "applying",
  "stop-on-failure": True,
  "type": "patch",
  "id": 2
}

Subcloud Patch Strategy Steps¶

Subcloud patch strategy steps can be retrieved.

GET

/v1.0/sw-update-strategy/steps

Lists all patch strategy steps for all clouds

Normal response codes

200

Error response codes

itemNotFound (404), badRequest (400), unauthorized (401), forbidden (403), badMethod (405), HTTPUnprocessableEntity (422), internalServerError (500), serviceUnavailable (503)

Response parameters

Parameter	Style	Type	Description
strategy-steps (Optional)	plain	xsd:list	The list of patch strategy steps.
cloud (Optional)	plain	xsd:string	The name of the cloud to which the patch strategy steps apply.
state (Optional)	plain	xsd:string	The state of patching.
details (Optional)	plain	xsd:string	Details about patching.
stage (Optional)	plain	xsd:int	The stage of patching.

{
  "strategy-steps": [
    {
      "updated-at": None,
      "created-at": "2018-02-25T23:23:53.852473",
      "state": "initial",
      "details": "",
      "id": 1,
      "cloud": "subcloud6",
      "stage": 1
    },
    {
      "updated-at": None,
      "created-at": "2018-02-25T23:23:53.852473",
      "state": "initial",
      "details": "",
      "id": 2,
      "cloud": "subcloud7",
      "stage": 1
    },
    {
      "updated-at": None,
      "created-at": "2018-02-25T23:23:53.852473",
      "state": "initial",
      "details": "",
      "id": 3,
      "cloud": "subcloud8",
      "stage": 1
    },
  ]
}

This operation does not accept a request body.

GET

/v1.0/sw-update-strategy/steps/{cloud_name}

Shows the details of patch strategy steps for a particular cloud

Normal response codes

200

Error response codes

itemNotFound (404), badRequest (400), unauthorized (401), forbidden (403), badMethod (405), HTTPUnprocessableEntity (422), internalServerError (500), serviceUnavailable (503)

Response parameters

Parameter	Style	Type	Description
cloud (Optional)	plain	xsd:string	The name of the cloud to which the patch strategy steps apply.
state (Optional)	plain	xsd:string	The state of patching.
details (Optional)	plain	xsd:string	Details about patching.
stage (Optional)	plain	xsd:int	The stage of patching.
id (Optional)	plain	xsd:int	The unique identifier for this object.
created_at (Optional)	plain	xsd:dateTime	The time when the object was created.
updated_at (Optional)	plain	xsd:dateTime	The time when the object was last updated.

{
  "updated-at": None,
  "created-at": None,
  "state": "initial",
  "details": "",
  "id": 1,
  "cloud": "subcloud6",
  "stage": 1
}

This operation does not accept a request body.

Subcloud Patch Options¶

Subcloud Patch Options are configurable.

GET

/v1.0/sw-update-options

Lists all patch options

Normal response codes

200

Error response codes

itemNotFound (404), badRequest (400), unauthorized (401), forbidden (403), badMethod (405), HTTPUnprocessableEntity (422), internalServerError (500), serviceUnavailable (503)

Response parameters

Parameter	Style	Type	Description
sw-update-options (Optional)	plain	xsd:list	The list of patch options.
name (Optional)	plain	xsd:string	The name of the cloud to which the patch options apply.
compute-apply-type (Optional)	plain	xsd:string	Compute host apply type, `parallel` or `serial`
subcloud-id (Optional)	plain	xsd:int	The id of the cloud (will be 0 for the all clouds default).
max-parallel-computes (Optional)	plain	xsd:int	The number of compute hosts to patch in parallel.
alarm-restriction-type (Optional)	plain	xsd:string	Whether to allow patching if subcloud alarms are present or not, `strict` or `relaxed`.
storage-apply-type (Optional)	plain	xsd:string	Storage host apply type, `parallel` or `serial`.
default-instance-action (Optional)	plain	xsd:string	How instances should be handled, `stop-start` or `migrate`.
id (Optional)	plain	xsd:int	The unique identifier for this object.
created_at (Optional)	plain	xsd:dateTime	The time when the object was created.
updated_at (Optional)	plain	xsd:dateTime	The time when the object was last updated.

{
  "sw-update-options": [
    {
      "name": "all clouds default",
      "compute-apply-type": "parallel",
      "subcloud-id": None,
      "updated-at": "2018-02-25 23:34:03.099691",
      "created-at": None,
      "alarm-restriction-type": "relaxed",
      "storage-apply-type": "parallel",
      "max-parallel-computes": 3,
      "default-instance-action": "migrate",
      "id": 1
    },
    {
      "name": "subcloud6",
      "compute-apply-type": "parallel",
      "subcloud-id": 1,
      "updated-at": "2018-02-25 23:41:42.877013",
      "created-at": "2018-02-25 19:07:20.767609",
      "alarm-restriction-type": "relaxed",
      "storage-apply-type": "parallel",
      "max-parallel-computes": 3,
      "default-instance-action": "migrate",
      "id": 1
    }
  ]
}

This operation does not accept a request body.

GET

/v1.0/sw-update-options/{subcloud}

Shows patch options, defaults or per subcloud. Use

Normal response codes

200

Error response codes

itemNotFound (404), badRequest (400), unauthorized (401), forbidden (403), badMethod (405), HTTPUnprocessableEntity (422), internalServerError (500), serviceUnavailable (503)

Request parameters

Parameter	Style	Type	Description
subcloud	URI	xsd:string	The subcloud reference, name or id.

Response parameters

Parameter	Style	Type	Description
name (Optional)	plain	xsd:string	The name of the cloud to which the patch options apply.
compute-apply-type (Optional)	plain	xsd:string	Compute host apply type, `parallel` or `serial`
subcloud-id (Optional)	plain	xsd:int	The id of the cloud (will be 0 for the all clouds default).
max-parallel-computes (Optional)	plain	xsd:int	The number of compute hosts to patch in parallel.
alarm-restriction-type (Optional)	plain	xsd:string	Whether to allow patching if subcloud alarms are present or not, `strict` or `relaxed`.
storage-apply-type (Optional)	plain	xsd:string	Storage host apply type, `parallel` or `serial`.
default-instance-action (Optional)	plain	xsd:string	How instances should be handled, `stop-start` or `migrate`.
id (Optional)	plain	xsd:int	The unique identifier for this object.
created_at (Optional)	plain	xsd:dateTime	The time when the object was created.
updated_at (Optional)	plain	xsd:dateTime	The time when the object was last updated.

{
  "name": "subcloud6",
  "compute-apply-type": "parallel",
  "subcloud-id": 1,
  "updated-at": "2018-02-25 23:41:42.877013",
  "created-at": "2018-02-25 19:07:20.767609",
  "alarm-restriction-type": "relaxed",
  "storage-apply-type": "parallel",
  "max-parallel-computes": 3,
  "default-instance-action": "migrate",
  "id": 1
}

This operation does not accept a request body.

POST

/v1.0/sw-update-options/{subcloud}

Updates patch options, defaults or per subcloud. Use

storage-apply-type,
compute-apply-type,
max-parallel-computes,
alarm-restriction-type,
default-instance-action,

Normal response codes

200

Error response codes

badRequest (400), unauthorized (401), forbidden (403), badMethod (405), HTTPUnprocessableEntity (422), internalServerError (500), serviceUnavailable (503)

Request parameters

Parameter	Style	Type	Description
subcloud	URI	xsd:string	The subcloud reference, name or id.
storage-apply-type (Optional)	plain	xsd:string	Storage host apply type, `parallel` or `serial`.
compute-apply-type (Optional)	plain	xsd:string	Compute host apply type, `parallel` or `serial`.
max-parallel-computes (Optional)	plain	xsd:string	The number of compute hosts to patch in parallel.
alarm-restriction-type (Optional)	plain	xsd:string	Whether to allow patching if subcloud alarms are present or not, `strict` or `relaxed`.
default-instance-action (Optional)	plain	xsd:string	How instances should be handled, `stop-start` or `migrate`.

Response parameters

Parameter	Style	Type	Description
name (Optional)	plain	xsd:string	The name of the cloud to which the patch options apply.
compute-apply-type (Optional)	plain	xsd:string	Compute host apply type, `parallel` or `serial`
subcloud-id (Optional)	plain	xsd:int	The id of the cloud (will be 0 for the all clouds default).
max-parallel-computes (Optional)	plain	xsd:int	The number of compute hosts to patch in parallel.
alarm-restriction-type (Optional)	plain	xsd:string	Whether to allow patching if subcloud alarms are present or not, `strict` or `relaxed`.
storage-apply-type (Optional)	plain	xsd:string	Storage host apply type, `parallel` or `serial`.
default-instance-action (Optional)	plain	xsd:string	How instances should be handled, `stop-start` or `migrate`.
id (Optional)	plain	xsd:int	The unique identifier for this object.
created_at (Optional)	plain	xsd:dateTime	The time when the object was created.
updated_at (Optional)	plain	xsd:dateTime	The time when the object was last updated.

{
  "max-parallel-computes": 3,
  "default-instance-action": "migrate",
  "alarm-restriction-type": "relaxed",
  "storage-apply-type": "parallel",
  "compute-apply-type": "parallel"
}

{
  "name": "all clouds default",
  "compute-apply-type": "parallel",
  "subcloud-id": None,
  "updated-at": "2018-02-25 23:34:03.099691",
  "created-at": None,
  "alarm-restriction-type": "relaxed",
  "storage-apply-type": "parallel",
  "max-parallel-computes": 3,
  "default-instance-action": "migrate",
  "id": 1
}

DELETE

/v1.0/sw-update-options/{subcloud}

Delete per subcloud patch options

Normal response codes

204

Request parameters

Parameter	Style	Type	Description
subcloud	URI	xsd:string	The subcloud reference, name or id.

This operation does not accept a request body.

this page last updated: 2019-04-10 18:55:43.660307

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

StarlingX API Documentation

Dcmanager API v1¶

API versions¶

Subclouds¶

Subcloud Alarms¶

Subcloud Patch Strategy¶

Subcloud Patch Strategy Actions¶

Subcloud Patch Strategy Steps¶

Subcloud Patch Options¶

distributedcloud