diff --git a/v2.0/neutron-metering-ext.xml b/v2.0/neutron-metering-ext.xml index 18574e3..7cbde1e 100644 --- a/v2.0/neutron-metering-ext.xml +++ b/v2.0/neutron-metering-ext.xml @@ -36,8 +36,7 @@ xmlns:db="http://docbook.org/ns/docbook" version="5.0" status="final" xml:id="metering-ext" xmlns:wadl="http://wadl.dev.java.net/2009/02"> - - Metering Labels and Rules + Metering labels and rules Creates, modifies, and deletes OpenStack Layer3 Metering labels and rules. diff --git a/v2.0/section_neutron-provider-ext.xml b/v2.0/section_neutron-provider-ext.xml index 502ee03..c96fd35 100644 --- a/v2.0/section_neutron-provider-ext.xml +++ b/v2.0/section_neutron-provider-ext.xml @@ -124,10 +124,10 @@ This section discusses operations for setting and retrieving the provider networks extension attributes for network objects. - -
+
List Networks diff --git a/v2.0/section_neutron_binding_ext_ports.xml b/v2.0/section_neutron_binding_ext_ports.xml index 08b3a9e..1ca4bcd 100644 --- a/v2.0/section_neutron_binding_ext_ports.xml +++ b/v2.0/section_neutron_binding_ext_ports.xml @@ -150,7 +150,7 @@ -
diff --git a/v2.0/section_neutron_list-extensions.xml b/v2.0/section_neutron_list-extensions.xml index 226f8d2..c0390c6 100644 --- a/v2.0/section_neutron_list-extensions.xml +++ b/v2.0/section_neutron_list-extensions.xml @@ -42,20 +42,20 @@ The following example response shows a list of extensions: - Status Code: 200 OK -Connection: keep-alive -Content-Length: 654 -Content-Type: application/xml; charset=UTF-8 -Date: Wed, 12 Sep 2012 11:32:56 GMT + Status Code: 200 OK + Connection: keep-alive + Content-Length: 654 + Content-Type: application/xml; charset=UTF-8 + Date: Wed, 12 Sep 2012 11:32:56 GMT Also, you can query for specific extension using the extension alias. For instance, querying /v2.0/extensions/router, results in the following response: - Status Code: 200 OK + Status Code: 200 OK Connection: keep-alive Content-Length: 350 Content-Type: application/xml; charset=UTF-8 -Date: Wed, 12 Sep 2012 11:36:20 GMT +Date: Wed, 12 Sep 2012 11:36:20 GMT
diff --git a/v2.0/wadl/common.ent b/v2.0/wadl/common.ent new file mode 100644 index 0000000..54a9bf3 --- /dev/null +++ b/v2.0/wadl/common.ent @@ -0,0 +1,618 @@ + + + + + + '> + + + + + '> + + + + + + '> + + + + + '> + + + + '> + + + + '> + + + + + + + '> + + + + '> + + + + + + '> + + + + + + '> + + + + + + '> + + + + + + '> + + + + + + '> + + + + + + '> + + + + + + + + '> + + + + + + The administrative state of the network. + + + + + The network ID. + + + + The network name. + + + + Indicates whether this network is shared across all tenants. + + + + The network status. + + + + The associated subnets. + + + + The tenant ID. + + '> + + + + The administrative state of the network. + + + + The network name. + + + + Admin-only. Indicates whether this network is shared across all tenants. + + + + The ID of the tenant that owns the network. Only administrative users can specify a tenant ID other than their own. You cannot change this value through authorization policies. + + '> + + + + + The physical network where 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. + + + + The type of physical network that maps to this network resource. Examples are flat, vlan, vxlan, and gre. + + + + 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 port status. Value is UP or DOWN. + + + + The port name. + + + + The administrative state of the router. + + + + The ID of the attached network. + + + + The ID of the tenant who owns the network. Only administrative users can specify a tenant ID other than their own. + + + + The VIF type. + + + + The ID of the entity that uses this port. For example, a dhcp agent. + + + + The binding capabilities. + + + + The port filter. + + + + The MAC address of the port. + + + + IP addresses for the port. Includes the IP address and subnet ID. + + + + The ID of the port. + + + + The ID of the device that uses this port. For example, a virtual server. + + + + The IDs of any attached security groups. + + '> + + + + The status of the port. + + + + A symbolic name for the port. + + + + The administrative status of the router. Set to true for UP. Set to false for DOWN. + + + + The ID of the tenant who owns the network. Only administrative users can specify a tenant ID other than their own. + + + + The MAC address. If you specify an address that is not valid, a 400 Bad Request error is returned. If you do not specify a MAC address, OpenStack Networking tries to allocate one. If a failure occurs, a 503 Service Unavailable error is returned. + + + + If you specify only a subnet ID, OpenStack Networking allocates an available IP from that subnet to the port. If you specify both a subnet ID and an IP address, OpenStack Networking tries to allocate the specified address to the port. + + + + Security groups. Specify one or more security group IDs. + + + + The ID of the The network ID. + + '> + + + + + + Read-only. The The vif type for the specified port. + + + + The ID of the host where the port is allocated. In some cases, different implementations can run on different hosts. + + + + A dictionary the enables the application running on the specified host to pass and receive vif port-specific information to the plug-in. + + + + Read-only. A dictionary that enables the application to pass information about functions that the Networking API povides. Specify the following value: port_filter : Boolean to define whether port filtering features such as security group and anti-MAC/IP spoofing are provided. + + '> + + + + + + The subnet name. + + + + The ID of the attached network. + + + + The ID of the tenant who owns the network. Only administrative users can specify a tenant ID other than their own. + + + + The start and end addresses for the allocation pools. + + + + The gateway IP address. + + + + The IP version, which is 4 or 6. + + + + The CIDR. + + + + The ID of the subnet. + + + + Set to true if DHCP is enabled and false if DHCP is disabled. + + '> + + + + + The subnet name. + + + + The ID of the attached network. + + + + The ID of the tenant who owns the network. Only administrative users can specify a tenant ID other than their own. + + + + The start and end addresses for the allocation pools. + + + + The gateway IP address. + + + + The IP version, which is 4 or 6. + + + + The CIDR. + + + + The ID of the subnet. + + + + Set to true if DHCP is enabled and false if DHCP is disabled. + + '> + + + + + + A time/date stamp for when the server last changed status. + + + + Name of the image in URL format. + + + + Name of the flavor in URL format. + + + + Name of the server as a string. + + + + UUID of the server at which you want to set a marker. + + + + Integer value for the limit of values to return. + + + + Value of the status of the server so that you can filter on "ACTIVE" for example. + + + + Name of the host as a string. + + + '> + + + + + + A time/date stamp for when the flavor last changed. + + + + Integer value for the minimum disk space in GB so you can filter results. + + + + Integer value for the minimum RAM so you can filter results. + + + + UUID of the flavor at which you want to set a marker. + + + + Integer value for the limit of values to return. + + '> + + + + Security group rule object. + + + + Either ingress or egress. + + + + Either IPv4 or IPv6. + + + + The ID for the security group rule. + + + + The maximum port ranges. Set to + null. + + + + The minimum port ranges. Set to + null. + + + + The protocol. Set to null. + + + + The remote group ID. Set to + null. + + + + The remote IP prefix. Set to + null. + + + + The security group ID for the security group with + which the rule is + associated. + + + + The tenant ID. + '> + + + GET'> + PUT'> + POST'> + DELETE'> diff --git a/v2.0/wadl/os-networks-provider-ext.wadl b/v2.0/wadl/os-networks-provider-ext.wadl deleted file mode 100644 index 6684518..0000000 --- a/v2.0/wadl/os-networks-provider-ext.wadl +++ /dev/null @@ -1,256 +0,0 @@ - - - - - - - - - - - - - -%common;]> - - - - - - - - - - - - -

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.

