diff --git a/api-ref/src/docbkx/ch_netconn-v2-ext.xml b/api-ref/src/docbkx/ch_netconn-v2-ext.xml index b749d8913..328a97f6b 100644 --- a/api-ref/src/docbkx/ch_netconn-v2-ext.xml +++ b/api-ref/src/docbkx/ch_netconn-v2-ext.xml @@ -14,8 +14,10 @@ Networking API v2.0 extensions (CURRENT)
Extensions - Lists available Networking API v2.0 extensions and shows details for an - extension. + + Lists available Networking API v2.0 extensions and shows details for an + extension. + @@ -25,52 +27,205 @@
-
- Quotas extension (quotas) +
+ FWaaS v2.0 (CURRENT) (fw, firewalls) - Lists quotas for tenants who have non-default quota values, and - lists, updates, and resets quotas for a tenant. + Use the Firewall-as-a-Service (FWaaS) extension to deploy + firewalls to protect your networks. - A quota value of -1 means that quota has no limit. + Use the FWaaS extension to: - - - - - - - - - - + + + + Apply firewall rules on traffic entering and leaving + tenant networks. + + + + + Apply TCP, UDP, ICMP, or protocol-agnostic + rules. + + + + + Create and share firewall policies that hold an ordered + collection of the firewall rules. + + + + + Audit firewall rules and policies. + + + + This extension introduces these resources: + + + + firewall. A logical firewall + resource that a tenant can instantiate and manage. A + firewall can have one firewall policy. + + + + + firewall_policy. An ordered collection of + firewall rules. You can share a firewall policy across + tenants. You can include a firewall policy as part of an audit workflow + so that an authorized relevant entity can audit the firewall policy. + This entity can differ from the tenant who created, or the + tenants that use, the firewall policy. + + + + + firewall_rule. A collection of attributes, + such as ports and IP addresses. These attributes define match + criteria and an action to take, such as allow or deny, on matched data + traffic. + + + + +
+
+LBaaS v2.0 (STABLE) (loadbalancers, listeners, vips, health_monitors, pools) + + The Load-Balancer-as-a-Service (LBaaS) v2.0 extension pairs with + the Networking API v2.0 to enable OpenStack tenants to manage load + balancers for their VMs. With this extension you can load-balance + client traffic from one network to application services, such as + VMs, on the same network. + + + Use this extension to create and manage load balancers, listeners, + pools, members of a pool, and health monitors and view status of a resource. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Load balancer statuses
StatusDescription
ACTIVEThe resource is ready and active.
PENDING_CREATEThe resource is being created.
PENDING_UPDATEThe resource is being updated.
PENDING_DELETEThe resource is pending deletion.
INACTIVEThe resource is not active.
ERROR + An object within the service is not working. The + error_details attribute provides an + explanation for the error, its cause, and possibly a + solution. +
+ + +
+
+ LBaaS v1.0 (DEPRECATED) (lb, vips, health_monitors, pools, members) + + The Load-Balancer-as-a-Service (LBaaS) v1.0 extension pairs with + the Networking API v2.0 to enable OpenStack tenants to manage load + balancers for their VMs. With this extension, you can load-balance + client traffic from one network to application services, such as + VMs, on the same network. + + + Use this extension to create and manage virtual IP addresses + (VIPs), pools, members of a pool, health monitors, and view status + of a resource. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Load balancer statuses
StatusDescription
ACTIVEThe resource is ready and active.
PENDING_CREATEThe resource is being created.
PENDING_UPDATEThe resource is being updated.
PENDING_DELETEThe resource is pending deletion.
INACTIVEThe resource is not active.
ERROR + + An object within the service is not working. The + error_details attribute provides an + explanation for the error, its cause, and + possibly a solution. + +
+ + +
+
+ Metering labels and rules (metering-labels, metering-labels-rules) + + Creates, modifies, and deletes OpenStack Layer3 metering labels and rules. + +
Networks provider extended attributes (networks) - - Lists, creates, shows information for, updates, and deletes networks. - - - The provider extension decorates network resources with additional - attributes. These attributes are - provider:network_type, - provider:physical_network, and - provider:segmentation_id. The validation rules for - these attributes are the same as for the Networks multiple provider extension. You cannot use both extensions at the - same time. - - - - - - - - - - - - + Lists, creates, shows information for, updates, and deletes networks. +
Networks multiple provider extension (networks) @@ -137,17 +292,44 @@
Ports binding extended attributes (ports) Lists, creates, shows information for, and updates ports. - - - - - - - - - - - + +
+
+ QoS policies (qos) + Lists, creates, shows information for, and updates QoS policies. + +
+
+ Quotas extension v2.0 (quotas) + + Lists quotas for tenants who have non-default quota values, and + lists, updates, and resets quotas for a tenant. + + + A quota value of -1 means that quota has no limit. + + +
+
+ Layer 3 networking (routers, floatingips) + + Routes packets between subnets, forwards packets from internal + networks to external ones, and accesses instances from external + networks through floating IPs. + + + This extension introduces the router and floating IP resources. A + router is a logical entity for forwarding packets across internal + subnets and NATting them on external networks through an + appropriate external gateway. A floating IP is an external IP + address that is mapped to a port that is attached to an internal + network. + +
Security groups (security-groups) @@ -167,7 +349,7 @@
- -
- Layer-3 networking - - Routes packets between subnets, forwards packets from internal - networks to external ones, and accesses instances from external - networks through floating IPs. - - - This extension introduces these resources: - - - - - router. A logical entity - for forwarding packets across internal subnets and NATting them on external - networks through an appropriate external gateway. - - - - - floatingip. An external - IP address that you map to a port in an internal network. - - - - -
-
- Metering labels and rules - Creates, modifies, and deletes OpenStack Layer3 metering labels and rules. - -
-
- Firewall-as-a-Service (FWaaS) (CURRENT) - - The FWaaS extension enables you to deploy firewalls to protect - your networks. - - - The FWaaS extension enables you to: - - - - Apply firewall rules on traffic entering and leaving - tenant networks. - - - Apply TCP, UDP, ICMP, or protocol-agnostic - rules. - - - - Create and share firewall policies that hold an ordered - collection of the firewall rules. - - - - Audit firewall rules and policies. - - - This extension introduces these resources: - - - - firewall. A logical firewall - resource that a tenant can instantiate and manage. A - firewall can have one firewall policy. - - - - - firewall_policy. An ordered collection of - firewall rules. You can share a firewall policy across - tenants. You can include a firewall policy as part of an audit workflow - so that an authorized relevant entity can audit the firewall policy. - This entity can differ from the tenant who created, or the - tenants that use, the firewall policy. - - - - - firewall_rule. A collection of attributes, - such as ports and IP addresses. These attributes define match - criteria and an action to take, such as allow or deny, on matched data - traffic. - - - - - - - - - - - - - - - -
-
- Load-Balancer-as-a-Service (LBaaS) 1.0 (DEPRECATED) - - The LBaaS v1.0 extension pairs with the Networking v2.0 API to - enable OpenStack tenants to manage load balancers for their VMs. - With this extension, you can load-balance client traffic from one - network to application services, such as VMs, on the same network. - - - Use this extension to create and manage virtual IP addresses - (VIPs), pools, members of a pool, health monitors, and view status of a resource. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Load balancer statuses
StatusDescription
ACTIVEThe resource is ready and active.
PENDING_CREATEThe resource is being created.
PENDING_UPDATEThe resource is being updated.
PENDING_DELETEThe resource is pending deletion.
INACTIVEThe resource is not active.
ERROR - - An object within the service is not working. The - error_details attribute provides an - explanation for the error, its cause, and - possibly a solution. - -
- - -
-
- Load-Balancer-as-a-Service (LBaaS) 2.0 (STABLE) - - The LBaaS version 2.0 extension pairs with the Networking 2.0 API - to enable OpenStack tenants to manage load balancers for their - VMs. With this extension you can load-balance client traffic from - one network to application services, such as VMs, on the same - network. - - - Use this extension to create and manage load balancers, listeners, - pools, members of a pool, and health monitors and view status of a resource. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Load balancer statuses
StatusDescription
ACTIVEThe resource is ready and active.
PENDING_CREATEThe resource is being created.
PENDING_UPDATEThe resource is being updated.
PENDING_DELETEThe resource is pending deletion.
INACTIVEThe resource is not active.
ERROR - An object within the service is not working. The - error_details attribute provides an - explanation for the error, its cause, and possibly a - solution. -
- -
Subnet pools extension (subnetpools) @@ -442,10 +384,11 @@
- Virtual-Private-Network-as-a-Service (VPNaaS) (CURRENT) + VPNaaS v2.0 (CURRENT) (vpn) - The VPNaaS extension enables OpenStack tenants to extend private - networks across the public telecommunication infrastructure. + The Virtual-Private-Network-as-a-Service (VPNaaS) extension + enables OpenStack tenants to extend private networks across the + public telecommunication infrastructure. This initial implementation of the VPNaaS extension provides: @@ -510,11 +453,14 @@ >
- Extra routes - Adds extra routes to the - router resource. - You can update a router to add a set of next hop IPs and destination - CIDRs. + Extra routes (routers) + + Adds extra routes to the router resource. + + + You can update a router to add a set of next hop IPs and + destination CIDRs. + The next hop IP must be part of a subnet to which the router @@ -524,7 +470,7 @@ - +
diff --git a/api-ref/src/wadls/netconn-api/src/common.ent b/api-ref/src/wadls/netconn-api/src/common.ent index cebecf381..a38fa6c0e 100644 --- a/api-ref/src/wadls/netconn-api/src/common.ent +++ b/api-ref/src/wadls/netconn-api/src/common.ent @@ -176,6 +176,16 @@ '> + + + + The UUID of the policy. + + +'> @@ -198,6 +208,16 @@ '> + + + + The UUID of the rule. + + +'> @@ -570,6 +590,994 @@ '> + + + A port object. + + + +'> + + + + A ports object. + + + +'> + + + + A symbolic name for the port. + + + + + + + The administrative status of the port, which is up + (true) or down (false). + + + + &tenantIdOwnerNetwork; + + + + The MAC address. If you specify an address that is not valid, + a Bad Request (400) status code is returned. If + you do not specify a MAC address, OpenStack Networking tries + to allocate one. If a failure occurs, a Service + Unavailable (503) status code 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 address to the + port. + + + + + + + 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 address to the + port. + + + + + + + If you specify both a subnet ID and an IP address, OpenStack + Networking tries to allocate the address to the + port. + + + + + + + One or more security group IDs. + + + + + + + The ID of the network. + + + + + + + A set of zero or more allowed address pairs. An address pair + contains an IP address and MAC address. + + + + + + + The IP address of an allowed address pair. + + + + + + + The MAC address of an allowed address pair. + + + + + + + The extra DHCP option value. + + + + + + + The extra DHCP option name. + + + + + + + The ID of the entity that uses this port. For example, a DHCP + agent. + + + + + + + The ID of the device that uses this port. For example, a + virtual server. + + + +'> + + + + The port status. Value is ACTIVE or DOWN. + + + + + + + The port name. + + + + + + + A set of zero or more allowed address pairs. An address pair + consists of an IP address and MAC address. + + + + + + + The IP address. + + + + + + + The MAC address. + + + + + + + The administrative state of the port, which is up + (true) or down (false). + + + + + + + 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. + + + + + + + A set of zero or more extra DHCP option pairs. An option pair + consists of an option value and name. + + + + + + + The extra DHCP option value. + + + + + + + The extra DHCP option name. + + + + + + + The ID of the entity that uses this port. For example, a DHCP + agent. + + + + + + + The MAC address of the port. + + + + + + + IP addresses for the port. Includes the IP address and subnet + ID. + + + + + + + Subnet ID of the subnet to which the port is attached. + + + + + + + IP address. + + + + + + + The ID of the port. + + + + + + + The IDs of any attached security groups. + + + + + + + The ID of the device that uses this port. For example, a virtual + server. + + + + + + + The port security status. The status is enabled + (true) or disabled (false). + + + +'> + + + + + The port status. Value is ACTIVE or DOWN. + + + + + + + The port name. + + + + + + + The administrative state of the router, which is up (true) + or down (false). + + + + + + + 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. You cannot + change this value through authorization policies. + + + + + + + The ID of the entity that uses this port. For example, a DHCP + agent. + + + + + + + The MAC address of the port. + + + + + + + The ID of the port. + + + + + + + The IDs of any attached security groups. + + + + + + + The ID of the device that uses this port. For example, a + virtual server. + + + +'> + + + + + + + + + The ID of the host where the port is allocated. In some + cases, different implementations can run on different + hosts. + + + + + + + A dictionary that enables the application running on the + host to pass and receive virtual network interface + (VIF) port-specific information to the plug-in. + + + + + + + The virtual network interface card (vNIC) type that is bound + to the neutron port. A valid value is normal, + direct, or macvtap. + + + +'> + + + + The ID of the host where the port is allocated. In some + cases, different implementations can run on different + hosts. + + + + + + + Read-only. A dictionary that enables the application to + pass information about functions that the Networking API + provides. To enable or disable port filtering features such as + security group and anti-MAC/IP spoofing, specify port_filter: + True or port_filter: + False. + + + + + + + Read-only. A dictionary that enables the application to + pass information about functions that the Networking API + provides. To enable or disable port filtering features such as + security group and anti-MAC/IP spoofing, specify port_filter: + True or port_filter: + False. + + + + + + + Read-only. A dictionary that enables the application to + pass information about functions that the Networking API + provides. To enable or disable port filtering features such as + security group and anti-MAC/IP spoofing, specify port_filter: + True or port_filter: + False. + + + + + + + Read-only. The VIF type for the specified + port. + + + + + + + A dictionary the enables the application running on the + host to pass and receive VIF port-specific + information to the plug-in. + + + + + + + The virtual network interface card (vNIC) type that is bound + to the neutron port. + + + In &POST; and &PUT; operations, specify a value of + normal (virtual NIC), direct (PCI + pass-through), or macvtap (virtual interface with + a tap-like software interface). These values support SR-IOV + PCI pass-through networking. The ML2 plug-in supports the + vnic_type. + + + In &GET; operations, the binding:vnic_type extended + attribute is visible to only port owners and administrative users. + + + +'> + + + + 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 start address for the allocation pools. + + + + The end address 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. + + + + DNS server. + + + + A list of host route dictionaries for the subnet. + For example: + "host_routes":[ + { + "destination":"0.0.0.0/0", + "nexthop":"123.456.78.9" + }, + { + "destination":"192.168.0.0/24", + "nexthop":"192.168.0.1" + } +] + + + + Destination for static route. + + + + The next hop for the destination. + + + + + The IPv6 RA mode, which is dhcpv6-stateful, + dhcpv6-stateless, or slaac. + + + + + + + The IPv6 address mode, which is dhcpv6-stateful, + dhcpv6-stateless, or slaac. + + + + '> + + + Name of the network. + + + + The ID of the attached network. + + &tenantIdOwnerNetwork; + + + The gateway IP address. + + + + The IP version, which is 4 or 6. + + + + The CIDR. + + + + The ID of the subnet. + + + + If true, DHCP is enabled and If false, DHCP is disabled. + + + + Choose from (constants.IPV6_SLAAC,constants.DHCPV6_STATEFUL,constants.DHCPV6_STATELESS,name='ipv6_address_modes,null). + + + + Choose from (constants.IPV6_SLAAC,constants.DHCPV6_STATEFUL,constants.DHCPV6_STATELESS,name='ipv6_address_modes,null). + '> + + + + The subnet name. + + + + The ID of the attached network. + + &tenantIdOwnerNetwork; + + + The start and end addresses for the allocation pools. + + + + The start address for the allocation pools. + + + + The end address for the allocation pools. + + + + The gateway IP address. + + + + The IP version, which is 4 or 6. + + + + The CIDR. + + + + Set to true if DHCP is enabled and false if DHCP is disabled. + + + + A list of DNS name servers for the subnet. Specify each name server as an IP address and separate multiple entries with a space. For example [8.8.8.7 8.8.8.8]. + + + + A list of host route dictionaries for the subnet. For example: + "host_routes":[ + { + "destination":"0.0.0.0/0", + "nexthop":"123.456.78.9" + }, + { + "destination":"192.168.0.0/24", + "nexthop":"192.168.0.1" + } +] + + + + Destination for static route + + + + The next hop for the destination. + + + + A valid value is dhcpv6-stateful, dhcpv6-stateless, or slaac. + + + + A valid value is dhcpv6-stateful, dhcpv6-stateless, or slaac. + '> + + + The subnet name. + + + + The start and end addresses for the allocation pools. + + + + The start address for the allocation pools. + + + + The end address for the allocation pools. + + + + The gateway IP address. + + + + Set to true if DHCP is enabled and false if DHCP is disabled. + + + + DNS server + + + + A list of host route dictionaries for the subnet. For example: + "host_routes":[ + { + "destination":"0.0.0.0/0", + "nexthop":"123.456.78.9" + }, + { + "destination":"192.168.0.0/24", + "nexthop":"192.168.0.1" + } +] + + + + Destination for static route + + + + The next hop for the destination + '> + + + + 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. + + &limitMarkerReqParameter; + + + Value of the status of the server so that you can filter on "ACTIVE" for example. + + + + Name of the host as a string. + '> + + + + Integer value for the minimum disk space in GB so you can filter results. + + + + Integer value for the minimum RAM, in MB, so that you can filter results. + + + + UUID of the flavor at which you want to set a marker. + + &limitMarkerReqParameter; '> + + - Each subnet prefix must be unique among all subnet prefixes in all - subnet pools that are associated with the address scope. + Ensure that each subnet prefix is unique among all subnet prefixes + in all subnet pools that are associated with the address + scope. @@ -6868,9 +7877,9 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> - The size of the prefix to allocate when the cidr or - prefixlen attributes are omitted when you create - the subnet. Default is min_prefixlen. + The size of the prefix to allocate when the cidr or + prefixlen attributes are omitted when you create + the subnet. Default is min_prefixlen. @@ -6982,9 +7991,9 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> - The size of the prefix to allocate when the cidr or - prefixlen attributes are omitted when you create - the subnet. Default is min_prefixlen. + The size of the prefix to allocate when the cidr or + prefixlen attributes are omitted when you create + the subnet. Default is min_prefixlen. @@ -7090,9 +8099,9 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> - The size of the prefix to allocate when the cidr or - prefixlen attributes are omitted when you create - the subnet. + The size of the prefix to allocate when the cidr or + prefixlen attributes are omitted when you create + the subnet. @@ -7504,3 +8513,292 @@ &firewall-router_idsRequestParameter; &firewall-firewall_policy_idRequestParameter; &firewall-nameRequestParameter;'> + + + + A policy object. + + +'> + + + + A list of policy objects. + + +'> + + + + A bandwidth_limit_rule object. + + +'> + + + + A list of bandwidth limit rule objects. + + +'> + + + + The generated UUID of the QoS policy. + + +'> + + + + The QoS policy name. + + +'> + + + + The QoS policy name. + + +'> + + + + The QoS policy description. + + +'> + + + + The QoS policy description. + + +'> + + + + Set to true to share this policy with other tenants. + + + Default is false. + + +'> + + + + Set to true to share this policy with other tenants. + + + Default is false. + + +'> + + + + A list of bandwidth limit rules associated with the QoS policy. + + +'> + + + + A list of bandwidth limit rules associated with the QoS policy. + + +'> + + + + The tenant UUID of QoS policy owner. Only administrative + users can specify a tenant UUID other than their own. You cannot + change this value through authorization policies. + + +'> + + + + The tenant UUID of QoS policy owner. + + +'> + + + + The type of QoS policy. + + +'> + + + + The type of QoS policy. + + +'> + + + + The direction to which to apply the QoS policy rule. Valid value is + ingress or egress. + + + Default is egress. + + +'> + + + + The direction to which to apply the QoS policy rule. Valid value is + ingress or egress. + + + Default is egress. + + +'> + + + + The UUID of the QoS policy rule. + + +'> + + + + The UUID of the QoS policy rule. + + +'> + + + + The UUID of the QoS policy that is associated with the rule. + + +'> + + + + The UUID of the QoS policy that is associated with the rule. + + +'> + + + + The maximum KBPS value. If you specify this value, must be greater than + 0. Default is null. + + +'> + + + + The maximum KBPS value. + + +'> + + + + The burst over the maximum KBPS value. Default is 0 + + +'> + + + + The burst over the maximum KBPS value. + + +'> diff --git a/api-ref/src/wadls/netconn-api/src/samples/qos/bandwidth_limit_rule-create-request.json b/api-ref/src/wadls/netconn-api/src/samples/qos/bandwidth_limit_rule-create-request.json new file mode 100644 index 000000000..8234acf10 --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/samples/qos/bandwidth_limit_rule-create-request.json @@ -0,0 +1,5 @@ +{ + "bandwidth_limit_rule": { + "max_kbps": "10000" + } +} diff --git a/api-ref/src/wadls/netconn-api/src/samples/qos/bandwidth_limit_rule-create-response.json b/api-ref/src/wadls/netconn-api/src/samples/qos/bandwidth_limit_rule-create-response.json new file mode 100644 index 000000000..3ac737e93 --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/samples/qos/bandwidth_limit_rule-create-response.json @@ -0,0 +1,8 @@ +{ + "bandwidth_limit_rule": { + "id": "5f126d84-551a-4dcf-bb01-0e9c0df0c793", + "policy_id": "46ebaec0-0570-43ac-82f6-60d2b03168c4", + "max_kbps": "10000", + "max_burst_kbps": "0" + } +} diff --git a/api-ref/src/wadls/netconn-api/src/samples/qos/bandwidth_limit_rule-show-response.json b/api-ref/src/wadls/netconn-api/src/samples/qos/bandwidth_limit_rule-show-response.json new file mode 100644 index 000000000..3ac737e93 --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/samples/qos/bandwidth_limit_rule-show-response.json @@ -0,0 +1,8 @@ +{ + "bandwidth_limit_rule": { + "id": "5f126d84-551a-4dcf-bb01-0e9c0df0c793", + "policy_id": "46ebaec0-0570-43ac-82f6-60d2b03168c4", + "max_kbps": "10000", + "max_burst_kbps": "0" + } +} diff --git a/api-ref/src/wadls/netconn-api/src/samples/qos/bandwidth_limit_rule-update-request.json b/api-ref/src/wadls/netconn-api/src/samples/qos/bandwidth_limit_rule-update-request.json new file mode 100644 index 000000000..8234acf10 --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/samples/qos/bandwidth_limit_rule-update-request.json @@ -0,0 +1,5 @@ +{ + "bandwidth_limit_rule": { + "max_kbps": "10000" + } +} diff --git a/api-ref/src/wadls/netconn-api/src/samples/qos/bandwidth_limit_rule-update-response.json b/api-ref/src/wadls/netconn-api/src/samples/qos/bandwidth_limit_rule-update-response.json new file mode 100644 index 000000000..3ac737e93 --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/samples/qos/bandwidth_limit_rule-update-response.json @@ -0,0 +1,8 @@ +{ + "bandwidth_limit_rule": { + "id": "5f126d84-551a-4dcf-bb01-0e9c0df0c793", + "policy_id": "46ebaec0-0570-43ac-82f6-60d2b03168c4", + "max_kbps": "10000", + "max_burst_kbps": "0" + } +} diff --git a/api-ref/src/wadls/netconn-api/src/samples/qos/bandwidth_limit_rules-list-response.json b/api-ref/src/wadls/netconn-api/src/samples/qos/bandwidth_limit_rules-list-response.json new file mode 100644 index 000000000..f4cd1200b --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/samples/qos/bandwidth_limit_rules-list-response.json @@ -0,0 +1,10 @@ +{ + "bandwidth_limit_rules": [ + { + "id": "5f126d84-551a-4dcf-bb01-0e9c0df0c793", + "policy_id": "46ebaec0-0570-43ac-82f6-60d2b03168c4", + "max_kbps": "10000", + "max_burst_kbps": "0" + } + ] +} diff --git a/api-ref/src/wadls/netconn-api/src/samples/qos/policies-list-response.json b/api-ref/src/wadls/netconn-api/src/samples/qos/policies-list-response.json new file mode 100644 index 000000000..0139dd98a --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/samples/qos/policies-list-response.json @@ -0,0 +1,19 @@ +{ + "policies": [ + { + "tenant_id": "8d4c70a21fed4aeba121a1a429ba0d04", + "id": "46ebaec0-0570-43ac-82f6-60d2b03168c4", + "name": "10Mbit", + "description": "This policy limits the ports to 10Mbit max.", + "shared": false, + "bandwidth_limit_rules": [ + { + "id": "5f126d84-551a-4dcf-bb01-0e9c0df0c793", + "policy_id": "46ebaec0-0570-43ac-82f6-60d2b03168c4", + "max_kbps": "10000", + "max_burst_kbps": "0" + } + ] + } + ] +} diff --git a/api-ref/src/wadls/netconn-api/src/samples/qos/policy-create-request.json b/api-ref/src/wadls/netconn-api/src/samples/qos/policy-create-request.json new file mode 100644 index 000000000..fb1c28f4d --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/samples/qos/policy-create-request.json @@ -0,0 +1,7 @@ +{ + "policy": { + "name": "10Mbit", + "description": "This policy limits the ports to 10Mbit max.", + "shared": "False" + } +} diff --git a/api-ref/src/wadls/netconn-api/src/samples/qos/policy-create-response.json b/api-ref/src/wadls/netconn-api/src/samples/qos/policy-create-response.json new file mode 100644 index 000000000..2d3215149 --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/samples/qos/policy-create-response.json @@ -0,0 +1,9 @@ +{ + "policy": { + "name": "10Mbit", + "description": "This policy limits the ports to 10Mbit max.", + "id": "46ebaec0-0570-43ac-82f6-60d2b03168c4", + "tenant_id": "8d4c70a21fed4aeba121a1a429ba0d04", + "shared": "False" + } +} diff --git a/api-ref/src/wadls/netconn-api/src/samples/qos/policy-show-response.json b/api-ref/src/wadls/netconn-api/src/samples/qos/policy-show-response.json new file mode 100644 index 000000000..4d59bed93 --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/samples/qos/policy-show-response.json @@ -0,0 +1,17 @@ +{ + "policy": { + "tenant_id": "8d4c70a21fed4aeba121a1a429ba0d04", + "id": "46ebaec0-0570-43ac-82f6-60d2b03168c4", + "name": "10Mbit", + "description": "This policy limits the ports to 10Mbit max.", + "shared": false, + "bandwidth_limit_rules": [ + { + "id": "5f126d84-551a-4dcf-bb01-0e9c0df0c793", + "policy_id": "46ebaec0-0570-43ac-82f6-60d2b03168c4", + "max_kbps": "10000", + "max_burst_kbps": "0" + } + ] + } +} diff --git a/api-ref/src/wadls/netconn-api/src/samples/qos/policy-update-request.json b/api-ref/src/wadls/netconn-api/src/samples/qos/policy-update-request.json new file mode 100644 index 000000000..fb1c28f4d --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/samples/qos/policy-update-request.json @@ -0,0 +1,7 @@ +{ + "policy": { + "name": "10Mbit", + "description": "This policy limits the ports to 10Mbit max.", + "shared": "False" + } +} diff --git a/api-ref/src/wadls/netconn-api/src/samples/qos/policy-update-response.json b/api-ref/src/wadls/netconn-api/src/samples/qos/policy-update-response.json new file mode 100644 index 000000000..2d3215149 --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/samples/qos/policy-update-response.json @@ -0,0 +1,9 @@ +{ + "policy": { + "name": "10Mbit", + "description": "This policy limits the ports to 10Mbit max.", + "id": "46ebaec0-0570-43ac-82f6-60d2b03168c4", + "tenant_id": "8d4c70a21fed4aeba121a1a429ba0d04", + "shared": "False" + } +} diff --git a/api-ref/src/wadls/netconn-api/src/samples/qos/rule_types-list-response.json b/api-ref/src/wadls/netconn-api/src/samples/qos/rule_types-list-response.json new file mode 100644 index 000000000..97b0a3cb9 --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/samples/qos/rule_types-list-response.json @@ -0,0 +1,7 @@ +{ + "rule_types": [ + { + "type": "bandwidth_limit" + } + ] +} diff --git a/api-ref/src/wadls/netconn-api/src/wadl/qos.wadl b/api-ref/src/wadls/netconn-api/src/wadl/qos.wadl new file mode 100644 index 000000000..e50bdacf3 --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/wadl/qos.wadl @@ -0,0 +1,318 @@ + + + + + + + + + + + %common; + + %common_project; +]> + + + + + + + + + + + + &policy_idTemplateParameter; + + + + + + + + &rule_idTemplateParameter; + + + + + + + + + + + + + + + + + Lists all QoS policies that are associated with your tenant + account. + + + The list might be empty. + + + + + + + + &policiesObject; + &qos-policy-tenant_idResponseParameter; + &qos-policy-idResponseParameter; + &qos-policy-nameResponseParameter; + &qos-policy-descriptionResponseParameter; + &qos-policy-sharedResponseParameter; + &bandwidth_limit_rulesResponseParameter; + &qos-policy-rule-idResponseParameter; + &qos-policy-rule-policy_idResponseParameter; + &max_kbpsResponseParameter; + &max_burst_kbpsResponseParameter; + + &fault401; &fault500; &fault503; + + + + + Creates a QoS policy. + + + Creates a QoS policy by using the configuration that you + define in the request object. A response object is returned. + The object contains a unique ID. + + + If the caller is not an administrative user, this call returns + the HTTP Forbidden (403) response code. + + + Users with an administrative role can create policies on + behalf of other tenants by specifying a tenant UUID that is + different than their own. + + + + + + + + &policyObject; + &qos-policy-nameRequestParameter; + &qos-policy-descriptionRequestParameter; + &qos-policy-sharedRequestParameter; + &qos-policy-tenant_idRequestParameter; + &qos-policy-typeRequestParameter; + + + + + + + + &policyObject; + &qos-policy-tenant_idResponseParameter; + &qos-policy-idResponseParameter; + &qos-policy-nameResponseParameter; + &qos-policy-descriptionResponseParameter; + &qos-policy-sharedResponseParameter; + + &fault401; &fault404; &fault409; &fault413; &fault500; &fault503; + + + + + Shows details for a QoS policy. + + + + + + + + &policyObject; + &qos-policy-tenant_idResponseParameter; + &qos-policy-idResponseParameter; + &qos-policy-nameResponseParameter; + &qos-policy-descriptionResponseParameter; + &qos-policy-sharedResponseParameter; + &bandwidth_limit_rulesResponseParameter; + &qos-policy-rule-idResponseParameter; + &qos-policy-rule-policy_idResponseParameter; + &max_kbpsResponseParameter; + &max_burst_kbpsResponseParameter; + + &fault401; &fault500; &fault503; + + + + + Updates a QoS policy. + + + If the request is valid, the service returns the + Accepted (202) response code. + + + + + + + + &policyObject; + &qos-policy-nameRequestParameter; + &qos-policy-descriptionRequestParameter; + &qos-policy-sharedRequestParameter; + &qos-policy-tenant_idRequestParameter; + &qos-policy-typeRequestParameter; + + + + + + + + &policyObject; + &qos-policy-tenant_idResponseParameter; + &qos-policy-idResponseParameter; + &qos-policy-nameResponseParameter; + &qos-policy-descriptionResponseParameter; + &qos-policy-sharedResponseParameter; + + &fault400; &fault401; &fault413; &fault500; &fault503; + + + + + Deletes a QoS policy. + + + &fault400; &fault401; &fault413; &fault500; &fault503; + + + + + Lists all bandwidth limit rules for a QoS policy. + + + The list might be empty. + + + + + + + + &bandwidth_limit_rulesResponseParameter; + &qos-policy-rule-idResponseParameter; + &qos-policy-rule-policy_idResponseParameter; + &max_kbpsResponseParameter; + &max_burst_kbpsResponseParameter; + + &fault401; &fault500; &fault503; + + + + + Creates a bandwidth limit rule for a QoS policy. + + + + + + + + &bandwidth_limit_ruleObject; + &qos-policy-rule-policy_idRequestParameter; + &max_kbpsRequestParameter; + &max_burst_kbpsRequestParameter; + + + + + + + + &bandwidth_limit_ruleObject; + &qos-policy-rule-idResponseParameter; + &qos-policy-rule-policy_idResponseParameter; + &max_kbpsResponseParameter; + &max_burst_kbpsResponseParameter; + + &fault401; &fault404; &fault409; &fault413; &fault500; &fault503; + + + + + Shows details for a bandwidth limit rule for a QoS policy. + + + + + + + + &bandwidth_limit_ruleObject; + &qos-policy-rule-idResponseParameter; + &qos-policy-rule-policy_idResponseParameter; + &max_kbpsResponseParameter; + &max_burst_kbpsResponseParameter; + + &fault401; &fault500; &fault503; + + + + + Updates a bandwidth limit rule for a QoS policy. + + + If the request is valid, the service returns the + Accepted (202) response code. + + + + + + + + &bandwidth_limit_ruleObject; + &qos-policy-rule-policy_idRequestParameter; + &max_kbpsRequestParameter; + &max_burst_kbpsRequestParameter; + + + + + + + + &bandwidth_limit_ruleObject; + &qos-policy-rule-idResponseParameter; + &qos-policy-rule-policy_idResponseParameter; + &max_kbpsResponseParameter; + &max_burst_kbpsResponseParameter; + + &fault400; &fault401; &fault413; &fault500; &fault503; + + + + + Deletes a bandwidth limit rule for a QoS policy. + + + &fault400; &fault401; &fault413; &fault500; &fault503; + +