diff --git a/api-ref/src/docbkx/ch_netconn-ext-v2.xml b/api-ref/src/docbkx/ch_netconn-ext-v2.xml index 141f6521e..455eea5d5 100644 --- a/api-ref/src/docbkx/ch_netconn-ext-v2.xml +++ b/api-ref/src/docbkx/ch_netconn-ext-v2.xml @@ -31,6 +31,7 @@
Networks provider extended attributes (networks) + List, create, show information for, update, and delete networks. @@ -70,6 +71,7 @@
Ports binding extended attributes (ports) + List, create, show information for, and update ports. @@ -83,6 +85,8 @@
Security groups and rules (security-groups) + List, create, show information for, and delete security groups and security group + rules. @@ -136,7 +140,104 @@ services, such as VMs, on the same or a different network. You can load-balance several protocols, such as TCP and HTTP and monitor the health of application services. The LBaaS extension supports session persistence. - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Load balancer statuses
StatusDescriptionOperational
DEFERREDAn entity was created but is not yet linked to a load balancer.No
PENDING_CREATEAn entity is being created.No
PENDING_UPDATEAn entity was updated. It remains in an operational state.Yes
PENDING_DELETEAn entity is in the process of being deleted.No
ACTIVEAn entity is in a normal operational state.Yes
INACTIVEApplies to members that fail health checks.No
ERRORSomething has gone wrong.This might be in either an operational or non-operational state.
+ Use this extension to create and manage load balancers, listeners, pools, members, and + health monitors. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
diff --git a/api-ref/src/wadls/netconn-api/src/api_samples/healthmonitor-put-req.json b/api-ref/src/wadls/netconn-api/src/api_samples/healthmonitor-put-req.json index 48e80d934..b20c3db49 100644 --- a/api-ref/src/wadls/netconn-api/src/api_samples/healthmonitor-put-req.json +++ b/api-ref/src/wadls/netconn-api/src/api_samples/healthmonitor-put-req.json @@ -1,6 +1,6 @@ { "healthmonitor":{ - "path":"/healthcheck", + "url_path":"/healthcheck", "delay":3 } } diff --git a/api-ref/src/wadls/netconn-api/src/api_samples/loadbalancer-list-resp.json b/api-ref/src/wadls/netconn-api/src/api_samples/loadbalancer-list-resp.json index ece065d00..b5ba68e4e 100644 --- a/api-ref/src/wadls/netconn-api/src/api_samples/loadbalancer-list-resp.json +++ b/api-ref/src/wadls/netconn-api/src/api_samples/loadbalancer-list-resp.json @@ -1,10 +1,20 @@ { - "loadbalancers":{ - "id":"3b98602c-3cfe-4f91-bfa4-c3a11c9e7fe0", - "name":"Example LB", - "description":"A very simple example load balancer.", - "tenant_id":"783b31af-6635-48b2-a807-091d9973e3a9", - "admin_state_up":true, - "status":"ACTIVE" - } -} \ No newline at end of file + "loadbalancers": [ + { + "id": "3b98602c-3cfe-4f91-bfa4-c3a11c9e7fe0", + "name": "Example LB", + "description": "A very simple example load balancer.", + "tenant_id": "783b31af-6635-48b2-a807-091d9973e3a9", + "admin_state_up": true, + "status": "ACTIVE" + }, + { + "id": "c617c538-daa5-4ead-be88-59521d8745a7", + "name": "Example LB", + "description": "A very simple example load balancer.", + "tenant_id": "783b31af-6635-48b2-a807-091d9973e3a9", + "admin_state_up": true, + "status": "ACTIVE" + } + ] +} diff --git a/api-ref/src/wadls/netconn-api/src/api_samples/loadbalancer-post-resp.json b/api-ref/src/wadls/netconn-api/src/api_samples/loadbalancer-post-resp.json index 383ed4259..218cb8c75 100755 --- a/api-ref/src/wadls/netconn-api/src/api_samples/loadbalancer-post-resp.json +++ b/api-ref/src/wadls/netconn-api/src/api_samples/loadbalancer-post-resp.json @@ -1,11 +1,12 @@ -{ - "loadbalancer":{ - "id":"8992a43f-83af-4b49-9afd-c2bfbd82d7d7", - "name":"Example LB", - "description":"A very simple example load balancer.", - "vip_address":"1.2.3.4", - "vip_subnet_id":"SUBNET_ID", - "tenant_id":"7725fe12-1c14-4f45-ba8e-44bf01763578", - "status":"PENDING_CREATE" - } -} \ No newline at end of file +{"loadbalancer": + { + "id": "8992a43f-83af-4b49-9afd-c2bfbd82d7d7", + "name": "Example LB", + "description": "A very simple example load balancer.", + "vip_address": "1.2.3.4", + "vip_subnet_id": "SUBNET_ID", + "tenant_id": "7725fe12-1c14-4f45-ba8e-44bf01763578", + "admin_state_up": true, + "status": "PENDING_CREATE" + } +} diff --git a/api-ref/src/wadls/netconn-api/src/api_samples/member-list-resp.json b/api-ref/src/wadls/netconn-api/src/api_samples/member-list-resp.json index c3ce938d2..59013328e 100644 --- a/api-ref/src/wadls/netconn-api/src/api_samples/member-list-resp.json +++ b/api-ref/src/wadls/netconn-api/src/api_samples/member-list-resp.json @@ -1,12 +1,24 @@ { - "members":{ - "id":"975592ca-e308-48ad-8298-731935ee9f45", - "address":"192.0.2.14", - "protocol_port":8080, - "tenant_id":"453105b9-1754-413f-aab1-55f1af620750", - "admin_state_up":true, - "weight":1, - "subnet_id":"SUBNET_ID", - "status":"DOWN" - } -} \ No newline at end of file + "members": [ + { + "id": "975592ca-e308-48ad-8298-731935ee9f45", + "address": "192.0.2.14", + "protocol_port": 8080, + "tenant_id": "453105b9-1754-413f-aab1-55f1af620750", + "admin_state_up": true, + "weight": 1, + "subnet_id": "SUBNET_ID", + "status": "DOWN" + }, + { + "id": "975592ca-e308-48ad-8298-731935ee9f46", + "address": "192.0.2.14", + "protocol_port": 8080, + "tenant_id": "453105b9-1754-413f-aab1-55f1af620750", + "admin_state_up": true, + "weight": 1, + "subnet_id": "SUBNET_ID", + "status": "DOWN" + } + ] +} diff --git a/api-ref/src/wadls/netconn-api/src/common.ent b/api-ref/src/wadls/netconn-api/src/common.ent index 34bdf0e62..be990c22d 100644 --- a/api-ref/src/wadls/netconn-api/src/common.ent +++ b/api-ref/src/wadls/netconn-api/src/common.ent @@ -135,9 +135,7 @@ name="admin_state_up" style="plain" type="xsd:bool"> - The administrative state of the network. A valid value - is up (true) or down - (false). + The administrative state of the network, which is up (true) or down (false). @@ -201,71 +199,89 @@ provider segments. '> - - The port status. Value is ACTIVE or DOWN. - - - - The port name. - - - - Allowed address pairs. - - - - 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. - - - - Extra DHCP options. - - - - 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. - - - - 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 status. Value is ACTIVE or DOWN. + + + + The port name. + + + + Allowed address pairs. + + + + 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. + + + + Extra DHCP options. + + + + 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. + + + + 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 the network. + The ID of the network. '> The status of the load balancer. Indicates whether the load balancer is operational. + + + The administrative state of the load balancer, which is up (true) or down (false). + + ' > - The status of the pool. Indicates whether the pool is operational. - - - The algorithm that is used to distribute the load among pool members. - - The protocol of the pool, which is TCP, HTTP, or HTTPS. - - Human readable description for the pool. - - - - - List of health monitors that are associated with the pool. - - - - - The ID of the network to which pool members belong. + Description for the pool. Owner of the pool. Only an administrative user can specify a tenant ID other than its own. - @@ -1010,15 +1009,7 @@ - Human readable name for the pool. Does not have to be unique. - - - - - List of statuses for associated health monitors, if any. + Pool name. Does not have to be unique. + name="lb_algorithm" style="plain" type="xsd:list"> - Provider name of the load-balancer service. + The load-balancer algorithm, which is round-robin, least-connections, and so on. This value, which must be supported, is dependent on the load-balancer provider. Round robin must be supported. + + + + The ID of the health monitor. - + - Status description. + The session persistence algorithm. This algorithm is a dictionary with type and cookie_name keys. The unique ID for the pool. +' > + + + The status of the pool. Indicates whether the pool is operational. + + name="lb_algorithm" style="plain" type="xsd:string"> - The ID of the VIP with which the pool is associated. + The load-balancer algorithm, which is round-robin, least-connections, and so on. This value, which must be supported, is dependent on the load-balancer provider. Round robin must be supported. + + + + The protocol of the pool, which is TCP, HTTP, or HTTPS. + + + + + Description for the pool. + + + + + The ID of the health monitor. + + + + + Owner of the pool. Only an administrative user can specify a tenant ID other than its own. + + + + + The administrative state of the pool, which is up (true) or down (false). + + + + + Pool name. Does not have to be unique. + + + + + Session persistence algorithm that should be used (if any). This is a dictionary that has keys of "type" and "cookie_name".. + + + + + List of members that belong to the pool. + + + + + The unique ID for the pool. ' > Owner of the pool. Only an administrative user can specify a tenant ID other than its own. - - Human readable name for the pool. Does not have to be unique. - - - - - Human readable description for the pool. - - - - - The ID of the network to which pool members belong. + Pool name. Does not have to be unique. + name="lb_algorithm" style="plain" type="xsd:string"> - The algorithm that is used to distribute the load among pool members. - - - - - List of health monitors that are associated with the pool. - - - - - The administrative state of the pool, which is up (true) or down (false). - - - - - Provider name of the load-balancer service. - + The load-balancer algorithm, which is round-robin, least-connections, and so on. This value, which must be supported, is dependent on the load-balancer provider. Round robin must be supported. ' > - Human readable name for the pool. Does not have to be unique. + Pool name. Does not have to be unique. + + + + + The load-balancer algorithm, which is round-robin, least-connections, and so on. This value, which must be supported, is dependent on the load-balancer provider. Round robin must be supported. +' > + + + A listener object. + + + + + ID of default pool. Must have compatible protocol with listener. + + + + + The listener name. - Human readable description for the pool. + Detailed description of the listener. + name="tenant_id" style="plain" type="csapi:string"> - The algorithm that is used to distribute the load among pool members. + Tenant that owns this listener. + name="connection_limit" style="plain" type="xsd:int"> - List of health monitors that are associated with the pool. + Maximum connections this load balancer can have. Default is infinite. + + + + + Protocol to load balance: HTTP, HTTPS, TCP, UDP. + + + + + TCP (or UDP) port to listen on. - The administrative state of the pool, which is up (true) or down (false). + The administrative state of the load balancer, which is up (true) or down (false). + If you set this attribute to false, the listener is created in an administratively down state. + + + + + The ID of the load balancer. ' > - Number of allowed connection failures before changing the status of the member to INACTIVE. A valie value is from 1 to 10. + Number of allowed connection failures before changing the status of the member to INACTIVE. A valid value is from 1 to 10. - The HTTP method that the monitor uses for requests. - The HTTP path of the request sent by the monitor to test the health of a member. Must be a string beginning with a forward slash (/). - - The list of HTTP status codes expected in response from the member to declare it healthy. A valid value is a single value, such as 200, a list, such as 200, 202, or a range, such as 200-204. + Expected HTTP codes for a passing HTTP(S) monitor. - @@ -1362,7 +1453,7 @@ - The maximum number of seconds for a monitor to wait for a connection to be established before it times out. This value must be less than the delay value. + Time in seconds to timeout each probe. - Number of allowed connection failures before changing the status of the member to INACTIVE. A valid value is from 1 to 10. - - - - - The HTTP method that the monitor uses for requests. + Maximum consecutive health probe tries. - The HTTP path of the request sent by the monitor to test the health of a member. Must be a string beginning with a forward slash (/). + Path portion of URI that will be probed if type is HTTP(S). - The list of HTTP status codes expected in response from the member to declare it healthy. A valid value is a single value, such as 200, a list, such as 200, 202, or a range, such as 200-204. - - - - - The administrative state of the health monitor, which is up (true) or down (false). + Expected HTTP codes for a passing HTTP(S) monitor. ' > - - The maximum number of seconds for a monitor to wait for a connection to be established before it times out. This value must be less than the delay value. - - - - - Number of allowed connection failures, from 1 to 10, before the status of the member changes to INACTIVE - - - - - The HTTP method that the monitor uses for requests. - - - @@ -1445,25 +1497,72 @@ the health of a member. A valid value is a string that begins with a forward slash (/). - - +' > + + - The list of HTTP status codes expected in response from - the member to declare it healthy. A valid value is - single value, such as 200, a list, such as 200, 202, or a - range, such as 200-204. + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> + The unique ID for the member. + + + + + Owner of the member. Only an administrative user can specify a tenant ID other than its own. + + + + + Subnet in which to access this member. + + + + + The IP address of the member. + + + + + The port on which the application is hosted. + + A positive integer value that indicates the relative portion of traffic that this + member should receive from the pool. For example, a member with a weight of 10 receives five times + as much traffic as a member with a weight of 2. + + + - The administrative state of the health monitor, which is up (true) or down (false). + The administrative state of the member, which is up (true) or down (false). -' > - + + + + The status of the member. Indicates whether the member is operational. + +'> @@ -1482,11 +1581,11 @@ + name="subnet_id" style="plain" type="csapi:uuid"> - The ID of the pool to which the member belongs. + Subnet in which to access this member. The IP address of the member. - - - The protocol of the VIP address, which is TCP, HTTP, or HTTPS. - - - The weight of a member determines the portion of - requests or connections it services compared to the other - members of the pool. A value of 0 means the member does - not participate in load-balancing but still accepts - persistent connections. A valid value is from 0 to - 256. + Weight of member. Owner of the member. Only an administrative user can specify a tenant ID other than its own. - - - The ID of the pool to which the member belongs. - - The IP address of the member. - - - The protocol of the VIP address, which is TCP, HTTP, or HTTPS. - - The port on which the application is hosted. - - - The weight of a member determines the portion of - requests or connections it services compared to the other - members of the pool. A value of 0 means the member does - not participate in load-balancing but still accepts - persistent connections. A valid value is from 0 to - 256. - - - - - The administrative state of the member, which is up - (true) or down - (false). - - -' > - + name="subnet_id" style="plain" type="xsd:int"> - The ID of the pool to which the member belongs. + Subnet in which to access this member. - - - - The weight of a member determines the portion of - requests or connections it services compared to the other - members of the pool. A value of 0 means the member does - not participate in load-balancing but still accepts - persistent connections. A valid value is from 0 to - 256. - - -' > + diff --git a/api-ref/src/wadls/netconn-api/src/os-lbaas-ext.wadl b/api-ref/src/wadls/netconn-api/src/os-lbaas-ext.wadl index ed02715eb..e0be486e4 100644 --- a/api-ref/src/wadls/netconn-api/src/os-lbaas-ext.wadl +++ b/api-ref/src/wadls/netconn-api/src/os-lbaas-ext.wadl @@ -89,20 +89,19 @@ &fault400; &fault401; - Lists load balancers. + Lists all load balancers. - - &lbLoadbalancersParam; &lbLoadbalancerParam; &lbResponseParams; + &lbLoadbalancersParam; &lbLoadbalancerParam; &lbResponseParams; &fault401; &fault403; &fault404; - Shows the configuration details for a specified load + Shows the details of the configuration for a specified load balancer. @@ -114,7 +113,7 @@ Updates the editable attributes of a specified load - balancer + balancer. @@ -130,8 +129,8 @@ Deletes a load balancer. - Upon successful deletion, if the deleted load balancer used any listeners, they - are detached but not deleted. + Upon successful deletion, any listeners that this load balancer still uses are + detached but not deleted. @@ -160,7 +159,7 @@ &fault400; &fault401; - Lists listeners. + Lists all listeners. @@ -172,7 +171,8 @@ - Shows the configuration details for a specified listener. + Shows the details of the configuration for a specified + listener. @@ -200,9 +200,8 @@ Deletes an orphaned listener. - Returns an error if any load balancers still use the listener. - Upon successful deletion, if the deleted listener used any pools, they are - detached but not deleted. + Returns an error if any load balancers still use this listener. Any pool that this + listener still uses are detached but not deleted. &fault401; &fault404;&fault409conflict; @@ -220,11 +219,11 @@ - &poolResponseParams; + &poolcreateResponseParams; &fault400; &fault401; - Lists pools. + Lists all pools. @@ -235,7 +234,8 @@ - Shows the configuration details for a specified pool. + Shows the details of the configuration for a specified + pool. - &memberResponseParams; + &membercreateResponseParams; &fault400; &fault401; @@ -300,7 +300,7 @@ - Shows the configuration details for a specified member. + Shows the details of the configuration for a member. @@ -348,7 +348,7 @@ &fault400; &fault401; - Lists health monitors. + Lists all health monitors. @@ -359,7 +359,7 @@ - Shows the configuration details for a specified health + Shows the details of the configuration for a specified health monitor.