- - &networkListParameters; - &networkProviderParameters; - - - - - - - - - - - - - - -

Creates a - network.

- - &networkCreateParameters; - - - - - - - - - - - &networkListParameters; - &networkProviderParameters; - - - - - - - - - - - - - - -

Shows information - for the specified network.

- - &networkListParameters; - &networkProviderParameters; - - - - - - - - - - - - - -

Updates the - specified network.

- - &networkCreateParameters; - &networkProviderParameters; - - - - - - - - - - - &networkListParameters; - &networkProviderParameters; - - - - - - - - - - - - diff --git a/v2.0/wadl/os-networks.wadl b/v2.0/wadl/os-networks.wadl deleted file mode 100644 index 1d60fbe..0000000 --- a/v2.0/wadl/os-networks.wadl +++ /dev/null @@ -1,538 +0,0 @@ - - - - - - - - - - - - -%common;]> - - - - - - - - - - - The tenant ID in a multi-tenancy - cloud. - - - - - - - - - - - - The UUID for the network of - interest to you. - - - - - - - - - - - - - - - - - - Lists networks to which the - specified tenant has access. - You can control which attributes are returned by - using the fields query parameter. For information, see - Filtering and Column Selection in the - OpenStack Networking API v2.0 - Reference. - - - - Indicates whether the - administrative state of the network is up or - down. - - - The network - ID. - - - The network - name. - - - Indicates whether this network - is shared across all tenants. By default, only - administrative users can change this - value. - - - The network - status. - - - The associated - subnets. - - - The tenant - ID. - - - - - - - - - - - - &fault401; - - - Creates a network. - - - -

