Content-Type header,
+ the Accept header or adding the
+ .json extension to the request
+ URI.| Attribute | -Type | -Required | -CRUD |
- Default Value | -Validation Constraints | -Notes | -
|---|---|---|---|---|---|---|
| id | -uuid-str | -N/A | -R | -generated | -N/A | -UUID for the network. | -
| name | -String | -No | -CRU | -None | -N/A | -Human-readable name for the network. Might - not be unique. | -
| admin_state_up | -Bool | -No | -CRU | -true | -{true|false} | -The administrative state of network. If - false (down), the network does not forward - packets. | -
| status | -String | -N/A | -R | -N/A | -N/A | -|
| subnets | -list(uuid-str) | -No | -R | -Empty List | -N/A | -subnets associated with this network. - | -
| shared | -Bool | -No | -CRU | -False | -{ True | False } | -Specifies whether the network resource can - be accessed by any tenant or not. | -
| tenant_id | -uuid-str | -No |
- CR | -N/A | -No constraint | -Owner of network. Only admin users can - specify a tenant_id other than its own. - | -
| Attribute | -Type | -Required | -CRUD |
- Default Value | -Validation Constraints | -Notes | -
|---|---|---|---|---|---|---|
| id | -uuid-str | -N/A | -R | -generated | -N/A | -UUID representing the subnet | -
| network_id | -uuid-str | -Yes | -CR | -N/A | -network this subnet is associated with. | -- |
| name | -String | -No | -CRU | -None | -N/A | -Human-readable name for the subnet. Might - not be unique. | -
| ip_version | -int | -Yes | -CR | -4 | -{ 4 | 6 } | -IP version | -
| cidr | -string | -Yes | -CR | -N/A | -valid cidr in the form - <network_address>/<prefix> | -cidr representing IP range for this - subnet, based on IP version | -
| gateway_ip | -string | -No | -CRUD | -first address in |
- Valid IP address or null | -default gateway used by devices in this - subnet | -
| dns_nameservers | -list(str) | -No | -CRU | -Empty list | -No constraint | -DNS name servers used by hosts in this - subnet. | -
| allocation_pools | -list(dict) | -No | -CR | -Every address in |
- start/end of range must be valid ip | -Sub-ranges of cidr available for dynamic - allocation to ports [ { "start": - "10.0.0.2", "end": "10.0.0.254"} ] | -
| host_routes | -list(dict) | -No | -CRU | -Empty List | -
- |
- Routes that should be used by devices with - IPs from this subnet (not including local - subnet route). | -
| enable_dhcp | -Bool | -No | -CRU | -True | -{ True | False } | -Specifies whether DHCP is enabled for this - subnet or not. | -
| tenant_id | -uuid-str | -No |
- CR | -N/A | -No constraint | -Owner of network. Only admin users can - specify a tenant_id other than its own. - | -
| Attribute | -Type | -Required | -CRUD |
- Default Value | -Validation Constraints | -Notes | -
|---|---|---|---|---|---|---|
| id | -uuid-str | -N/A | -R | -generated | -N/A | -UUID for the port. | -
| network_id | -uuid-str | -Yes | -CR | -N/A | -existing network identifier | -Network that this port is associated with. - | -
| name | -String | -No | -CRU | -None | -N/A | -Human-readable name for the port. Might - not be unique. | -
| admin_state_up | -bool | -No | -CRU | -true | -{true|false} | -Administrative state of port. If false - (down), port does not forward packets. - | -
| status | -string | -N/A | -R | -N/A | -N/A | -|
| mac_address | -string | -No | -CR | -generated | -valid MAC in 6-octet form separated by - colons | -Mac address to use on this port. | -
| fixed_ips | -list(dict) | -No | -CRU | -automatically allocated from pool | -Valid IP address and existing subnet - identifier | -Specifies IP addresses for the port thus - associating the port itself with the - subnets where the IP addresses are picked - from | -
| device_id | -str | -No | -CRUD | -None | -No constraint | -identifies the device (e.g., virtual - server) using this port. | -
| device_owner | -str | -No | -CRUD | -None | -No constraint | -Identifies the entity (e.g.: dhcp agent) - using this port. | -
| tenant_id | -uuid-str | -No |
- CR | -N/A | -No constraint | -Owner of port. Only admin users can - specify a tenant_id other than its own. - | -
| security_groups | -list(dict) | -No | -CRUD | -None | -Existing security group IDs | -Specifies the IDs of any security groups - associated with a port. | -
Content-Type
- header, the Accept header or adding the
- .json extension to the request
- URI.| Attribute | -Description | -
|---|---|
| name | -The name for the network. | -
| admin_state_up | -Specifies whether the admin state
- is up or down. Set to
- |
-
| Field | -Description | -
|---|---|
| admin_state_up | -Administrative state of the - router. | -
| device_id | -The ID of the device that uses - this port. For example, a virtual - server, | -
| device_owner | -The ID of the entity that uses - this port. For example, a dhcp - agent. | -
| fixed_ips | -IP addresses for the port. - Includes the IP address and subnet - ID. | -
| id | -The ID of the port. | -
| mac_address | -The MAC address of the port. | -
| name | -The name of the port. | -
| network_id | -The ID of the attached - network. | -
| security_groups | -The IDs of any attached security - groups. | -
| status | -The status of the port: UP or - DOWN. | -
| tenant_id | -The ID of the tenant who owns the - network. Only administrative users - can specify a tenant_id other than - their own. | -
| Attribute | -Type | -Required | -Default Value | -Validation Constraints | -Notes | -
|---|---|---|---|---|---|
| network_id | -UUID | -Yes | -N/A | -Must be a valid uuid representative of an external network. | -- |
| enable_snat | -Boolean | -No | -True | -{True|False} | -The default setting is |
-
| Attribute | +Type | +Required | +Default Value | +Validation Constraints | +Notes | +
|---|---|---|---|---|---|
| network_id | +UUID | +Yes | +N/A | +Must be a valid uuid representative of an external + network. | ++ |
| enable_snat | +Boolean | +No | +True | +{True|False} | +The default setting is |
+
| Attribute | +Type | +Required | +CRUD |
+ Default Value | +Validation Constraints | +Notes | +
|---|---|---|---|---|---|---|
|
+ |
+ ||||||
|
+ |
+ list(dict) | +N/A | +CRU | +None | +N/A | +|
|
+ |
+ list(dict) | + +N/A | +R | +None | +N/A | +
| Attribute | +Type | +Required | +CRUD |
+ Default Value | +Validation Constraints | +Notes | +
|---|---|---|---|---|---|---|
| id | +uuid-str | +N/A | +R | +generated | +N/A | +UUID for the network. | +
| name | +String | +No | +CRU | +None | +N/A | +Human-readable name for the network. Might not + be unique. | +
| admin_state_up | +Bool | +No | +CRU | +true | +{true|false} | +The administrative state of network. If false + (down), the network does not forward + packets. | +
| status | +String | +N/A | +R | +N/A | +N/A | +|
| subnets | +list(uuid-str) | +No | +R | +Empty List | +N/A | +subnets associated with this network. | +
| shared | +Bool | +No | +CRU | +False | +{ True | False } | +Specifies whether the network resource can be + accessed by any tenant or not. | +
| tenant_id | +uuid-str | +No |
+ CR | +N/A | +No constraint | +Owner of network. Only admin users can specify + a tenant_id other than its own. | +
| Attribute | +Type | +Required | +CRUD |
+ Default Value | +Validation Constraints | +Notes | +
|---|---|---|---|---|---|---|
| id | +uuid-str | +N/A | +R | +generated | +N/A | +UUID representing the subnet | +
| network_id | +uuid-str | +Yes | +CR | +N/A | +network this subnet is associated with. | ++ |
| name | +String | +No | +CRU | +None | +N/A | +Human-readable name for the subnet. Might not + be unique. | +
| ip_version | +int | +Yes | +CR | +4 | +{ 4 | 6 } | +IP version | +
| cidr | +string | +Yes | +CR | +N/A | +valid cidr in the form + <network_address>/<prefix> | +cidr representing IP range for this subnet, + based on IP version | +
| gateway_ip | +string | +No | +CRUD | +first address in |
+ Valid IP address or null | +default gateway used by devices in this + subnet | +
| dns_nameservers | +list(str) | +No | +CRU | +Empty list | +No constraint | +DNS name servers used by hosts in this + subnet. | +
| allocation_pools | +list(dict) | +No | +CR | +Every address in |
+ star/end of range must be valid ip | +Sub-ranges of cidr available for dynamic + allocation to ports [ { "start": "10.0.0.2", + "end": "10.0.0.254"} ] | +
| host_routes | +list(dict) | +No | +CRU | +Empty List | +
+ |
+ Routes that should be used by devices with IPs + from this subnet (not including local subnet + route). | +
| enable_dhcp | +Bool | +No | +CRU | +True | +{ True | False } | +Specifies whether DHCP is enabled for this + subnet or not. | +
| tenant_id | +uuid-str | +No |
+ CR | +N/A | +No constraint | +Owner of network. Only admin users can specify + a tenant_id other than its own. | +
| Attribute | +Type | +Required | +CRUD |
+ Default Value | +Validation Constraints | +Notes | +
|---|---|---|---|---|---|---|
| id | +uuid-str | +N/A | +R | +generated | +N/A | +UUID for the port. | +
| network_id | +uuid-str | +Yes | +CR | +N/A | +existing network identifier | +Network that this port is associated with. + | +
| name | +String | +No | +CRU | +None | +N/A | +Human-readable name for the port. Might not be + unique. | +
| admin_state_up | +bool | +No | +CRU | +true | +{true|false} | +Administrative state of port. If false (down), + port does not forward packets. | +
| status | +string | +N/A | +R | +N/A | +N/A | +|
| mac_address | +string | +No | +CR | +generated | +valid MAC in 6-octet form separated by + colons | +Mac address to use on this port. | +
| fixed_ips | +list(dict) | +No | +CRU | +automatically allocated from pool | +Valid IP address and existing subnet + identifier | +Specifies IP addresses for the port thus + associating the port itself with the subnets + where the IP addresses are picked from | +
| device_id | +str | +No | +CRUD | +None | +No constraint | +identifies the device (e.g., virtual server) + using this port. | +
| device_owner | +str | +No | +CRUD | +None | +No constraint | +Identifies the entity (e.g.: dhcp agent) using + this port. | +
| tenant_id | +uuid-str | +No |
+ CR | +N/A | +No constraint | +Owner of network. Only admin users can specify + a tenant_id other than its own. | +
| security_groups | +list(dict) | +No | +CRUD | +None | +Existing security group IDs | +Specifies the IDs of any security groups + associated with a port. | +
The + network name.
+Indicates the administrative status of + the network.
+Indicates whether this network is shared + across all tenants. By default, only + administrative users can change this + value.
+The ID + of the tenant that owns the network. Only + administrative users can set the tenant + ID. You cannot change this value through + authorization policies.
+The + type of physical network that maps to this + networks resource. Examples are flat, + vlan, and gre.
+The + physical network on which this network + object is implemented. The Networking API + v2.0 does not provide a way to list + available physical networks. For example, + the Open vSwitch plug-in configuration + file defines a symbolic name that maps to + specific bridges on each Compute host.
+An + isolated segment on the physical network. + The network_type attribute defines the + segmentation model. For example, if + network_type is vlan, this ID is a vlan + identifier. If network_type is gre, this + ID is a gre key.
+The UUID for the network of interest to + you.
+Lists networks + that are accessible to the tenant who submits the + request.
+Creates a + network.
+Shows information + for the specified network.
+Updates the + specified network.
+The administrative state of + the network.
network_id attribute in
+ the request body.fixed_ip attribute when it is
+ specified in the request body. If the updated IP
+ addresses are not valid or are already in use, the
+ operation fails and the existing IP addresses are not
+ removed from the port.security_groups
+ attribute when you specify it in the request body.
+ However, if the specified security groups are not
+ valid, the operation fails and the existing security
+ groups are not removed from the port.The + tenant ID in a multi-tenancy cloud.
+The UUID for the quota of interest to you.
ip_version attribute
+ in the request body. OpenStack Networking does not try
+ to derive the correct IP version from the provided
+ CIDR. If the parameter for the gateway address,
+ gateway_ip, is not specified,
+ OpenStack Networking allocates an address from the
+ cidr for the gateway for the subnet.gateway_ip attribute
+ in the request body. If allocation pools attribute,
+ allocation_pools, is not specified,
+ OpenStack Networking automatically allocates pools for
+ covering all IP addresses in the CIDR, excluding the
+ address reserved for the subnet gateway. Otherwise,
+ you can explicitly specify allocation pools as shown
+ in the following example.allocation_pools and
+ gateway_ip are both specified, it is
+ up to the user to ensure that the gateway IP does not
+ overlap with the specified allocation pools; otherwise
+ a 409 Conflict error occurs.
- This schema file defines actions that can be performed on a
+ This schema file defines actions that can be performed on a
cloud server. All cloud server actions are derived from the Action type.
-
- Types related to servers. -
-Types related to servers.
+- Performs a HARD or SOFT reboot. -
+Performs a HARD or SOFT reboot.
- Rebuilds a server. -
+Rebuilds a server.
- Resizes a server. -
+Resizes a server.
- Confirms a resize action. -
+Confirms a resize action.
- Reverts a resize action. -
+Reverts a resize action.
- Changes a server's password. -
+Changes a server's password.
- The action creates a new image for the server. -
+The action creates a new image for the server.
- This is the base type for all server actions. It is simply
+ This is the base type for all server actions. It is simply
a marker abstract type used to differentiate an Action
- element from other elements.
-
- The type of reboot to perform. -
+The type of reboot to perform.
- A collection of meta data items - associated with the server. If not - specified the original server metadata - will be kept. -
-- A collection of small files used to personalize a - new server instance. Exisiting server - personality files are deleted by the - rebuild process. -
-- The name of the server. If not specified the - original server name will be kept. -
-- The server's administration password. -
-- A reference to an image to use for the - rebuild. A local image need contain only an - Image ID. External images must contian a - link that provides the full path to the - image resource. You must supply an image - when rebuilding. -
-A collection of meta data items associated with the + server. If not specified the original server + metadata will be kept.
+A collection of small files used to personalize a new server + instance. Existing server personality files are + deleted by the rebuild process.
+The name of the server. If not specified the original + server name will be kept.
+The administration password for the server.
+A reference to an image to use for the rebuild. A + local image must contain only an image ID. External + images must contain a link that provides the full path + to the image resource. You must supply an image when + rebuilding.
+- A reference to the flavor to convert to. -
-A reference to the flavor to convert to.
+- The server's administration password. -
-The server's administration password.
+- A collection of meta data items - associated with the image. -
-- The name of the image to create. -
-A collection of meta data items associated with the + image.
+The name of the image to create.
+- A HARD reboot is equivalent to power cycling the server. - The operating system is not allowed to gracefully - shutdown. -
+A HARD reboot is equivalent to power cycling the + server. The operating system is not allowed to + gracefully shut down.
- With a SOFT reboot, the operating system is signaled to - restart. This allows for a graceful shutdown of all - processes. -
+With a SOFT reboot, the operating system is signaled to + restart, which enables a graceful shut down of all + processes.
- This schema file defines common types used by multiple - entities and possibly spanning several types of requests. -
+This schema file defines common types used by multiple + entities and possibly spanning several types of requests.
- A collection of metadata items. There may be an
+ A collection of metadata items. There may be an
absolute limit that imposes additional constraints on
- the number of metadata items.
-
- A MetadataItem is simply a name-value pair. The name is
+ A MetadataItem is simply a name-value pair. The name is
specified in the key attribute and the value is included inline.
-
- A meta data name-value pair. -
+A meta data name-value pair.
- An integer between 0 and 100 that denotes the progress of an - operation. -
+An integer between 0 and 100 that denotes the progress of + an operation.
- A universally unique identifier. -
-A universally unique identifier.
+- An extended status must contian a prefix. -
-An extended status must contain a prefix.
+- This schema file defines types related to API - extensions. -
+This schema file defines types related to API + extensions.
- A list of supported extensions. -
+A list of supported extensions.
- Detials about a specific extension. -
+Detials about a specific extension.
- A list of extensions. -
+A list of extensions.
- Detials about a specific extension. -
+Details about a specific extension.
- A short description of what the extension - does. -
+A short description of what the extension + does.
- A human reabable extension name. -
+A human readable extension name.
- Extension namespace used for XML representations. -
+Extension namespace used for XML + representations.
- A vendor prefix alieas used for non-XML - representations. -
+A vendor prefix alias used for non-XML + representations.
- The time that the extension was added or - modifided. -
+The time that the extension was added or + modified.
- There should be at least one atom link with a - describedby relation. This relation provides - developer info for the extension. -
+There should be at least one atom link with a + describedby relation. This relation provides + developer info for the extension.
- Vendor aliases are used to differentiate +
Vendor aliases are used to differentiate
extensions in non-XML representations as well as
- in HTTP headers and in the URL path. An alias is
- made of a vendor prefix, followed be a a dash (-)
- followed be a short extension ID. For example:
- RAX-PIE.
-
RAX-PIE.
- This schema file defines faults that may be raised by the
- OpenStack Compute API. These faults are derived from the ComputeAPIFault. Most faults extend this
- type without adding any additional attributes or elements.
- The only exceptions is the OverLimitAPIFault which adds a
- retryAt attribute and the AsyncAPIFault which adds a
- created timestamp. Because all faults extend
- a standard base type, it should be possible to capture all API
- faults with a single catch statement.
-
- Faults are associated with a default HTTP status code that - corresponds to the particular fault type. For example an <itemNotFound> element is associated - with the HTTP status code 404. Some elements, the <computeFault> element for - example, may be associated with multiple status codes. It is - also possible for multiple fault elements to be associated - with the same default code. The examples below showcase the - default status codes for each element type. Note that these - default codes are not part of the formal schema. In practice, - however, an element type will likely be associated with its - corresponding default status code. -
+This schema file defines faults that may be raised by the
+ OpenStack Compute API. These faults are derived from the ComputeAPIFault. Most faults extend this type without
+ adding any additional attributes or elements. The only
+ exceptions is the OverLimitAPIFault which adds a retryAt
+ attribute and the AsyncAPIFault which adds a created
+ timestamp. Because all faults extend a standard base type, it
+ should be possible to capture all API faults with a single
+ catch statement.
Faults are associated with a default HTTP status code that + corresponds to the particular fault type. For example an <itemNotFound> element is associated with the + HTTP status code 404. Some elements, the <computeFault> element for example, may be + associated with multiple status codes. It is also possible for + multiple fault elements to be associated with the same default + code. The examples below showcase the default status codes for + each element type. Note that these default codes are not part + of the formal schema. In practice, however, an element type + will likely be associated with its corresponding default + status code.
- A generic Cloud Servers API fault. -
+A generic Cloud Servers API fault.
- The item or resource could not be found. -
+The item or resource could not be found.
- The operation is not allowed because the corresponding - server is in a build state. -
+The operation is not allowed because the corresponding + server is in a build state.
- There is not enough capacity to honor the request. -
+There is not enough capacity to honor the request.
- The operation is not allowed because the corresponding - server is being re-sized or backed up. -
+The operation is not allowed because the corresponding + server is being re-sized or backed up.
- The re-size operation is not permitted. -
+The re-size operation is not permitted.
- The API service is currently unavailable. -
+The API service is currently unavailable.
- Insufficient privileges to honor the request, perhaps an - authentication token needs to be obtained or renewed. -
+Insufficient privileges to honor the request, perhaps an + authentication token needs to be obtained or renewed.
- Authentication has been validated, however the operation is unauthorized. -
+Authentication was validated, however the operation is + unauthorized.
- An absolute or rate limit has been exceeded. -
+- The request is malformed. -
+The request is malformed.
- The Content Type of the request is not supported. -
+The Content Type of the request is not supported.
- The HTTP method (or verb) is not - supported by the corresponding resource. -
+The HTTP method (or verb) is not + supported by the corresponding resource.
- The operation is currently not implemented. -
+The operation is currently not implemented.
- A human readable message that is appropriate for display - to the end user. -
+A human readable message that is appropriate for + display to the end user.
- The optional <details> element may contain useful - information for tracking down errors (e.g a stack - trace). This information may or may not be appropriate - for display to an end user. -
+The optional <details> element may contain useful + information for tracking down errors (such as, a stack + trace). This information might not be appropriate for an + end user.
- The HTTP status code associated with the current fault.
+ The HTTP status code associated with the current fault.
- An optional dateTime denoting when an operation should - be retried. -
+An optional dateTime denoting when an operation + should be retried.
- An optional dateTime denoting when the fault - was created. -
-An optional dateTime denoting when the fault + occurred.
+- This schema file defines types related to - preconfigured limits. Limits are used to manage the - capacity of the API and to prevent abuse. The API - defines two kinds of limits RateLimits - and rate + limits and AbsoluteLimits. RateLimits are - thresholds that are reset after a certain amount of - time passes. Absolute limits are fixed. -
+ AbsoluteLimit" + >absolute limits. Rate limits are thresholds + that are reset after a certain amount of time passes. + Absolute limits are fixed.- The limits element contains information on both rate and - absolute limits. -
+The limits element contains information on both + rate and absolute limits.
This is the main index XML Schema document for Security Groups API - Schema Types Version 1.0.
+This is the main index XML Schema document for Security + Groups API Schema Types Version 1.0.
The hostname attached to the instance.
+The host name attached to the instance.
A human readable message that is appropriate for - display to the end user.
+A human readable message that is appropriate for + display to the end user.
The optional <details> element may contain - useful information for tracking down errors (e.g a stack +
The optional <details> element may contain useful + information for tracking down errors (such as, a stack trace). This information may or may not be appropriate - for display to an end user.
+ for display to an end user.The HTTP status code associated with the current fault. -
+The HTTP status code associated with the current fault.
An optional dateTime denoting when an operation - should be retried.
+An optional dateTime denoting when an operation + should be retried.
- This schema file defines a Server and all internal
+ This schema file defines a Server and all internal
entities related to servers including Addresses and Files.
-
- Common types used by multiple entities and possibly spanning - several types of requests. -
+Common types used by multiple entities and possibly + spanning several types of requests.
- Types related to images. -
+Types related to images.
- Types related to flavors. -
+Types related to flavors.
- All fault types. -
+All fault types.
- The element defines a server. -
+The element defines a server.
- A collection of servers. -
+A collection of servers.
- The element defines list of addresses by network: (public, - private, ...). -
+The element defines list of addresses by network: (public, + private, ...).
- The element defines a list of addresses in a network. -
-- The element defines an individual IP address. -
+The element defines a list of addresses in a network.
The element defines an individual IP address.
+- A server is a virtual machine instance in the Cloud Servers - system. Note that this complex type defines all elements - and attributes as optional because a server instance may - take many different forms depending on the operation. When - creating a server, for example, the name, imageRef, and - flavorRef attributes are required. In addition, optional - metadata and personality file elements may be specified: -
+A server is a virtual machine instance in the Cloud + Servers system. Note that this complex type defines all + elements and attributes as optional because a server + instance may take many different forms depending on the + operation. When creating a server, for example, the name, + imageRef, and flavorRef attributes are required. In + addition, optional metadata and personality file elements + may be specified:
- The response to such a crate operation will include the +
The response to such a crate operation will include the administration password, host ID, and addresses associated - with the server: -
+ with the server:- When modifying a server only the name and administration +
When modifying a server only the name and administration password should be specified as these are the only - attributes that are modifiable. -
+ attributes that are modifiable.- A reference to an image used to create the - server. External images must contian a link that - provides the full path to the image resource. -
-A reference to an image used to create the server. + External images must contain a link that provides the + full path to the image resource.
+- The current server flavor. This may not contais - all flavor detials but will always contain an - ID, a name, as well as self and bookmark links. -
-The current server flavor. This may not contains all + flavor details but will always contain an ID, a name, as + well as self and bookmark links.
+- A collection of meta data items associated with the server. -
+A collection of meta data items associated with the + server.
- A server's public and private address. -
+A server's public and private address.
- A collection of small files used to personalize a new - server instance. -
+A collection of small files + used to personalize a new server instance.
- The detials of a fault that may have occured - while cerating the server or performing a server - action. -
-The details of a fault that may have occurred while + creating the server or performing a server action.
+- The name of the server. -
+The name of the server.
- A reference to an image. This is used exclusevely when - creating a server. Using an image ID here indicates that - the image is locally hosted. -
+A reference to an image. This is used exclusively when + creating a server. Using an image ID here indicates that + the image is locally hosted.
- A reference to a flavor. This is used exclusevely when - creating a server. Using a flavorRef here indicates that - the flavor is locally hosted. -
+A reference to a flavor. This is used exclusively when + creating a server. Using a flavorRef here indicates that + the flavor is locally hosted.
- The IPv4 primary IP. -
+The IPv4 primary IP.
- The IPv6 primary IP. -
+The IPv6 primary IP.
- The ID of the server. -
+The ID of the server.
- The server's administration password. -
+The server's administration password.
- A unique ID that identifies the tenant that contains - the server. -
+A unique ID that identifies the tenant that contains the + server.
- A unique ID that identifies the user who created - the server. -
+A unique ID that identifies the user who created the + server.
- A unique ID that identifies the physical host that the VM - is running on. This ID is unique per - account and not globally unique. -
+A unique ID that identifies the physical host that the + VM is running on. This ID is unique per + account and not globally unique.
- The progress of the current server operation. -
+The progress of the current server operation.
- The current state (or status) of the - server. -
+The current state (or status) of the server.
- The time the server was updated. -
+The time the server was updated.
- The time the server was created. -
+The time the server was created.
The only allowed attribute for this Server type is the + name, ID, and links. This type is used for non-detailed + server lists.
+- The only allowed attribute for this Server type is - the name, ID, and links. This type is used for - non-detailed server lists. -
-- Here the server MUST - contain a name, an ID, a bookmark link, - and a self link. -
-The server MUST contain a name, an + ID, a bookmark link, and a self link.
+- When creating a server the server must contain a - name and a reference to an image and flavor. -
-- A collection of meta data items associated with the server. -
-- A collection of small files used to personalize a new - server instance. -
-When creating a server the server must contain a name and + a reference to an image and flavor.
+A collection of meta data items associated with + the server.
+A collection of small files used to personalize a new server + instance.
+- When updating a server. The server - MUST contain either a - name or metadata or access address. The - other fields are not editabile on a - server update. -
-When updating a server. The server + MUST contain either a name or + metadata or access address. The other fields are not + editable on a server update.
+- A collection of servers. -
+A collection of servers.
- A collection of servers with only IDs, names, and - links. A collection of this type is returned in - non-detailed server list. -
-A collection of servers with only IDs, names, and links. A + collection of this type is returned in non-detailed server + list.
+- A collection of files. -
+A collection of files.
- A file is simply a full path along with base64 file
+ A file is simply a full path along with base64 file
content. The name of the file is specified in the path
- attribute and the file content is included
- inline.
-
- Full file path. -
+Full file path.
- A collection of addresses. -
+A collection of addresses.
- A id of an address list. This is typically a name - used to identify a network. -
-A id of an address list. This is typically a name used + to identify a network.
+- An IP address. -
-An IP address.
+- The IP Address version can be 4 or 6. The version - attribute is optional if it is left off, the type of - address will be determined by from its address - format. If it is specified it should - match the address format. -
-- The OpenStack compute API will always fill in the - version number as a convinence to the client. -
-The IP Address version can be 4 or 6. The version + attribute is optional if it is left off, the type of + address is determined from its address format. If it is + specified, it should match the address + format.
+The OpenStack compute API always fills in the version + number as a convenience to the client.
+- An extensible server status type allows all of the - strings defined in ServerStatus or an alias prefixed - status. -
-An extensible server status type allows all of the strings + defined in ServerStatus or an alias prefixed status.
+- The server is ready to use. -
+The server is ready to use.
- The server is in an inactive (suspended) state. -
+The server is in an inactive (suspended) state.
- The server has been deleted. -
+The server has been deleted.
- The server is being resized. -
+The server is being resized.
- The server is waiting for the resize operation to be
+ The server is waiting for the resize operation to be
confirmed so that the original server may be removed.
- The requested operation failed, the server is in an - error state. -
+The requested operation failed, the server is in an + error state.
- The server is being built. -
+The server is being built.
- The server password is being changed. -
+The server password is being changed.
- The server is being rebuilt. -
+The server is being rebuilt.
- The server is going through a SOFT reboot. -
+The server is going through a SOFT reboot.
- The server is going through a HARD reboot. -
+The server is going through a HARD reboot.
- The server is in an unknown state. -
+The server is in an unknown state.
- Denotes IPv4. -
-- Denotes IPv6. -
-Denotes IPv4.
+Denotes IPv6.
+- This schema file defines all types related to versioning. -
+This schema file defines all types related to + versioning.
- This element is returned when the version of the +
This element is returned when the version of the resource cannot be determined. The element - provides a list of choices for the resource. -
+ provides a list of choices for the resource.- Provides a list of supported versions. -
+Provides a list of supported versions.
- This element provides detailed meta information +
This element provides detailed meta information regarding the status of the current API version. This is the XSD 1.0 compatible element definition.
@@ -95,29 +91,30 @@- This element provides detailed meta information - regarding the status of the current API - version. The description should include a pointer - to both a human readable and a machine processable - description of the API service. -
+This element provides detailed meta information + regarding the status of the current API version. + The description should include a pointer to both a + human readable and a machine processable + description of the API service.