etc/quantum.conf).
id attribute set.
| 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. + | +
| permissions | +octal(3) | +No | +CR |
+ rw- --- --- | +3-octal digit string or permission string
+ in the rwxrwxrwx form. |
+ Specifies access rights on the network + object for owner, group, and world | +
| tenant_id | +uuid-str | +No |
+ CR | +N/A | +UUID_PATTERN | +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. | ++ |
| 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 | +default gateway used by devices in this + subnet | +
| dns_nameservers | +list(str) | +No | +CRU | +None | +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 | +default route to gateway_ip | +
+ |
+ Routes that should be used by devices with + IPs from this subnet (not including local + subnet route). | +
| tenant_id | +uuid-str | +No |
+ CR | +N/A | +UUID_PATTERN | +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. + | +
| 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 | +
| host_routes | +list(dict) | +No | +CR | +Empty list | +
+ |
+ list of routes to be used with this port. + In case of overlap, overrides routes + specified for the subnets associated with + this port. | +
| device_id | +str | +No | +CRUD | +None | +No constraint | +identifies the device (e.g., virtual + server) using this port. | +
| tenant_id | +uuid-str | +No |
+ CR | +N/A | +UUID_PATTERN | +Owner of network. Only admin users can + specify a tenant_id other than its own. + | +
Content-Type header, the
+ Accept header or adding an
+ .xml or .json extension
+ to the request URI. | Format | +Accept Header | +Query Extension | +Default | +
| JSON | +application/json | +.json | +No | +
| XML | +application/xml | +.xml | +Yes | +
| Attribute | +Description | +
|---|---|
| name | +The name for the network. | +
| admin_state_up | +Specifies whether the admin state
+ is up or down. Set to
+ |
+
+ 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. +
++ Performs a HARD or SOFT reboot. +
++ Rebuilds a server. +
++ Resizes a server. +
++ Confirms a resize action. +
++ Reverts a resize action. +
++ Changes a server's password. +
++ The action creates a new image for the server. +
++ 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. +
++ 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 reference to the flavor to convert to. +
++ The server's administration password. +
++ 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. +
++ With a SOFT reboot, the operating system is signaled to + restart. This allows for a graceful shutdown of all + processes. +
++ This is the main index XML Schema document + for Common API Schema Types Version 1.0. +
++ Types related to extensions. +
++ Types related to rate and absolute limits. +
++ Types related to API version details. +
++ This is the main index XML Schema document + for the Open Stack Compute API Version 1.1. +
++ Servers and all internal Entities including Addresses and + Files. +
++ Types related to images. +
++ Types related to flavors. +
++ Defines server actions: reboot, rebuild, resize... +
++ Metadata for Server and Image. +
++ All fault types. +
++ This schema file simple defines an atom link according + to RFC4287 +
++ This schema document describes the XML namespace, in a form + suitable for import by other schema documents. +
++ See + http://www.w3.org/XML/1998/namespace.html and + + http://www.w3.org/TR/REC-xml for information + about this namespace. +
++ Note that local names in this namespace are intended to be + defined only by the World Wide Web Consortium or its subgroups. + The names currently defined in this namespace are listed below. + They should not be used with conflicting semantics by any Working + Group, specification, or document instance. +
++ See further below in this document for more information about how to refer to this schema document from your own + XSD schema documents and about the + namespace-versioning policy governing this schema document. +
++ denotes an attribute whose value + is a language code for the natural language of the content of + any element; its value is inherited. This name is reserved + by virtue of its definition in the XML specification.
+ ++ Attempting to install the relevant ISO 2- and 3-letter + codes as the enumerated possible values is probably never + going to be a realistic possibility. +
++ See BCP 47 at + http://www.rfc-editor.org/rfc/bcp/bcp47.txt + and the IANA language subtag registry at + + http://www.iana.org/assignments/language-subtag-registry + for further information. +
++ The union allows for the 'un-declaration' of xml:lang with + the empty string. +
++ denotes an attribute whose + value is a keyword indicating what whitespace processing + discipline is intended for the content of the element; its + value is inherited. This name is reserved by virtue of its + definition in the XML specification.
+ ++ denotes an attribute whose value + provides a URI to be used as the base for interpreting any + relative URIs in the scope of the element on which it + appears; its value is inherited. This name is reserved + by virtue of its definition in the XML Base specification.
+ ++ See http://www.w3.org/TR/xmlbase/ + for information about this attribute. +
++ denotes an attribute whose value + should be interpreted as if declared to be of type ID. + This name is reserved by virtue of its definition in the + xml:id specification.
+ ++ See http://www.w3.org/TR/xml-id/ + for information about this attribute. +
++ denotes Jon Bosak, the chair of + the original XML Working Group. This name is reserved by + the following decision of the W3C XML Plenary and + XML Coordination groups: +
++++ In appreciation for his vision, leadership and + dedication the W3C XML Plenary on this 10th day of + February, 2000, reserves for Jon Bosak in perpetuity + the XML name "xml:Father". +
+
+ This schema defines attributes and an attribute group suitable
+ for use by schemas wishing to allow xml:base,
+ xml:lang, xml:space or
+ xml:id attributes on elements they define.
+
+ To enable this, such a schema must import this schema for + the XML namespace, e.g. as follows: +
++ <schema . . .> + . . . + <import namespace="http://www.w3.org/XML/1998/namespace" + schemaLocation="http://www.w3.org/2001/xml.xsd"/> ++
+ or +
++ <import namespace="http://www.w3.org/XML/1998/namespace" + schemaLocation="http://www.w3.org/2009/01/xml.xsd"/> ++
+ Subsequently, qualified reference to any of the attributes or the + group defined below will have the desired effect, e.g. +
++ <type . . .> + . . . + <attributeGroup ref="xml:specialAttrs"/> ++
+ will define a type which will schema-validate an instance element + with any of those attributes. +
++ In keeping with the XML Schema WG's standard versioning + policy, this schema document will persist at + + http://www.w3.org/2009/01/xml.xsd. +
++ At the date of issue it can also be found at + + http://www.w3.org/2001/xml.xsd. +
++ The schema document at that URI may however change in the future, + in order to remain compatible with the latest version of XML + Schema itself, or with the XML namespace itself. In other words, + if the XML Schema or XML namespaces change, the version of this + document at + http://www.w3.org/2001/xml.xsd + + will change accordingly; the version at + + http://www.w3.org/2009/01/xml.xsd + + will not change. +
++ Previous dated (and unchanging) versions of this schema + document are at: +
+ ++ This schema file defines all entities related to Backup Schedules. +
++ This element is used to create periodic daily and weekly + images automatically. +
++ If true, both daily and weekly backup schedules are + disabled. +
++ A WeeklyBackup type that describes the day + of the week in which to perform a weekly backup or + DISABLED if weekly backups are disabled. +
++ A DailyBackup type that describes an hour + range in which to perform a daily backup or DISABLED if + daily backups are disabled. +
++ A target GMT hour range in which to perform a daily backup + or DISABLED if daily backups are disabled. +
++ Daily backups are disabled. +
++ Daily backup target of 00:00–02:00 GMT. +
++ Daily backup target of 02:00–04:00 GMT. +
++ Daily backup target of 04:00–06:00 GMT. +
++ Daily backup target of 06:00–08:00 GMT. +
++ Daily backup target of 08:00–10:00 GMT. +
++ Daily backup target of 10:00–12:00 GMT. +
++ Daily backup target of 12:00–14:00 GMT. +
++ Daily backup target of 14:00–16:00 GMT. +
++ Daily backup target of 16:00–18:00 GMT. +
++ Daily backup target of 18:00–20:00 GMT. +
++ Daily backup target of 20:00–22:00 GMT. +
++ Daily backup target of 22:00–00:00 GMT. +
++ A target day of the week in which to perform a weekly backup + or DISABLED if daily backups are disabled. +
++ Weekly backups are disabled. +
++ A weekly backup target of Sunday. +
++ A weekly backup target of Monday. +
++ A weekly backup target of Tuesday. +
++ A weekly backup target of Wednesday. +
++ A weekly backup target of Thursday. +
++ A weekly backup target of Friday. +
++ A weekly backup target of Saturday. +
++ A weekly backup target of Sunday. +
++ 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 + absolute limit that imposes additional constraints on + the number of metadata items. +
++ 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. +
++ An integer between 0 and 100 that denotes the progress of an + operation. +
++ A universally unique identifier. +
++ An extended status must contian a prefix. +
++ A flag that identifies whether a disk is auto + managed or manual managed. The attribute can only + be applied to an Image. +
++ This schema file defines types related to API + extensions. +
++ A list of supported extensions. +
++ Detials about a specific extension. +
++ A list of extensions. +
++ Detials about a specific extension. +
++ A short description of what the extension + does. +
++ A human reabable extension name. +
++ Extension namespace used for XML representations. +
++ A vendor prefix alieas used for non-XML + representations. +
++ The time that the extension was added or + modifided. +
++ 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
+ 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.
+
+ 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. +
++ The item or resource could not be found. +
++ The operation is not allowed because the corresponding + server is in a build state. +
++ 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 re-size operation is not permitted. +
++ The API service is currently unavailable. +
++ 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. +
++ The request is malformed. +
++ The Content Type of the request is not supported. +
++ The HTTP method (or verb) is not + supported by the corresponding resource. +
++ The operation is currently not implemented. +
++ 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 HTTP status code associated with the current fault. +
++ An optional dateTime denoting when an operation should + be retried. +
++ An optional dateTime denoting when the fault + was created. +
++ This schema file defines all entities related to Flavors. +
++ Common types used by multiple entities and possibly spanning + several types of requests. +
++ The element defines an available hardware configuration for + a server. +
++ A collection of flavors. +
++ The ID of the flavor. +
++ The name of the flavor. +
++ The amount of RAM in the flavor in megabytes. +
++ The amount of disk space in the flavor in gigabytes. +
++ The amount of cores allocated. +
++ The only allowed attributes for this Flavor type is + the name, ID, and links. This type is used for + non-detailed list of flavors. +
++ Here the flavor MUST + contain a name, an ID, a bookmark link, + and a self link. +
++ A collection of flavors. +
++ A collection of flavors with ID, names, and links + only. This type is used for non-detailed list of + flavors. +
++ This schema file defines all entity related to Images. +
++ Common types used by multiple entities and possibly spanning + several types of requests. +
++ Servers and all internal Entities including: Addresses, + and Files. +
++ All fault types. +
++ The element defines a collection of files used to create or + rebuild a server. +
++ A collection of images. +
++ The server associated with the image. This may + not contain full server 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 image. +
++ The details of a fault that may have occurred + while creating an image. +
++ The ID of the image. +
++ The name of the image. +
++ A unique ID that identifies the tenant that contains + the image. +
++ A unique ID that identifies the user who created + the image. +
++ A time-stamp identifying the modification time of the + image. +
++ A creation time-stamp for the image. +
++ The progress of the current image operation. +
++ The current state (or status) of the + image. +
++ Minimum disk space required for the image in gigabytes. +
++ The minimum amount of RAM required for the image in + megabytes. +
++ The only allowed attribute for this Image type is + the name, ID, and links. This is used for + non-detailed list of images. +
++ Here the image MUST + contain a name, an ID, a bookmark link, + and a self link. +
++ A collection of images (all details). +
++ A collection of images with only IDs, names, and + links. This is used for the non-detailed list of + images. +
++ An extensible image status type allows all of the + strings defined in ImageStatus or an + alias prefixed status. +
++ The image is in an unknown state. +
++ All operations have completed successfully, the image is + available for install. +
++ The image is being created (or saved). +
++ The image has been deleted. +
++ The requested operation has failed. +
++ This schema file defines all entities related to Shared IP Groups. +
++ Common types used by multiple entities and possibly spanning + several types of requests. +
++ The element defines a group of servers that can share one or + more public IPs with each other. +
++ A collection of shared IP groups. +
++ An IP group type can take two basic forms. On a request + a single, optional, server ID may be specified… +
++ …on a response a server ID list is always returned. This + server list may be empty… +
++ …note that is a mutually exclusive choice: either + a <server> or <servers> element must be + specified, but not both. +
++ A single, optional, server ID. This form is used when + creating an IP group. +
++ A collection of server IDs. This form is used when + querying an IP group. +
++ The ID of the shared IP group. The attribute should not + be specified when creating a new shared IP group. +
++ The name of the shared IP group. +
++ A collection of shared IP groups. +
++ A collection of servers within a shared IP group. +
++ The ID of a server within a shared IP group. +
++ 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 AbsoluteLimits. RateLimits 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. +
++ This schema file defines metadata for servers and images. +
++ Common types used by multiple entities and possibly spanning + several types of requests. +
++ The element defines a Metadata. +
++ The element defines a metadata item. +
++ 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. +
++ Types related to images. +
++ Types related to flavors. +
++ All fault types. +
++ The element defines a server. +
++ A collection of servers. +
++ 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. +
++ 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 + administration password, host ID, and addresses associated + with the server: +
++ When modifying a server only the name and administration + password should be specified as these are the only + 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. +
++ 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. +
++ A collection of meta data items associated with the server. +
++ A server's public and private address. +
++ 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 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 a flavor. This is used exclusevely when + creating a server. Using a flavorRef here indicates that + the flavor is locally hosted. +
++ The IPv4 primary IP. +
++ The IPv6 primary IP. +
++ The ID of the server. +
++ The server's administration password. +
++ 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 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 current state (or status) of the + server. +
++ The time the server was updated. +
++ 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. +
++ Here 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 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. +
++ 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 files. +
++ 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. +
++ A collection of addresses. +
++ A id of an address list. This is typically a name + used to identify a network. +
++ 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. +
++ 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 in an inactive (suspended) state. +
++ The server has been deleted. +
++ The server is being resized. +
++ 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 server is being built. +
++ The server password is being changed. +
++ The server is being rebuilt. +
++ The server is going through a SOFT reboot. +
++ The server is going through a HARD reboot. +
++ The server is in an unknown state. +
++ Denotes IPv4. +
++ Denotes IPv6. +
++ The element defines request to share a public IP address. +
++ This type is used to represent a request to share an IP + address. +
++ The + shared IP group + + use to + share the address. +
++ If true, the server is configured with the new address + though the address may not be enabled. +
++ This schema file defines all types related to versioning. +
++ 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 supported versions. +
++ This element provides detailed meta information + regarding the status of the current API version. + This is the XSD 1.0 compatible element definition. +
++ 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. +
+Loading...+
+ Your browser does not seem to have support for + namespace nodes in XPath. If you're a Firefox + user, please consider voting to get this issue + resolved: + + https://bugzilla.mozilla.org/show_bug.cgi?id=94270 + +
+|
+ |
+
+
+
+
+
+
+
+ |
+
|
+
+
+
+
+
+
+ |
+
| enum values | +|
| + |