The administrative state of - the network.

 - - - - - - - - - - - - - - - - - - Indicates whether the - administrative state of the network is up or - down. - - - The network - ID. - - - The network - name. - - - Indicates whether this network - is shared across all tenants. By default, only - administrative users can change this - value. - - - The network - status. - - - The associated - subnets. - - - The tenant - ID. - - - - - - - - - - - - &fault400; &fault401; - - - Creates multiple networks in a - single request. - In the request body, specify a list of - networks. - The bulk create operation is always atomic. Either - all or no networks in the request body are - created. - - &networkCreateParameters; - - - - - - - - - - - - - Indicates whether the - administrative state of the network is up or - down. - - - The network - ID. - - - The network - name. - - - Indicates whether this network - is shared across all tenants. By default, only - administrative users can change this - value. - - - The network - status. - - - The associated - subnets. - - - The tenant - ID. - - - - - - - - - - - - &fault400; &fault401; - - - Shows information for a specified - network. - You can control which attributes are returned by - using the fields query parameter. For information, see - Filtering and Column Selection in the - OpenStack Networking API v2.0 - Reference. - - - - Indicates whether the - administrative state of the network is up or - down. - - - The network - ID. - - - The network - name. - - - Indicates whether this network - is shared across all tenants. By default, only - administrative users can change this - value. - - - The network - status. - - - The associated - subnets. - - - The tenant - ID. - - - - - - - - - - - - &fault401; &fault404; - - - Updates a specified network. - - &networkCreateParameters; - - - - - - - - - - - - - Indicates whether the - administrative state of the network is up or - down. - - - The network - ID. - - - The network - name. - - - Indicates whether this network - is shared across all tenants. By default, only - administrative users can change this - value. - - - The network - status. - - - The associated - subnets. - - - The tenant - ID. - - - - - - - - - - - - &fault400; &fault401; &fault403; &fault404; - - - Deletes a specified network and its - associated resources. - - &fault401; &fault404; - &fault409conflict; - diff --git a/v2.0/wadl/os-ports-binding-ext.wadl b/v2.0/wadl/os-ports-binding-ext.wadl deleted file mode 100644 index dfc133f..0000000 --- a/v2.0/wadl/os-ports-binding-ext.wadl +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - - - - - - - - -%common;]> - - - - - - - - - - - - - - - The UUID for the port of interest to you. - - - - - - - - - - - - - - - Lists ports to which the tenant has access. - - &portListParameters; &portBindingParameters; - - - - - - - - - - - - - - - - Creates a port on the specified network. - - - &portCreateParameters; &portBindingParameters; - - - - - - &portListParameters; &portBindingParameters; - - - - - - - - - - - - - - - - Shows information for the specified port. - - - &portListParameters; &portBindingParameters; - - - - - - - - - - - - - - - Updates the specified port. - - - &portCreateParameters; &portBindingParameters; - - - - - - &portListParameters; &portBindingParameters; - - - - - - - - - - - - - diff --git a/v2.0/wadl/os-ports.wadl b/v2.0/wadl/os-ports.wadl deleted file mode 100644 index 7eb2b88..0000000 --- a/v2.0/wadl/os-ports.wadl +++ /dev/null @@ -1,246 +0,0 @@ - - - - - - - - - - - - - -%common;]> - - - - - - - - - - - - The tenant ID in a multi-tenancy - cloud. - - - - - - - - - - The UUID for the port of - interest to you. - - - - - - - - - - - - - - - - - Lists ports to which the tenant has - access. - Default policy settings return only those subnets - that are owned by the tenant who submits the request, - unless the request is submitted by an user with - administrative rights. Users can control which - attributes are returned by using the fields query - parameter. Additionally, you can filter results by - using query string parameters. For information, see - Filtering and Column Selection in the - OpenStack Networking API v2.0 - Reference. - - &portListParameters; - - - - - - - - - - &fault401; - - - Creates a port on a specified - network. - You must specify the network where the port is to - created in the network_id attribute in - the request body. - - &portCreateParameters; - - - - - - &portListParameters; - - - - - &fault400; &fault401; &fault403; &fault404; - &fault503macGeneration; &fault503; - - - Creates multiple ports in a single - request. Specify a list of ports in the request - body. - Guarantees the atomic completion of the bulk - operation. - - &portCreateParameters; - - - - - - - - - - - &portListParameters; - - - - - - - - - - &fault400; &fault401; &fault403; &fault404; - &fault409conflict; &fault503macGeneration; - - - Shows information for a specified - port. - - &portListParameters; - - - - - - - - - - &fault401; &fault404; - - - Updates a specified port. - You can update information for a port, such as its - symbolic name and associated IPs. When you update IPs - for a port, any previously associated IPs are removed, - returned to the respective subnets allocation pools, - and replaced by the IPs specified in the body for the - update request. Therefore, this operation replaces the - 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. - When you update security groups for a port and the - operation succeeds, any associated security groups are - removed and replaced by the security groups specified - in the body for the update request. Therefore, this - operation replaces the 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. - - &portCreateParameters; - - - - - - &portListParameters; - - - - - - - - - - &fault400; &fault401; &fault403; &fault404; - &fault409conflict; - - - Deletes a specified port. - Any IP addresses that are associated with the port - are returned to the respective subnets allocation - pools. - - &fault401; &fault403; &fault404; - - diff --git a/v2.0/wadl/os-quotas.wadl b/v2.0/wadl/os-quotas.wadl deleted file mode 100644 index 4f8f8d7..0000000 --- a/v2.0/wadl/os-quotas.wadl +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - - - - - - - -%common;]> - - - - - - - - - - - -

