Retrieve a list of chassis.
Parameters: |
|
---|---|
Return type: |
Retrieve information about the given chassis.
Parameters: |
|
---|---|
Return type: |
Create a new chassis.
Parameters: |
|
---|---|
Return type: |
Delete a chassis.
Parameters: |
|
---|
Update an existing chassis.
Parameters: |
|
---|---|
Return type: |
Retrieve a list of chassis with detail.
Parameters: |
|
---|---|
Return type: |
API representation of a collection of chassis.
Data samples:
{
"chassis": [
{
"description": "Sample chassis",
"links": [
{
"href": "http://localhost:6385/v1/chassis/eaaca217-e7d8-47b4-bb41-3f99f20eed89",
"rel": "self"
},
{
"href": "http://localhost:6385/v1/chassis/eaaca217-e7d8-47b4-bb41-3f99f20eed89",
"rel": "bookmark"
}
],
"uuid": "eaaca217-e7d8-47b4-bb41-3f99f20eed89"
}
]
}
<value>
<chassis>
<item>
<description>Sample chassis</description>
<links>
<item>
<href>http://localhost:6385/v1/chassis/eaaca217-e7d8-47b4-bb41-3f99f20eed89</href>
<rel>self</rel>
</item>
<item>
<href>http://localhost:6385/v1/chassis/eaaca217-e7d8-47b4-bb41-3f99f20eed89</href>
<rel>bookmark</rel>
</item>
</links>
<uuid>eaaca217-e7d8-47b4-bb41-3f99f20eed89</uuid>
</item>
</chassis>
</value>
Type: | list(Chassis) |
---|
A list containing chassis objects
API representation of a chassis.
This class enforces type checking and value constraints, and converts between the internal object model and the API representation of a chassis.
Data samples:
{
"created_at": "2000-01-01T12:00:00",
"description": "Sample chassis",
"extra": {},
"links": [
{
"href": "http://localhost:6385/v1/chassis/eaaca217-e7d8-47b4-bb41-3f99f20eed89",
"rel": "self"
},
{
"href": "http://localhost:6385/v1/chassis/eaaca217-e7d8-47b4-bb41-3f99f20eed89",
"rel": "bookmark"
}
],
"nodes": [
{
"href": "http://localhost:6385/v1/chassis/eaaca217-e7d8-47b4-bb41-3f99f20eed89/nodes",
"rel": "self"
},
{
"href": "http://localhost:6385/chassis/eaaca217-e7d8-47b4-bb41-3f99f20eed89/nodes",
"rel": "bookmark"
}
],
"updated_at": null,
"uuid": "eaaca217-e7d8-47b4-bb41-3f99f20eed89"
}
<value>
<created_at>2000-01-01T12:00:00</created_at>
<description>Sample chassis</description>
<extra />
<links>
<item>
<href>http://localhost:6385/v1/chassis/eaaca217-e7d8-47b4-bb41-3f99f20eed89</href>
<rel>self</rel>
</item>
<item>
<href>http://localhost:6385/v1/chassis/eaaca217-e7d8-47b4-bb41-3f99f20eed89</href>
<rel>bookmark</rel>
</item>
</links>
<nodes>
<item>
<href>http://localhost:6385/v1/chassis/eaaca217-e7d8-47b4-bb41-3f99f20eed89/nodes</href>
<rel>self</rel>
</item>
<item>
<href>http://localhost:6385/chassis/eaaca217-e7d8-47b4-bb41-3f99f20eed89/nodes</href>
<rel>bookmark</rel>
</item>
</nodes>
<updated_at nil="true" />
<uuid>eaaca217-e7d8-47b4-bb41-3f99f20eed89</uuid>
</value>
Type: | unicode |
---|
The description of the chassis
Type: | dict(unicode: None) |
---|
The metadata of the chassis
Type: | list(Link) |
---|
A list containing a self link and associated chassis links
Type: | list(Link) |
---|
Links to the collection of nodes contained in this chassis
Type: | uuid |
---|
The UUID of the chassis
Retrieve a list of drivers.
Return type: | DriverList |
---|
API representation of a list of drivers.
Data samples:
{
"drivers": [
{
"hosts": [
"fake-host"
],
"name": "sample-driver"
}
]
}
<value>
<drivers>
<item>
<hosts>
<item>fake-host</item>
</hosts>
<name>sample-driver</name>
</item>
</drivers>
</value>
Type: | list(Driver) |
---|
A list containing drivers objects
API representation of a driver.
Data samples:
{
"hosts": [
"fake-host"
],
"name": "sample-driver"
}
<value>
<hosts>
<item>fake-host</item>
</hosts>
<name>sample-driver</name>
</value>
Type: | list(unicode) |
---|
A list of active conductors that support this driver
Type: | list(Link) |
---|
A list containing self and bookmark links
Type: | unicode |
---|
The name of the driver
Retrieve a list of nodes.
Parameters: |
|
---|---|
Return type: |
Retrieve information about the given node.
Parameters: |
|
---|---|
Return type: |
Create a new node.
Parameters: |
|
---|---|
Return type: |
Delete a node.
Parameters: |
|
---|
Update an existing node.
Parameters: |
|
---|---|
Return type: |
Retrieve a list of nodes with detail.
Parameters: |
|
---|---|
Return type: |
Validate the driver interfaces. :type node_uuid: uuid :return type: unicode
API representation of a collection of nodes.
Data samples:
{
"nodes": [
{
"instance_uuid": "dcf1fbc5-93fc-4596-9395-b80572f6267b",
"links": [
{
"href": "http://localhost:6385/v1/nodes/1be26c0b-03f2-4d2e-ae87-c02d7f33c123",
"rel": "self"
},
{
"href": "http://localhost:6385/nodes/1be26c0b-03f2-4d2e-ae87-c02d7f33c123",
"rel": "bookmark"
}
],
"power_state": "power on",
"provision_state": "active",
"uuid": "1be26c0b-03f2-4d2e-ae87-c02d7f33c123"
}
]
}
<value>
<nodes>
<item>
<instance_uuid>dcf1fbc5-93fc-4596-9395-b80572f6267b</instance_uuid>
<links>
<item>
<href>http://localhost:6385/v1/nodes/1be26c0b-03f2-4d2e-ae87-c02d7f33c123</href>
<rel>self</rel>
</item>
<item>
<href>http://localhost:6385/nodes/1be26c0b-03f2-4d2e-ae87-c02d7f33c123</href>
<rel>bookmark</rel>
</item>
</links>
<power_state>power on</power_state>
<provision_state>active</provision_state>
<uuid>1be26c0b-03f2-4d2e-ae87-c02d7f33c123</uuid>
</item>
</nodes>
</value>
Type: | list(Node) |
---|
A list containing nodes objects
API representation of a bare metal node.
This class enforces type checking and value constraints, and converts between the internal object model and the API representation of a node.
Data samples:
{
"chassis_uuid": "edcad704-b2da-41d5-96d9-afd580ecfa12",
"console_enabled": null,
"created_at": "2000-01-01T12:00:00",
"driver": "fake",
"driver_info": {},
"extra": {},
"instance_uuid": "dcf1fbc5-93fc-4596-9395-b80572f6267b",
"last_error": null,
"links": [
{
"href": "http://localhost:6385/v1/nodes/1be26c0b-03f2-4d2e-ae87-c02d7f33c123",
"rel": "self"
},
{
"href": "http://localhost:6385/nodes/1be26c0b-03f2-4d2e-ae87-c02d7f33c123",
"rel": "bookmark"
}
],
"maintenance": null,
"ports": [
{
"href": "http://localhost:6385/v1/nodes/1be26c0b-03f2-4d2e-ae87-c02d7f33c123/ports",
"rel": "self"
},
{
"href": "http://localhost:6385/nodes/1be26c0b-03f2-4d2e-ae87-c02d7f33c123/ports",
"rel": "bookmark"
}
],
"power_state": "power on",
"properties": {
"cpus": "1",
"local_gb": "10",
"memory_mb": "1024"
},
"provision_state": "active",
"provision_updated_at": "2000-01-01T12:00:00",
"reservation": null,
"target_power_state": null,
"target_provision_state": null,
"updated_at": "2000-01-01T12:00:00",
"uuid": "1be26c0b-03f2-4d2e-ae87-c02d7f33c123"
}
<value>
<chassis_uuid>edcad704-b2da-41d5-96d9-afd580ecfa12</chassis_uuid>
<console_enabled nil="true" />
<created_at>2000-01-01T12:00:00</created_at>
<driver>fake</driver>
<driver_info />
<extra />
<instance_uuid>dcf1fbc5-93fc-4596-9395-b80572f6267b</instance_uuid>
<last_error nil="true" />
<links>
<item>
<href>http://localhost:6385/v1/nodes/1be26c0b-03f2-4d2e-ae87-c02d7f33c123</href>
<rel>self</rel>
</item>
<item>
<href>http://localhost:6385/nodes/1be26c0b-03f2-4d2e-ae87-c02d7f33c123</href>
<rel>bookmark</rel>
</item>
</links>
<maintenance nil="true" />
<ports>
<item>
<href>http://localhost:6385/v1/nodes/1be26c0b-03f2-4d2e-ae87-c02d7f33c123/ports</href>
<rel>self</rel>
</item>
<item>
<href>http://localhost:6385/nodes/1be26c0b-03f2-4d2e-ae87-c02d7f33c123/ports</href>
<rel>bookmark</rel>
</item>
</ports>
<power_state>power on</power_state>
<properties>
<item>
<key>memory_mb</key>
<value>1024</value>
</item>
<item>
<key>local_gb</key>
<value>10</value>
</item>
<item>
<key>cpus</key>
<value>1</value>
</item>
</properties>
<provision_state>active</provision_state>
<provision_updated_at>2000-01-01T12:00:00</provision_updated_at>
<reservation nil="true" />
<target_power_state nil="true" />
<target_provision_state nil="true" />
<updated_at>2000-01-01T12:00:00</updated_at>
<uuid>1be26c0b-03f2-4d2e-ae87-c02d7f33c123</uuid>
</value>
Type: | uuid |
---|
The UUID of the chassis this node belongs
Type: | boolean |
---|
Indicates whether the console access is enabled or disabled on the node.
Type: | unicode |
---|
The driver responsible for controlling the node
Type: | dict(unicode: None) |
---|
This node’s driver configuration
Type: | dict(unicode: None) |
---|
This node’s meta data
Type: | uuid |
---|
The UUID of the instance in nova-compute
Type: | unicode |
---|
Any error from the most recent (last) asynchronous transaction that
Type: | list(Link) |
---|
A list containing a self link and associated node links
Type: | boolean |
---|
Indicates whether the node is in maintenance mode.
Type: | list(Link) |
---|
Links to the collection of ports on this node
Type: | unicode |
---|
Represent the current (not transition) power state of the node
Type: | dict(unicode: None) |
---|
The physical characteristics of this node
Type: | unicode |
---|
Represent the current (not transition) provision state of the node
Type: | datetime |
---|
The UTC date and time of the last provision state change
Type: | unicode |
---|
The hostname of the conductor that holds an exclusive lock on the node.
Type: | unicode |
---|
The user modified desired power state of the node.
Type: | unicode |
---|
The user modified desired provision state of the node.
Type: | uuid |
---|
Unique UUID for this node
List the states of the node.
Parameters: |
|
---|---|
Return type: |
Set the power state of the node.
Parameters: |
|
---|---|
Raises : | ClientSideError (HTTP 409) if a power operation is already in progress. |
Raises : | InvalidStateRequested (HTTP 400) if the requested target state is not valid. |
Asynchronous trigger the provisioning of the node.
This will set the target provision state of the node, and a background task will begin which actually applies the state change. This call will return a 202 (Accepted) indicating the request was accepted and is in progress; the client should continue to GET the status of this node to observe the status of the requested action.
Parameters: |
|
---|---|
Raises : | ClientSideError (HTTP 409) if the node is already being provisioned. |
Raises : | ClientSideError (HTTP 400) if the node is already in the requested state. |
Raises : | InvalidStateRequested (HTTP 400) if the requested target state is not valid. |
API representation of the states of a node.
Data samples:
{
"console_enabled": false,
"last_error": null,
"power_state": "power on",
"provision_state": null,
"provision_updated_at": null,
"target_power_state": "power on",
"target_provision_state": "active"
}
<value>
<console_enabled>False</console_enabled>
<last_error nil="true" />
<power_state>power on</power_state>
<provision_state nil="true" />
<provision_updated_at nil="true" />
<target_power_state>power on</target_power_state>
<target_provision_state>active</target_provision_state>
</value>
Retrieve a list of ports.
Parameters: |
|
---|---|
Return type: |
Retrieve information about the given port.
Parameters: |
|
---|---|
Return type: |
Create a new port.
Parameters: |
|
---|---|
Return type: |
Delete a port.
Parameters: |
|
---|
Update an existing port.
Parameters: |
|
---|---|
Return type: |
Retrieve a list of ports with detail.
Parameters: |
|
---|---|
Return type: |
API representation of a collection of ports.
Data samples:
{
"ports": [
{
"address": "fe:54:00:77:07:d9",
"created_at": "2014-04-21T03:46:36.176920",
"extra": {
"foo": "bar"
},
"node_uuid": "7ae81bb3-dec3-4289-8d6c-da80bd8001ae",
"updated_at": "2014-04-21T03:46:36.176926",
"uuid": "27e3153e-d5bf-4b7e-b517-fb518e17f34c"
}
]
}
<value>
<ports>
<item>
<address>fe:54:00:77:07:d9</address>
<created_at>2014-04-21T03:46:36.176920</created_at>
<extra>
<item>
<key>foo</key>
<value>bar</value>
</item>
</extra>
<node_uuid>7ae81bb3-dec3-4289-8d6c-da80bd8001ae</node_uuid>
<updated_at>2014-04-21T03:46:36.176926</updated_at>
<uuid>27e3153e-d5bf-4b7e-b517-fb518e17f34c</uuid>
</item>
</ports>
</value>
Type: | list(Port) |
---|
A list containing ports objects
API representation of a port.
This class enforces type checking and value constraints, and converts between the internal object model and the API representation of a port.
Data samples:
{
"address": "fe:54:00:77:07:d9",
"created_at": "2014-04-21T03:46:36.190830",
"extra": {
"foo": "bar"
},
"node_uuid": "7ae81bb3-dec3-4289-8d6c-da80bd8001ae",
"updated_at": "2014-04-21T03:46:36.190834",
"uuid": "27e3153e-d5bf-4b7e-b517-fb518e17f34c"
}
<value>
<address>fe:54:00:77:07:d9</address>
<created_at>2014-04-21T03:46:36.190830</created_at>
<extra>
<item>
<key>foo</key>
<value>bar</value>
</item>
</extra>
<node_uuid>7ae81bb3-dec3-4289-8d6c-da80bd8001ae</node_uuid>
<updated_at>2014-04-21T03:46:36.190834</updated_at>
<uuid>27e3153e-d5bf-4b7e-b517-fb518e17f34c</uuid>
</value>
Type: | macaddress |
---|
MAC Address for this port
Type: | dict(unicode: None) |
---|
This port’s meta data
Type: | list(Link) |
---|
A list containing a self link and associated port links
Type: | uuid |
---|
The UUID of the node this port belongs to
Type: | uuid |
---|
Unique UUID for this port