The - tenant ID in a multi-tenancy cloud.

- - - - - - - - -

The UUID for the quota of interest to you.

 - - - - - - - - - - - - - - - - - Lists quotas for tenants who have non-default quota values. - - - - - - - - - - - - - - - - - - - - - - Shows information for a specified quota. - - - - - - - - - - - - - - - - - - - - - - - Updates quotas for a specified tenant. Use when non-default quotas are desired. - - - - - - - - - - - - - - - - - - - - - - - - - - - - Resets quotas to default values for a specified tenant. - - - - - - - - - - - - - - diff --git a/v2.0/wadl/os-subnets.wadl b/v2.0/wadl/os-subnets.wadl deleted file mode 100644 index 3706616..0000000 --- a/v2.0/wadl/os-subnets.wadl +++ /dev/null @@ -1,284 +0,0 @@ - - - - - - - - - - -%common;]> - - - - - - - - - - - The tenant ID in a multi-tenancy - cloud. - - - - - - - - - - The UUID for the subnet of - interest to you. - - - - - - - - - - - - - - - - - - Lists subnets to which the - specified tenant has access. - Default policy settings returns exclusively subnets - owned by the tenant submitting the request, unless the - request is submitted by an user with administrative - rights. You can control which attributes are returned - by using the fields query parameter. You can filter - results by using query string parameters. For - information, see Filtering and Column Selection in the - OpenStack Networking API v2.0 - Reference. - - - - - - - - - - - - - - &fault401; - - - - Creates a subnet on a specified - network. - By default, OpenStack Networking creates IP v4 - subnets. To create an IP v6 subnet, you must specify - the value 6 for the 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. - To specify a subnet without a gateway, specify the - value null for the 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. - When 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. - - &subnetCreateParameters; - - - - - - - - - - - &subnetListParameters; - - - - - - - - - - - &fault400; &fault401; &fault403; &fault404; &fault409conflict; - - - - Creates multiple subnets in a - single request. Specify a list of subnets in the - request body. - The bulk create operation is always atomic. Either - all or no subnets in the request body are - created. - - &subnetCreateParameters; - - - - - - - - - - - &subnetListParameters; - - - - - - - - - - - &fault400; &fault401; &fault403; &fault404; &fault409conflict; - - - - Shows information for a specified - subnet. - You can control which attributes are returned by - using the fields query parameter. For information, see - Filtering and Column Selection in the - OpenStack Networking API v2.0 - Reference. - - &subnetListParameters; - - - - - - - - - - - &fault401; &fault404; - - - - - Updates a specified subnet. - Some attributes, such as IP version (ip_version), - CIDR (cidr), and IP allocation pools - (allocation_pools) cannot be updated. Attempting to - update these attributes results in a 400 Bad Request - error. - - &subnetCreateParameters; - - - - - - - - - - - &subnetListParameters; - - - - - - - - - - - &fault400; &fault401; &fault403; &fault404; - - - - - Deletes a specified subnet. - The operation fails if subnet IP addresses are still - allocated. - - - &fault401; &fault404; &fault409conflict; - - diff --git a/v2.0/wadl/security-groups.wadl b/v2.0/wadl/security-groups.wadl deleted file mode 100644 index 43f7221..0000000 --- a/v2.0/wadl/security-groups.wadl +++ /dev/null @@ -1,494 +0,0 @@ - - -%common;]> - - - - - - - - - - - - - - -

The unique identifier of the security - group.

- - - - - - - - - - -

The unique identifier of the security - group rule.

- - - - - - - - - -

The UUID of the instance.

- - - - - - - - - - - - Lists a summary of all OpenStack - Networking security groups that the specified tenant - can access. - The list includes the unique ID for each security - group. - This operation does not require a request - body. - This operation returns a response body. - - - - - - - - - - - - - - - - - - - - - Creates an OpenStack Networking - security group. - This operation requires a request body. The request - body must include one or both of the following - attributes: - - name. String. Specifies a - symbolic name for the security group. Not - required to be unique. - - description. String. Describes - the security group. - - This operation creates a security group with default - security group rules for the IPv4 and IPv6 ethertypes. - The following attributes of a security group rule have - a value of null: - port_range_max - port_range_min - protocol - remote_group_id - remote_ip_prefix - This operation returns a response body. - - - - - - - - - - - - - - - - - - - - - - - - - - - Shows information for a specified - security group. - This operation does not require a request - body. - This operation returns a response body that contains - the description, name, ID, and security group rules - associated with the specified security group and - tenant ID. - - - - - - - - - - - - - - - - - - - - - - - - - - - Deletes an OpenStack Networking - security group. - This operation deletes an OpenStack Networking - security group and its associated security group - rules, provided that a port is not associated with the - security group. - This operation does not require a request body. This - operation does not return a response body. - - - - - - - - - - - - - - - - - - - - - - - - - - - Lists a summary of all OpenStack - Networking security group rules that the specified - tenant can access. - The list provides the unique ID for each security - group rule. - This operation does not require a request body. This - operation returns a response body. - - - - - - - - - - - - - - - - - - - - - - - - Creates an OpenStack Networking - security group rule. - This operation requires a request body. - The following table describes the required and - optional attributes in the request body: - - - - - - - - - - - - - - - - - - -
Create Security - Group Rule Request Attributes
AttributeRequiredDescription
directionRequiredIngress or egress: The direction in - which the security group rule is - applied. For a compute instance, an - ‘ingress’ security group rule matches - traffic that is incoming (ingress) for - that instance. An ‘egress’ rule is - applied to traffic leaving the - instance.
security_group_idRequiredThe security group ID to associate - with this security group - rule.
port_range_minOptionalThe - minimum port number in the range that - is matched by the security group rule. - If the protocol is TCP or UDP, this - value must be less than or equal to - the value of the port_range_max - attribute. If the protocol is ICMP, - this value must be an ICMP - type.
port_range_maxOptionalThe - maximum port number in the range that - is matched by the security group rule. - The port_range_min attribute - constrains the port_range_max - attribute. If the protocol is ICMP, - this value must be an ICMP - type.
protocolOptionalThe - protocol that is matched by the - security group rule. Valid values are - null, tcp, udp, and icmp. -
remote_group_idOptionalThe - remote group ID to be associated with - this security group rule. You can - specify either remote_group_id or - remote_ip_prefix in the request body. -
remote_ip_prefixOptionalThe - remote IP prefix to be associated with - this security group rule. You can - specify either remote_group_id or - remote_ip_prefix in the request body. - This attribute matches the specified - IP prefix as the source IP address of - the IP - packet.
- This operation returns a response body. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Shows detailed information for a - specified security group rule. - This operation does not require a request - body. - This operation returns a response body, which - contains the following information about the security - group rule: - direction. - Either ingress or egress. - ethertype. Either IPv4 or - IPv6. - The ID for the specified security - group rule - The min and max port ranges - - The protocol - The tenant ID - The remote group ID - The remote IP prefix - The security group ID for the security - group with which the rule is - associated - The tenant - ID - - - - - - - - - - - - - - - - - - - - - - - - - - - Deletes a specified rule from a - OpenStack Networking security group. - This operation does not require a request - body. - This operation does not return a response body. - - - - - - - - - - - - - - - - - - - - - - - - - -