diff --git a/api-ref/src/docbkx/ch_netconn-v2-ext.xml b/api-ref/src/docbkx/ch_netconn-v2-ext.xml index d40ec8fe6..8ebb69808 100644 --- a/api-ref/src/docbkx/ch_netconn-v2-ext.xml +++ b/api-ref/src/docbkx/ch_netconn-v2-ext.xml @@ -181,6 +181,89 @@ +
+ Firewall-as-a-Service (FWaaS) 2.0 (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 is associated with 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 be different from the tenant who created + or the tenants that use the firewall policy. + + + + + firewall_rule. A collection of + attributes like ports and IP addresses that define match + criteria and action, such as allow or deny, that must be taken + on the matched data traffic. + + + + + + + + + + + + + + + +
Load-Balancer-as-a-Service (LBaaS) 1.0 (STABLE) diff --git a/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall-create-req.json b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall-create-req.json new file mode 100644 index 000000000..65589932b --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall-create-req.json @@ -0,0 +1,6 @@ +{ + "firewall": { + "admin_state_up": true, + "firewall_policy_id": "c69933c1-b472-44f9-8226-30dc4ffd454c" + } +} diff --git a/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall-create-res.json b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall-create-res.json new file mode 100644 index 000000000..9410b0737 --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall-create-res.json @@ -0,0 +1,11 @@ +{ + "firewall": { + "admin_state_up": true, + "description": "", + "firewall_policy_id": "c69933c1-b472-44f9-8226-30dc4ffd454c", + "id": "3b0ef8f4-82c7-44d4-a4fb-6177f9a21977", + "name": "", + "status": "PENDING_CREATE", + "tenant_id": "45977fa2dbd7482098dd68d0d8970117" + } +} diff --git a/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall-delete-req.json b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall-delete-req.json new file mode 100644 index 000000000..61862de99 --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall-delete-req.json @@ -0,0 +1,5 @@ +{ + "firewall": { + "id": "3b0ef8f4-82c7-44d4-a4fb-6177f9a21977" + } +} diff --git a/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall-show-res.json b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall-show-res.json new file mode 100644 index 000000000..dbaa1ae0e --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall-show-res.json @@ -0,0 +1,11 @@ +{ + "firewall": { + "admin_state_up": true, + "description": "", + "firewall_policy_id": "c69933c1-b472-44f9-8226-30dc4ffd454c", + "id": "3b0ef8f4-82c7-44d4-a4fb-6177f9a21977", + "name": "", + "status": "ACTIVE", + "tenant_id": "45977fa2dbd7482098dd68d0d8970117" + } +} diff --git a/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall-update-req.json b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall-update-req.json new file mode 100644 index 000000000..2458f52c7 --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall-update-req.json @@ -0,0 +1,5 @@ +{ + "firewall": { + "admin_state_up": "false" + } +} diff --git a/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall-update-res.json b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall-update-res.json new file mode 100644 index 000000000..17ea323b6 --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall-update-res.json @@ -0,0 +1,11 @@ +{ + "firewall": { + "admin_state_up": false, + "description": "", + "firewall_policy_id": "c69933c1-b472-44f9-8226-30dc4ffd454c", + "id": "3b0ef8f4-82c7-44d4-a4fb-6177f9a21977", + "name": "", + "status": "PENDING_UPDATE", + "tenant_id": "45977fa2dbd7482098dd68d0d8970117" + } +} diff --git a/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_policies-list-res.json b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_policies-list-res.json new file mode 100644 index 000000000..bcec01fe7 --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_policies-list-res.json @@ -0,0 +1,15 @@ +{ + "firewall_policies": [ + { + "audited": false, + "description": "", + "firewall_rules": [ + "8722e0e0-9cc9-4490-9660-8c9a5732fbb0" + ], + "id": "c69933c1-b472-44f9-8226-30dc4ffd454c", + "name": "test-policy", + "shared": false, + "tenant_id": "45977fa2dbd7482098dd68d0d8970117" + } + ] +} diff --git a/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_policy-create-req.json b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_policy-create-req.json new file mode 100644 index 000000000..7811e9549 --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_policy-create-req.json @@ -0,0 +1,8 @@ +{ + "firewall_policy": { + "firewall_rules": [ + "8722e0e0-9cc9-4490-9660-8c9a5732fbb0" + ], + "name": "test-policy" + } +} diff --git a/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_policy-create-res.json b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_policy-create-res.json new file mode 100644 index 000000000..6c68f5bc2 --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_policy-create-res.json @@ -0,0 +1,13 @@ +{ + "firewall_policy": { + "audited": false, + "description": "", + "firewall_rules": [ + "8722e0e0-9cc9-4490-9660-8c9a5732fbb0" + ], + "id": "c69933c1-b472-44f9-8226-30dc4ffd454c", + "name": "test-policy", + "shared": false, + "tenant_id": "45977fa2dbd7482098dd68d0d8970117" + } +} diff --git a/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_policy-insert-rule-req.json b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_policy-insert-rule-req.json new file mode 100644 index 000000000..94d9b8ec8 --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_policy-insert-rule-req.json @@ -0,0 +1,5 @@ +{ + "firewall_rule_id": "7bc34b8c-8d3b-4ada-a9c8-1f4c11c65692", + "insert_after": "a08ef905-0ff6-4784-8374-175fffe7dade", + "insert_before": "" +} diff --git a/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_policy-insert-rule-res.json b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_policy-insert-rule-res.json new file mode 100644 index 000000000..6a42dd6c3 --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_policy-insert-rule-res.json @@ -0,0 +1,14 @@ +{ + "audited": false, + "description": "", + "firewall_list": [], + "firewall_rules": [ + "a08ef905-0ff6-4784-8374-175fffe7dade", + "7bc34b8c-8d3b-4ada-a9c8-1f4c11c65692", + "8722e0e0-9cc9-4490-9660-8c9a5732fbb0" + ], + "id": "c69933c1-b472-44f9-8226-30dc4ffd454c", + "name": "test-policy", + "shared": false, + "tenant_id": "45977fa2dbd7482098dd68d0d8970117" +} diff --git a/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_policy-remove-rule-req.json b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_policy-remove-rule-req.json new file mode 100644 index 000000000..7576442bf --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_policy-remove-rule-req.json @@ -0,0 +1,3 @@ +{ + "firewall_rule_id": "7bc34b8c-8d3b-4ada-a9c8-1f4c11c65692" +} diff --git a/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_policy-remove-rule-res.json b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_policy-remove-rule-res.json new file mode 100644 index 000000000..c8d976ac8 --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_policy-remove-rule-res.json @@ -0,0 +1,13 @@ +{ + "audited": false, + "description": "", + "firewall_list": [], + "firewall_rules": [ + "a08ef905-0ff6-4784-8374-175fffe7dade", + "8722e0e0-9cc9-4490-9660-8c9a5732fbb0" + ], + "id": "c69933c1-b472-44f9-8226-30dc4ffd454c", + "name": "test-policy", + "shared": false, + "tenant_id": "45977fa2dbd7482098dd68d0d8970117" +} diff --git a/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_policy-show-res.json b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_policy-show-res.json new file mode 100644 index 000000000..6c68f5bc2 --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_policy-show-res.json @@ -0,0 +1,13 @@ +{ + "firewall_policy": { + "audited": false, + "description": "", + "firewall_rules": [ + "8722e0e0-9cc9-4490-9660-8c9a5732fbb0" + ], + "id": "c69933c1-b472-44f9-8226-30dc4ffd454c", + "name": "test-policy", + "shared": false, + "tenant_id": "45977fa2dbd7482098dd68d0d8970117" + } +} diff --git a/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_policy-update-req.json b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_policy-update-req.json new file mode 100644 index 000000000..7d0a7b53c --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_policy-update-req.json @@ -0,0 +1,8 @@ +{ + "firewall_policy": { + "firewall_rules": [ + "a08ef905-0ff6-4784-8374-175fffe7dade", + "8722e0e0-9cc9-4490-9660-8c9a5732fbb0" + ] + } +} diff --git a/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_policy-update-res.json b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_policy-update-res.json new file mode 100644 index 000000000..4f15965cf --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_policy-update-res.json @@ -0,0 +1,14 @@ +{ + "firewall_policy": { + "audited": false, + "description": "", + "firewall_rules": [ + "a08ef905-0ff6-4784-8374-175fffe7dade", + "8722e0e0-9cc9-4490-9660-8c9a5732fbb0" + ], + "id": "c69933c1-b472-44f9-8226-30dc4ffd454c", + "name": "test-policy", + "shared": false, + "tenant_id": "45977fa2dbd7482098dd68d0d8970117" + } +} diff --git a/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_rule-create-req.json b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_rule-create-req.json new file mode 100644 index 000000000..9a972d607 --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_rule-create-req.json @@ -0,0 +1,9 @@ +{ + "firewall_rule": { + "action": "allow", + "destination_port": "80", + "enabled": true, + "name": "ALLOW_HTTP", + "protocol": "tcp" + } +} diff --git a/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_rule-create-res.json b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_rule-create-res.json new file mode 100644 index 000000000..8121977fb --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_rule-create-res.json @@ -0,0 +1,19 @@ +{ + "firewall_rule": { + "action": "allow", + "description": "", + "destination_ip_address": null, + "destination_port": "80", + "enabled": true, + "firewall_policy_id": null, + "id": "8722e0e0-9cc9-4490-9660-8c9a5732fbb0", + "ip_version": 4, + "name": "ALLOW_HTTP", + "position": null, + "protocol": "tcp", + "shared": false, + "source_ip_address": null, + "source_port": null, + "tenant_id": "45977fa2dbd7482098dd68d0d8970117" + } +} diff --git a/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_rule-show-res.json b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_rule-show-res.json new file mode 100644 index 000000000..8121977fb --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_rule-show-res.json @@ -0,0 +1,19 @@ +{ + "firewall_rule": { + "action": "allow", + "description": "", + "destination_ip_address": null, + "destination_port": "80", + "enabled": true, + "firewall_policy_id": null, + "id": "8722e0e0-9cc9-4490-9660-8c9a5732fbb0", + "ip_version": 4, + "name": "ALLOW_HTTP", + "position": null, + "protocol": "tcp", + "shared": false, + "source_ip_address": null, + "source_port": null, + "tenant_id": "45977fa2dbd7482098dd68d0d8970117" + } +} diff --git a/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_rule-update-req.json b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_rule-update-req.json new file mode 100644 index 000000000..fbff43f86 --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_rule-update-req.json @@ -0,0 +1,5 @@ +{ + "firewall_rule": { + "shared": "true" + } +} diff --git a/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_rule-update-res.json b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_rule-update-res.json new file mode 100644 index 000000000..5bdeac938 --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_rule-update-res.json @@ -0,0 +1,19 @@ +{ + "firewall_rule": { + "action": "allow", + "description": "", + "destination_ip_address": null, + "destination_port": "80", + "enabled": true, + "firewall_policy_id": "c69933c1-b472-44f9-8226-30dc4ffd454c", + "id": "8722e0e0-9cc9-4490-9660-8c9a5732fbb0", + "ip_version": 4, + "name": "ALLOW_HTTP", + "position": 1, + "protocol": "tcp", + "shared": true, + "source_ip_address": null, + "source_port": null, + "tenant_id": "45977fa2dbd7482098dd68d0d8970117" + } +} diff --git a/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_rules-list-res.json b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_rules-list-res.json new file mode 100644 index 000000000..20065cbee --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewall_rules-list-res.json @@ -0,0 +1,21 @@ +{ + "firewall_rules": [ + { + "action": "allow", + "description": "", + "destination_ip_address": null, + "destination_port": "80", + "enabled": true, + "firewall_policy_id": "c69933c1-b472-44f9-8226-30dc4ffd454c", + "id": "8722e0e0-9cc9-4490-9660-8c9a5732fbb0", + "ip_version": 4, + "name": "ALLOW_HTTP", + "position": 1, + "protocol": "tcp", + "shared": false, + "source_ip_address": null, + "source_port": null, + "tenant_id": "45977fa2dbd7482098dd68d0d8970117" + } + ] +} diff --git a/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewalls-list-res.json b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewalls-list-res.json new file mode 100644 index 000000000..4c3268b54 --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/api_samples/firewall/firewalls-list-res.json @@ -0,0 +1,13 @@ +{ + "firewalls": [ + { + "admin_state_up": true, + "description": "", + "firewall_policy_id": "c69933c1-b472-44f9-8226-30dc4ffd454c", + "id": "3b0ef8f4-82c7-44d4-a4fb-6177f9a21977", + "name": "", + "status": "ACTIVE", + "tenant_id": "45977fa2dbd7482098dd68d0d8970117" + } + ] +} diff --git a/api-ref/src/wadls/netconn-api/src/common.ent b/api-ref/src/wadls/netconn-api/src/common.ent index 000e29ce2..b410ffe72 100644 --- a/api-ref/src/wadls/netconn-api/src/common.ent +++ b/api-ref/src/wadls/netconn-api/src/common.ent @@ -1,6 +1,6 @@ + A collection of common faults, these are pretty much expected + in every request. --> @@ -39,54 +39,54 @@ + element="csapi:serviceUnavailable"/> '> + element="csapi:Internal-server-error"/> '> + element="csapi:macGenerationFailure"/> '> - + element="csapi:badRequest"/> '> - + element="csapi:unauthorized"/> '> - - + + '> - - - '> + + +'> - - + + '> - - + + '> @@ -102,8 +102,7 @@ - -'> +'> @@ -115,7 +114,7 @@ '> @@ -123,65 +122,65 @@ '> - - - 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 UUID of the tenant who owns the network. Only administrative + users can specify a tenant UUID other than their own. You cannot + change this value through authorization policies. + + '> - - - A network object. - - + + + A network object. + + '> - - - A list of network objects. - - + + + A list of network objects. + + '> - - - The administrative state of the network, which is up - (true) or down (false). - - + + + The administrative state of the network, which is up + (true) or down (false). + + - - - The network ID. - - + + + The UUID of the network. + + - + The network name. @@ -189,8 +188,8 @@ - + Indicates whether this network is shared across all tenants. @@ -198,41 +197,53 @@ - - - The network status. - - + + + The network status. + + - - The associated subnets. + + + The associated subnets. + + - - The tenant ID. + + + The UUID of the tenant who owns the network. + + - - Indicates whether this network is externally accessible. + + + Indicates whether this network is externally accessible. + + - - The MTU of a network resource. + + + The MTU of a network resource. + + - - + + The port security status. A valid value is enabled (true) or disabled (false). @@ -241,628 +252,638 @@ '> +&networkCommonResponseParams;'> +&networkCommonResponseParams;'> - - - The administrative state of the network, which is up - (true) or down (false). - - + + + The administrative state of the network, which is up + (true) or down (false). + + - - - The network name. + + + + The network name. + + - - Admin-only. Indicates whether this network is shared - across all tenants. + + + Admin-only. Indicates whether this network is shared across all tenants. + + &tenantIdOwnerNetwork; - - Indicates whether this network is externally accessible. + + + Indicates whether this network is externally accessible. + + - - - The port security status. A valid value is enabled - (true) or disabled (false). - - + name="port_security_enabled" style="plain" type="xsd:bool"> + + + The port security status. A valid value is enabled (true) + or disabled (false). + + '> +&networkCommonResponseParams;'> - - The administrative state of the network, which is up - (true) or down (false). - + + + The administrative state of the network, which is up + (true) or down (false). + + - - The network name. + + The network name. + + - - Admin-only. Indicates whether this network is shared - across all tenants. + + + Admin-only. Indicates whether this network is shared across all tenants. + + - - Indicates whether this network is externally accessible. + + + Indicates whether this network is externally accessible. + + - - - The port security status. A valid value is enabled - (true) or disabled (false). - - + name="port_security_enabled" style="plain" type="xsd:bool"> + + + The port security status. A valid value is enabled + (true) or disabled (false). + + '> +&networkCommonResponseParams;'> +&networkCommonResponseParams;'> - - - 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 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. For - example, flat, vlan, vxlan, - or gre. - - + + + The type of physical network that maps to this network resource. For + example, flat, vlan, vxlan, or + gre. + + - - - An isolated segment on the physical network. The - network_type attribute defines the segmentation model. - For example, if the network_type value is vlan, this ID - is a vlan identifier. If the network_type value is gre, - this ID is a gre key. - - + + + An isolated segment on the physical network. The + network_type attribute defines the segmentation model. For + example, if the network_type value is vlan, this ID is a + vlan identifier. If the network_type value is gre, this ID + is a gre key. + + '> - - A segments object that defines one or more - provider segments. + + + A segments object that defines one or more provider + segments. + + '> - - - The state of the network, which is VLAN transparent - (true) or not VLAN transparent (false). - - + + + The state of the network, which is VLAN transparent + (true) or not VLAN transparent (false). + + '> - - - A port object. - - - '> + + + + A port object. + + +'> - - - A list of port objects. - - - '> + + + + A list of port objects. + + +'> - - - A symbolic name for the port. - - - - - - - The administrative status of the port, which is up - (true) or down (false). - - - + + + + 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 specified 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 specified address 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. - - - - - - - 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 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) response code + is returned. + + + + + + + If you specify only a subnet UUID, OpenStack Networking + allocates an available IP from that subnet to the port. If you + specify both a subnet UUID and an IP address, OpenStack + Networking tries to allocate the specified address to the port. + + + + + + + If you specify only a subnet UUID, OpenStack Networking + allocates an available IP from that subnet to the port. If you + specify both a subnet UUID and an IP address, OpenStack + Networking tries to allocate the specified address to the port. + + + + + + + If you specify both a subnet UUID and an IP address, OpenStack + Networking tries to allocate the specified address to the port. + + + + + + + One or more security group UUIDs. + + + + + + + The UUID 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 UUID of the entity that uses this port. For example, a DHCP agent. + + + + + + + The UUID 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. - - - - - - - The IP addresses for the port. Includes the IP address and - subnet ID. - - - - - - - The ID of the subnet to which the port is attached. - - - - - - - The 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. + + + + + + + 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 UUID of the attached network. + + + + + + + The UUID of the tenant who owns the network. Only administrative users + can specify a tenant UUID 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 UUID of the entity that uses this port. For example, a DHCP agent. + + + + + + + The MAC address of the port. + + + + + + + The IP addresses for the port. Includes the IP address and UUID of the + subnet. + + + + + + + The UUID of the subnet to which the port is attached. + + + + + + + The IP address. + + + + + + + The UUID of the port. + + + + + + + The UUIDs of any attached security groups. + + + + + + + The UUID of the device that uses this port. For example, a + virtual server. + + + + + + + The port security status. The status is enabled (true) or + disabled (false). + + +'> + &portCommonResponseParams;'> - - - 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 port status. Value is ACTIVE or DOWN. + + + + + + + The port name. + + + + + + + The administrative state of the router, which is up (true) + or down (false). + + + + + + + The UUID of the attached network. + + + + + + + The UUID of the tenant who owns the network. Only administrative users + can specify a tenant UUID other than their own. You cannot change this + value through authorization policies. + + + + + + + The UUID of the entity that uses this port. For example, a DHCP + agent. + + + + + + + The MAC address of the port. + + + + + + + The UUID of the port. + + + + + + + The UUIDs of any attached security groups. + + + + + + + The UUID of the device that uses this port. For example, a + virtual server. + + +'> @@ -879,1887 +900,2380 @@ &portObject; &portCommonResponseParams;'> - - - 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 - specified 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 UUID 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 specified 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 - specified 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 UUID 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 specified 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. + + +'> - - - A subnet object. - - + + + A subnet object. + + '> - - - A list of subnet objects. - - + + + A list of subnet objects. + + '> - - - 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. - - - - - - The 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" - } -] - - - - - The 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. - - - '> - - - The 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. If false, DHCP - is disabled. - - - - - - - Choose from constants.IPV6_SLAAC, - constants.DHCPV6_STATEFUL, constants.DHCPV6_STATELESS, - name='ipv6_address_modes, or null. - - - - - - - Choose from constants.IPV6_SLAAC, - constants.DHCPV6_STATEFUL, - constants.DHCPV6_STATELESS, - name='ipv6_address_modes, or 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. Use a space to separate multiple entries. For example, - [8.8.8.7 8.8.8.8]. - - + + + + The subnet name. + + + + + + + The UUID 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. + + + + + + + The UUID of the subnet. + + + + + + + Set to true if DHCP is enabled and + false if DHCP is disabled. + + + + + + + The 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" -} -] - - - - - The 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. - - - - - - The 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":"0.0.0.0/0", + "nexthop":"123.456.78.9" }, { - "destination":"192.168.0.0/24", - "nexthop":"192.168.0.1" + "destination":"192.168.0.0/24", + "nexthop":"192.168.0.1" } -] - - - - The destination for static route - - - - The next hop for the destination - '> +] + + + + + + The 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. + + +'> + + + + The name of the network. + + + + + + + The UUID of the attached network. + + + + &tenantIdOwnerNetwork; + + + + The gateway IP address. + + + + + + + The IP version, which is 4 or 6. + + + + + + + The CIDR. + + + + + + + The UUID of the subnet. + + + + + + + If true, DHCP is enabled. If false, DHCP is + disabled. + + + + + + + Choose from constants.IPV6_SLAAC, + constants.DHCPV6_STATEFUL, constants.DHCPV6_STATELESS, + name='ipv6_address_modes, or null. + + + + + + + Choose from constants.IPV6_SLAAC, + constants.DHCPV6_STATEFUL, + constants.DHCPV6_STATELESS, + name='ipv6_address_modes, or null. + + +'> + + + + + The subnet name. + + + + + + + The UUID 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" + } +] + + + + + + The 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. + + + + + + + The 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" + } +] + + + + + + The 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. - + + + + Filters the response by a an image name, in URL format. + + + + + + + Filters the response by a flavor name, in URL format. + + + + + + + Filters the response by a server name. + + + + + + + The 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. - '> + + + + Filters the response by a server status. + + + + + + + The host name. + + +'> - - 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; '> + + + + Filters the response by a minimum disk space value, in GB. + + + + + + + Filters the response by a minimum RAM value, in MB. + + + + + + + The UUID of the flavor at which you want to set a marker. + + + +&limitMarkerReqParameter; '> - - A router object. - + name="router" style="plain" type="xsd:string"> + + + A router object. + + '> - - The router name. - + + + The router name. + + '> - - The router name. - + + + The router name. + + '> - - - The administrative state of the router, which is up - (true) or down (false). - - + + + The administrative state of the router, which is up + (true) or down (false). + + '> - - - The administrative state of the router, which is up - (true) or down (false). - - + + + The administrative state of the router, which is up + (true) or down (false). + + '> - - The router status. - + + + The router status. + + '> - - - The external gateway parameters, which include the - network_id and external_fixed_ips - parameters. - - + + + The external gateway parameters, which include the + network_id and external_fixed_ips + parameters. + + - - The IP address parameters. - + + + The IP address parameters. + + '> - - - The external gateway parameters, which include the - network_id, enable_snat - and external_fixed_ips - parameters. - - + + + The external gateway parameters, which include the + network_id, enable_snat and + external_fixed_ips parameters. + + - - - Enable Source NAT (SNAT) attribute. Default is True. - To persist this attribute value, - set the enable_snat_by_default option - in the neutron.conf file. - - + + + Enable Source NAT (SNAT) attribute. Default is True. To + persist this attribute value, set the + enable_snat_by_default option in the + neutron.conf file. + + - - The IP address parameters. - + + + The IP address parameters. + + '> - - If true, indicates a distributed router. - + + + If true, indicates a distributed router. + + '> - - If true, indicates a highly-available -router. - + + + If true, indicates a highly-available router. + + '> - - The extra routes configuration for L3 router. - + + + The extra routes configuration for L3 router. + + '> - - The tenant ID. - + + + The UUID of the tenant. + + '> - - The router ID. - + + + The UUID of the router. + + '> - - A list of router objects. - + + + A list of router objects. + + '> - - A port object. - + + + A port object. + + '> - - The network ID. - + + + The UUID of the network. + + '> - - The device ID. - + + + The UUID of the device. + + '> - - The IP address. - + + + The IP address. + + '> - - The subnet ID. - + + + The UUID of the subnet. + + '> - - The device owner. - + + + The device owner. + + '> - - A fixed_ips object. - + + + A fixed_ips object. + + '> - - The MAC address. - + + + The MAC address. + + '> - - The port ID. - + + + The UUID of the port. + + '> - - The floating IP address. - + + + The floating IP address. + + '> - - A list of floatingip objects. - + + + A list of floatingip objects. + + '> - - - A floatingip object. When you associate a floating IP - address with a VM, the instance has the same public IP address each - time that it boots, basically to maintain a consistent IP address - for maintaining DNS assignment. - - + + + A floatingip object. When you associate a floating IP + address with a VM, the instance has the same public IP address each + time that it boots, basically to maintain a consistent IP address + for maintaining DNS assignment. + + '> - - The ID of the network associated with the floating - IP. - + + + The UUID of the network associated with the floating IP. + + '> - - The fixed IP address associated with the floating - IP. If you intend to associate the floating IP with a - fixed IP at creation time, then you must indicate the - identifier of the internal port. If an internal port - has multiple associated IP addresses, the service chooses the first IP - unless you explicitly specify the parameter fixed_ip_address to select - a specific IP. - + + + The fixed IP address that is associated with the floating IP. To + associate the floating IP with a fixed IP at creation time, you must + specify the identifier of the internal port. If an internal port has + multiple associated IP addresses, the service chooses the first IP + address unless you explicitly define a fixed IP address in the + fixed_ip_address parameter. + + '> - - The ID of the floating IP address. - + + + The UUID of the floating IP address. + + '> - - The floating IP status. - + + + The floating IP status. + + '> - - The floating IP address. - + + + The floating IP address. + + '> - - The fixed IP address associated with the floating IP. - + + + The fixed IP address that is associated with the floating IP address. + + '> - - The router ID. - + + + The UUID of the router. + + '> - - A loadbalancers object. - + name="loadbalancers" style="plain" type="xsd:string"> + + + A loadbalancers object. + + '> - - A loadbalancer object. - + name="loadbalancer" style="plain" type="xsd:string"> + + + A loadbalancer object. + + '> - - - The tenant ID. Only administrative users can specify a - tenant ID other than their own. - - + + + The UUID of the tenant. Only administrative users can specify a + tenant UUID other than their own. + + &floating-network-idParameter; &fixed-ip-addressParameter; &floating-ip-addressParameter; - - - The port ID. - - - - - - - The ID of the subnet on which you want to create the floating IP. - - + + + The UUID of the port. + + '> - - A vip object. - + + + A vip object. + + '> - - A list of vip objects. - + + + A list of vip objects. + + '> - - The unique ID for the load balancer. - + name="id" style="plain" type="csapi:uuid"> + + + The UUID for the load balancer. + + - - Load balancer name. - + name="name" style="plain" type="xsd:string"> + + + The load balancer name. + + - - Load balancer description. - + name="description" style="plain" type="xsd:string"> + + + The load balancer description. + + - - The IP address of the VIP. - + name="vip_address" style="plain" type="xsd:ip"> + + + The IP address of the VIP. + + - - The ID of the subnet on which to allocate the VIP address. - + name="vip_subnet_id" style="plain" type="csapi:uuid"> + + + The UUID of the subnet on which to allocate the virtual IP (VIP) address. + + - - - The status of the load balancer. Indicates whether the load balancer - is operational. - - + name="status" style="plain" type="xsd:string"> + + + 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). - - + name="admin_state_up" style="plain" type="xsd:boolean"> + + + The administrative state of the load balancer, which is up + (true) or down (false). + + - - - The ID of the tenant who owns the VIP. Only administrative users can - specify a tenant ID other than their own. - - + name="tenant_id" style="plain" type="csapi:uuid"> + + + The UUID of the tenant who owns the VIP. Only administrative users can + specify a tenant UUID other than their own. + + '> - - Load balancer name. Does not have to be unique. - + + + The load balancer name. Does not have to be unique. + + - - Load balancer description. - + + + The load balancer description. + + - - The ID of the subnet on which to allocate the VIP address. - + + + The UUID of the subnet on which to allocate the virtual IP (VIP) address. + + - - - The ID of the tenant who owns the load balancer. Only administrative - users can specify a tenant ID other than their own. - - + + + The UUID of the tenant who owns the load balancer. Only administrative + users can specify a tenant UUID other than their own. + + - - The IP address of the VIP. - + + + The IP address of the VIP. + + - - The name of the provider. - + + + The name of the provider. + + '> - - Load balancer name. Does not have to be unique. - + + + The load balancer name. Does not have to be unique. + + - - Load balancer description. - + + + The load balancer description. + + '> - - A pool object. - + + + A pool object. + + '> - - A list of pool objects. - + + + A list of pool objects. + + '> - - The status of the pool. Indicates whether the pool is operational. - + + + The status of the pool. Indicates whether the pool is operational. + + - - The protocol of the pool, which is TCP, HTTP, or HTTPS. - + + + The protocol of the pool, which is TCP, HTTP, + or HTTPS. + + - - The description for the pool. - + + + The description for the pool. + + - - - The ID of the tenant who owns the pool. Only administrative users can - specify a tenant ID other than their own. - - + + + The UUID of the tenant who owns the pool. Only administrative users can + specify a tenant UUID other than their own. + + - - - The administrative state of the pool, which is up - (true) or down (false). - - + + + The administrative state of the pool, which is up + (true) or down (false). + + - - Pool name. Does not have to be unique. - + + + The pool name. Does not have to be unique. + + - - List of members that belong to the pool. - + + + The list of members that belong to the pool. + + - - - The load-balancer algorithm, which is - ROUND_ROBIN, LEAST_CONNECTIONS, - or SOURCE_IP. - - + + + The load-balancer algorithm, which is round-robin + (ROUND_ROBIN), least-connections + (LEAST_CONNECTIONS), source IP (SOURCE_IP), + and so on, that is used to distribute traffic to the pool members. + This value, which must be supported, is dependent on the load-balancer + provider. The round-robin algorithm must be supported. + + - - The ID of the health monitor. - + + + The UUID of the health monitor. + + - - - The session persistence algorithm. This algorithm is a dictionary - with type and cookie_name - keys. - - + + + The session persistence algorithm. This algorithm is a dictionary + with type and cookie_name + keys. + + - - The unique ID for the pool. - + + + The UUID for the pool. + + - - - The ID of the subnet. - - + + + The UUID of the subnet. + + - - - The ID of the virtual IP (VIP) address. - - + + + The UUID of the virtual IP (VIP) address. + + - - - The statuses of the health monitors that are associated with the - pool. - - + + + The statuses of the health monitors that are associated with the + pool. + + '> - - The status of the pool. Indicates whether the pool is operational. - + + + The status of the pool. Indicates whether the pool is operational. + + - - - The load-balancer algorithm, which is round-robin, least-connections, - and so on, that is used to distribute traffic to the pool members. - This value, which must be supported, is dependent on the load-balancer - provider. The round-robin algorithm must be supported. - - + + + The load-balancer algorithm, which is round-robin + (ROUND_ROBIN), least-connections + (LEAST_CONNECTIONS), source IP (SOURCE_IP), + and so on, that is used to distribute traffic to the pool members. + This value, which must be supported, is dependent on the load-balancer + provider. The round-robin algorithm must be supported. + + - - The protocol of the pool, which is TCP, HTTP, or HTTPS. - + + + The protocol of the pool, which is TCP, + HTTP, or HTTPS. + + - - The description for the pool. - + + + The description for the pool. + + - - - List of health monitors that are associated with the pool. - - + + + List of health monitors that are associated with the pool. + + - - - The ID of the subnet. - - + + + The UUID of the subnet. + + - - - The ID of the tenant who owns the pool. Only administrative users - can specify a tenant ID other than their own. - - + + + The UUID of the tenant who owns the pool. Only administrative users + can specify a tenant UUID other than their own. + + - - - The administrative state of the pool, which is up - (true) or down (false). - - + + + The administrative state of the pool, which is up + (true) or down (false). + + - - Pool name. Does not have to be unique. - + + + The pool name. Does not have to be unique. + + - - List of members that belong to the pool. - + + + The list of members that belong to the pool. + + - - The unique ID for the pool. - + + + The UUID for the pool. + + - - - The ID of the virtual IP (VIP) address. - - + + + The UUID of the virtual IP (VIP) address. + + - - - The statuses of the health monitors that are associated with the - pool. - - + + + The statuses of the health monitors that are associated with the + pool. + + - - The load-balancer provider. - + + + The load-balancer provider. + + '> - - The status of the pool. Indicates whether the pool is operational. - + name="admin_state_up" style="plain" type="xsd:boolean"> + + + The administrative state of the pool, which is up + (true) or down (false). + + + + + + + The description for the pool. + + + + + + + The UUID for the associated health monitor. + + + + + + + The UUID for the pool. + + - - - The load-balancer algorithm, which is - ROUND_ROBIN, LEAST_CONNECTIONS, - or SOURCE_IP. - - + + + The load-balancer algorithm, which is round-robin + (ROUND_ROBIN), least-connections + (LEAST_CONNECTIONS), source IP (SOURCE_IP), + and so on, that is used to distribute traffic to the pool members. + This value, which must be supported, is dependent on the load-balancer + provider. The round-robin algorithm must be supported. + + - - The protocol of the pool, which is TCP, HTTP, or HTTPS. - - - - - The description for the pool. - - - - - - List of health monitors that are associated with the pool. - - - - - - - The ID of the subnet. - - - - - - - The ID of the tenant who owns the pool. Only administrative users - can specify a tenant ID other than their own. - - - - - - - The administrative state of the pool, which is up - (true) or down (false). - - - - - - Pool name. Does not have to be unique. - + name="listeners" style="plain" type="xsd:list"> + + + The list of listeners that belong to the pool. + + - - List of members that belong to the pool. - + + + The list of members that belong to the pool. + + + + + + + The pool name. Does not have to be unique. + + - - The unique ID for the pool. - + name="protocol" style="plain" type="xsd:string"> + + + The protocol of the pool, which is TCP, HTTP, + or HTTPS. + + - - - The ID of the virtual IP (VIP) address. - - - - - - - The statuses of the health monitors that are associated with the - pool. - - - - - - The load-balancer provider. - + name="tenant_id" style="plain" type="csapi:uuid"> + + + The UUID of the tenant who owns the pool. Only administrative users + can specify a tenant UUID other than their own. + + '> - - - The ID of the tenant who owns the pool. Only administrative users - can specify a tenant ID other than their own. - - + + + The UUID of the tenant who owns the pool. Only administrative users + can specify a tenant UUID other than their own. + + - - Pool name. Does not have to be unique. - + + + The pool name. Does not have to be unique. + + - - Human-readable description for the pool. - + + + Human-readable description for the pool. + + - - The protocol of the pool, which is TCP, HTTP, or HTTPS. - + + + The protocol of the pool, which is TCP, + HTTP, or HTTPS. + + - - - The ID of the subnet on which to allocate the VIP address. - - + name="subnet_id" style="plain" type="csapi:uuid"> + + + The UUID of the subnet on which to allocate the virtual IP (VIP) address. + + - - - The load-balancer algorithm, which is round-robin, least-connections, - and so on, that is used to distribute traffic to the pool members. - This value, which must be supported, is dependent on the load-balancer - provider. The round-robin algorithm must be supported. - - + + + The load-balancer algorithm, which is round-robin + (ROUND_ROBIN), least-connections + (LEAST_CONNECTIONS), source IP (SOURCE_IP), + and so on, that is used to distribute traffic to the pool members. + This value, which must be supported, is dependent on the load-balancer + provider. The round-robin algorithm must be supported. + + - - - The administrative state of the pool. A valid value is up - (true) or down (false). - - + + + The administrative state of the pool. A valid value is up + (true) or down (false). + + '> - - - The ID of the tenant who owns the pool. Only administrative users - can specify a tenant ID other than their own. - - + + + The UUID of the tenant who owns the pool. Only administrative users can + specify a tenant UUID other than their own. + + - - Pool name. Does not have to be unique. - + + + The pool name. Does not have to be unique. + + - - Human-readable description for the pool. - + + + Human-readable description for the pool. + + - - The protocol of the pool, which is TCP, HTTP, or HTTPS. - + + + The protocol of the pool, which is TCP, HTTP, + or HTTPS. + + - - - The ID of the subnet on which to allocate the VIP address. - - + name="subnet_id" style="plain" type="csapi:uuid"> + + + The UUID of the subnet on which to allocate the virtual IP (VIP) address. + + - - - The load-balancer algorithm, which is - ROUND_ROBIN, LEAST_CONNECTIONS, - or SOURCE_IP. - - + + + The load-balancer algorithm, which is round-robin + (ROUND_ROBIN), least-connections + (LEAST_CONNECTIONS), source IP (SOURCE_IP), + and so on, that is used to distribute traffic to the pool members. + This value, which must be supported, is dependent on the load-balancer + provider. The round-robin algorithm must be supported. + + - - - The administrative state of the pool. A valid value is up - (true) or down (false). - - + + + The administrative state of the pool. A valid value is up + (true) or down (false). + + - - The ID of the listener. - + + + The UUID of the listener. + + '> - - A listener object. - + + + + A listener object. + + - - - The ID of default pool. Must have compatible protocol with listener. - - + + + The UUID of default pool. Must have compatible protocol with listener. + + - - The listener name. - + + + The listener name. + + - - - Detailed description of the listener. - - + + + Detailed description of the listener. + + - - - The ID of the tenant who owns the listener. Only administrative - users can specify a tenant ID other than their own. - - + + + The UUID of the tenant who owns the listener. Only administrative + users can specify a tenant UUID other than their own. + + - - - The maximum number of connections permitted for this load balancer. - Default is infinite. - - + + + The maximum number of connections permitted for this load balancer. + Default is infinite. + + - - - The protocol to load balance. A valid value is HTTP, - HTTPS, TCP, or - TERMINATED_HTTPS. - - + + + The protocol to load balance. A valid value is HTTP, + HTTPS, TCP, or TERMINATED_HTTPS. + + - - The TCP or UDP port on which to listen. - + + + The TCP or UDP port on which to listen. + + - - - The administrative state of the load balancer, which is up - (true) or down (false). - - - Set this attribute to false to create the listener in - an administratively down state. - - + + + The administrative state of the load balancer, which is up + (true) or down (false). + + + Set this attribute to false to create the listener in + an administratively down state. + + - - The ID of the load balancer. - + + + The UUID of the load balancer. + + - - A reference to a container of TLS secrets. - + + + A reference to a container of TLS secrets. + + - - A list of references to TLS secrets. - + + + A list of references to TLS secrets. + + '> - - A metering_label object. - + + + A metering_label object. + + '> - - A list of metering_label objects. - + + + A list of metering_label objects. + + '> - - The name of the metering label. - + + + The name of the metering label. + + - - The description for the metering label. - + + + The description for the metering label. + + - - - Indicates whether this metering label is shared across all tenants. - - + + + Indicates whether this metering label is shared across all tenants. + + '> - - - The tenant ID for the specified metering label. - - + + + The tenant UUID for the specified metering label. + + - - - Description for the metering label. - - + + + Description for the metering label. + + - - - The name of the metering label. - - + + + The name of the metering label. + + - - - The metering label ID. - - + + + The UUID of the metering label. + + - - - Indicates whether this metering label is shared across all tenants. - - + + + Indicates whether this metering label is shared across all tenants. + + +'> + + + + A metering_label_rule object. + + + + + + + Ingress or egress, which is the direction in which the metering rule is + applied. + + + + + + + The metering label UUID to associate with this metering rule. + + + + + + + Indicates whether to count the traffic of a specific + IP address with the remote_ip_prefix + value. Default is False. + + + + + + + The remote IP prefix to be associated with + this metering rule packet. + + +'> + + + + A metering_label_rule object. + + + + + + + The remote IP prefix to be associated with + this metering rule packet. + + + + + + + Ingress or egress, which is the direction in + which the metering rule is applied. + + + + + + + The metering label UUID to associate with this metering rule. + + + + + + + The UUID for the specified metering label rule. + + + + + + + Indicates whether to count the traffic of a + specific IP address with the remote_ip_prefix + value. Default is False. + + '> '> - - - - A metering_label_rule object. - - - - - - - Ingress or egress, which is the direction - in which the metering rule is applied. - - - - - - - The metering label ID to associate - with this metering rule. - - - - - - - Indicates whether to count the traffic of a specific - IP address with the remote_ip_prefix - value. Default is False. - - - - - - - The remote IP prefix to be associated with - this metering rule packet. - - -'> - - - - A metering_label_rule object. - - - - - - The remote IP prefix to be associated with - this metering rule packet. - - - - - - Ingress or egress, which is the direction in - which the metering rule is applied. - - - - - - - The metering label ID to associate with this metering rule. - - - - - - - The ID for the specified metering label rule. - - - - - - Indicates whether to count the traffic of a - specific IP address with the remote_ip_prefix - value. Default is False. - - -'> - - - A health_monitor object. - - + name="health_monitor" style="plain" type="xsd:dict"> + + + A health_monitor object. + + '> - - - A health_monitors object. - - + + + A health_monitors object. + + '> - - The unique ID for the health monitor. - + + + The UUID for the health monitor. + + - - - The ID of the tenant who owns the health monitor. Only - administrative users can specify a tenant ID other than their own. - - + + + The UUID of the tenant who owns the health monitor. Only administrative + users can specify a tenant UUID other than their own. + + - - - The type of probe sent by the load balancer to verify the member - state, which is PING, TCP, HTTP, or HTTPS. - - + + + The type of probe sent by the load balancer to verify the member state, + which is PING, TCP, HTTP, or + HTTPS. + + - - The time, in seconds, between sending probes to members. - + + + The amount of time, in seconds, between sending probes to members. + + - - - 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. - - + + + 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. + + &max_retriesRequestParameter; - - The HTTP method that the monitor uses for requests. - + + + 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 HTTP path of the request sent by the monitor to test the health + of a member. A string value that must begin with the forward slash (/). + + - - Expected HTTP codes for a passing HTTP(S) monitor. - + + + Expected HTTP codes for a passing HTTP(S) monitor. + + - - - The administrative state of the health monitor, which is up - (true) or down (false). - - + + + The administrative state of the health monitor, which is up + (true) or down (false). + + - - - The status of the health monitor. Indicates whether the health - monitor is operational. - - + + + The status of the health monitor. Indicates whether the health + monitor is operational. + + '> - - The time, in seconds, between sending probes to members. - + + + The amount of time, in seconds, between sending probes to members. + + - - - 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. - + + + + 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. + + &max_retriesRequestParameter; - - The HTTP method that the monitor uses for requests. - + + + 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. A valid value is a string that - begins with a forward slash (/). - + + + The HTTP path of the request sent by the monitor to test the health of a + member. Must be a string that begins with a forward slash (/). + + - + + + The list of HTTP status codes expected in response from the member to + declare it healthy. Specify one of the following values: + + + - 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. + A single value, such as 200. - + + + + A list, such as 200, 202. + + + + + A range, such as 200-204. + + + + - - - The administrative state of the health monitor. A valid value is up - (true) or down (false). - - + + + The administrative state of the health monitor. A valid value is up + (true) or down (false). + + '> - - The unique ID for the member. - + + + The UUID for the member. + + - - - The ID of the tenant who owns the member. Only administrative users - can specify a tenant ID other than their own. - - + + + The UUID of the tenant who owns the member. Only administrative users + can specify a tenant UUID other than their own. + + - - Subnet in which to access this member. - + + + Subnet in which to access this member. + + - - The IP address of the member. - + + + The IP address of the member. + + - - The port where the application is hosted. - + + + The port where 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. - - + + + 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 member, 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. - - + + + The status of the member. Indicates whether the member is operational. + + '> - - - The ID of the tenant who owns the member. Only administrative users can - specify a tenant ID other than their own. - - + + + The UUID of the tenant who owns the member. Only administrative users can + specify a tenant UUID other than their own. + + - - The IP address of the member. - + + + The IP address of the member. + + - - The port where the application is hosted. - + + + The port where the application is hosted. + + - - - If you omit this parameter, LBaaS uses the - vip_subnet_id parameter value for the subnet ID. - - + + + If you omit this parameter, LBaaS uses the + vip_subnet_id parameter value for the subnet UUID. + + '> - - The unique ID for the VIP. - + + + The UUID for the VIP. + + - - - The ID of the tenant who owns the VIP. Only administrative users can - specify a tenant ID other than their own. - - + + + The UUID of the tenant who owns the VIP. Only administrative users can + specify a tenant UUID other than their own. + + - - Human-readable name for the VIP. Does not have to be unique. - + + + Human-readable name for the VIP. Does not have to be unique. + + - - Human-readable description for the VIP. - + + + Human-readable description for the VIP. + + - - The ID of the subnet on which to allocate the VIP address. - + + + The UUID of the subnet on which to allocate the virtual IP (VIP) address. + + - - The ID of the VIP port. - + + + The UUID of the VIP port. + + - - The IP address of the VIP. - + + + The IP address of the VIP. + + - - The protocol of the VIP address. A valid value is TCP, HTTP, or HTTPS. - + + + The protocol of the virtual IP (VIP) address. A valid value is + TCP, HTTP, or HTTPS. + + - - - The port on which to listen to client traffic that is associated - with the VIP address. A valid value is from 0 to 65535. - - + + + The port on which to listen to client traffic that is associated + with the virtual IP (VIP) address. A valid value is from 0 to 65535. + + - - The ID of the pool with which the VIP is associated. - + + + The UUID of the pool with which the VIP is associated. + + - - - Session persistence parameters for the VIP. Omit the - session_persistence parameter to prevent session - persistence. When no session persistence is used, the - session_persistence parameter does not appear in the - API response. To clear session persistence for the VIP, set the - session_persistence parameter to null in a - VIP update request. - - + + + Session persistence parameters for the VIP. Omit the + session_persistence parameter to prevent session + persistence. When no session persistence is used, the + session_persistence parameter does not appear in the + API response. To clear session persistence for the VIP, set the + session_persistence parameter to null in a + VIP update request. + + - - The maximum number of connections allowed for the VIP. - Default is -1, meaning no limit. - + + + The maximum number of connections allowed for the VIP. + Default is -1, meaning no limit. + + - - - The administrative state of the VIP. A valid value is up - (true) or down (false). - - + + + The administrative state of the VIP. A valid value is up + (true) or down (false). + + - - The status of the VIP. Indicates whether the VIP is operational. - + + + The status of the VIP. Indicates whether the VIP is operational. + + '> - - - The ID of the tenant who owns the VIP. Only administrative users can - specify a tenant ID other than their own. - - + + + The UUID of the tenant who owns the VIP. Only administrative users can + specify a tenant UUID other than their own. + + - - Human-readable name for the VIP. Does not have to be unique. - + + + Human-readable name for the VIP. Does not have to be unique. + + - - Human-readable description for the VIP. - + + + Human-readable description for the VIP. + + - - The ID of the subnet on which to allocate the VIP address. - + + + The UUID of the subnet on which to allocate the virtual IP (VIP) address. + + - - The IP address of the VIP. - + + + The IP address of the VIP. + + - - The protocol of the VIP address. A valid value is TCP, HTTP, or HTTPS. - + + + The protocol of the virtual IP (VIP) address. A valid value is + TCP, HTTP, or HTTPS. + + - - The port on which to listen to client traffic that is associated - with the VIP address. A valid value is from 0 to 65535. - + + + The port on which to listen to client traffic that is associated + with the virtual IP (VIP) address. A valid value is from 0 to 65535. + + - - The ID of the pool with which the VIP is associated. - + + + The UUID of the pool with which the VIP is associated. + + - - - Session persistence parameters for the VIP. Omit the - session_persistence parameter to prevent session - persistence. When no session persistence is used, the - session_persistence parameter does not appear in the - API response. To clear session persistence for the VIP, set the - session_persistence parameter to null in a - VIP update request. - - + + + Session persistence parameters for the VIP. Omit the + session_persistence parameter to prevent session + persistence. When no session persistence is used, the + session_persistence parameter does not appear in the + API response. To clear session persistence for the VIP, set the + session_persistence parameter to null in a + VIP update request. + + - - The maximum number of connections allowed for the VIP. - Value is -1 if the limit is not set. - + + + The maximum number of connections allowed for the VIP. + Value is -1 if the limit is not set. + + - - - The administrative state of the VIP. A valid value is up - (true) or down (false). - - + + + The administrative state of the VIP. A valid value is up + (true) or down (false). + + '> - - Human-readable name for the VIP. Does not have to be unique. - + + + Human-readable name for the VIP. Does not have to be unique. + + - - Human-readable description for the VIP. - + + + Human-readable description for the VIP. + + - - The ID of the pool with which the VIP is associated. - + + + The UUID of the pool with which the VIP is associated. + + - - - Session persistence parameters for the VIP. Omit the - session_persistence parameter to prevent session - persistence. When no session persistence is used, the - session_persistence parameter does not appear in the - API response. - - - To clear session persistence for the VIP, set the - session_persistence parameter to null in a - VIP update request. - - + + + Session persistence parameters for the VIP. Omit the + session_persistence parameter to prevent session + persistence. When no session persistence is used, the + session_persistence parameter does not appear in the + API response. + + + To clear session persistence for the VIP, set the + session_persistence parameter to null in a VIP + update request. + + - - The maximum number of connections allowed for the VIP. - Value is -1 if the limit is not set. - + + + The maximum number of connections allowed for the VIP. + Value is -1 if the limit is not set. + + - - - The administrative state of the VIP. A valid value is up - (true) or down (false). - - + + + The administrative state of the VIP. A valid value is up + (true) or down (false). + + '> - - Human-readable name for the pool. Does not have to be unique. - + + + Human-readable name for the pool. Does not have to be unique. + + - - Human-readable description for the pool. - + + + Human-readable description for the pool. + + - - - The load-balancer algorithm, which is round-robin, least-connections, - and so on, that is used to distribute traffic to the pool members. - This value, which must be supported, is dependent on the load-balancer - provider. The round-robin algorithm must be supported. - - + + + The load-balancer algorithm, which is round-robin + (ROUND_ROBIN), least-connections + (LEAST_CONNECTIONS), source IP (SOURCE_IP), + and so on, that is used to distribute traffic to the pool members. + This value, which must be supported, is dependent on the load-balancer + provider. The round-robin algorithm must be supported. + + - - The administrative state of the pool. A valid value is up - (true) or down (false). - + + + The administrative state of the pool. A valid value is up + (true) or down (false). + + '> - - - The ID of the tenant who owns the health monitor. Only administrative users can - specify a tenant ID other than their own. - - + + + The UUID of the tenant who owns the health monitor. Only administrative + users can specify a tenant UUID other than their own. + + - - The type of probe sent by the load balancer to verify the member state. A valid value is PING, TCP, HTTP, or HTTPS. - + + + The type of probe sent by the load balancer to verify the member + state. A valid value is PING, TCP, + HTTP, or HTTPS. + + - - The time, in seconds, between sending probes to members. - + + + The time, in seconds, between sending probes to members. + + - - 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. - + + + 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. + + &max_retriesRequestParameter; - - The HTTP method that the monitor uses for requests. - + + + 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. A valid value is a string that begins with a forward - slash (/). - - + + + The HTTP path of the request sent by the monitor to test 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. Specify one of the following values: + + + - The list of HTTP status codes expected in response from the member - to declare it healthy. Specify one of the following values: + A single value, such as 200. - - A single value, such as 200. - A list, such as 200, 202. - A range, such as 200-204. - - + + + + A list, such as 200, 202. + + + + + A range, such as 200-204. + + + + - - - The administrative state of the health monitor. A valid value is up - (true) or down (false). - - + + + The administrative state of the health monitor. A valid value is up + (true) or down (false). + + '> - - The UUID for the health monitor. - + + + The UUID for the health monitor. + + '> - - A member object. - + + + A member object. + + '> - - A list of member objects. - + + + A list of member objects. + + '> - - The unique ID for the member. - + + + The UUID for the member. + + - - - The ID of the tenant who owns the member. Only administrative users can - specify a tenant ID other than their own. - - + + + The UUID of the tenant who owns the member. Only administrative users + can specify a tenant UUID other than their own. + + - - The ID of the pool to which the member belongs. - + + + The UUID of the pool to which the member belongs. + + - - The IP address of the member. - + + + The IP address of the member. + + - - The port where the application is hosted. - + + + The port where 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 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. A valid value is up - (true) or down (false). - + + + The administrative state of the member. A valid value is up + (true) or down (false). + + - - The status of the member. Indicates whether the member is operational. - + + + The status of the member. Indicates whether the member is operational. + + '> - - - The ID of the tenant who owns the member. Only administrative users can - specify a tenant ID other than their own. - - + + + The UUID of the tenant who owns the member. Only administrative users + can specify a tenant UUID other than their own. + + - - The ID of the pool to which the member belongs. - + + + The UUID of the pool to which the member belongs. + + - - The IP address of the member. - + + + The IP address of the member. + + - - The port where the application is hosted. - + + + The port where 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 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. A valid value is up - (true) or down (false). - + + + The administrative state of the member. A valid value is up + (true) or down (false). + + '> - - The ID of the pool to which the member belongs. - + + + The UUID of the pool to which the member belongs. + + - - - 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 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. A valid value is up - (true) or down (false). - + + + The administrative state of the member. A valid value is up + (true) or down (false). + + '> - - - A security_group object. - - - '> - - - - A list of security_group objects. - - - '> - - - - The security group description. - - - - - - - The UUID for the security group. - - - - - - - The security group name. - - - - - - - Security group rules. - - - - &securityGroupRuleCommonResponseParams; -'> - - - - A symbolic name for the security group. Not required - to be unique. - - - - - - - Describes the security group. - - - - - - - The ID of the tenant who owns the security group. - Only administrative users can specify a tenant ID - other than their own. - - - '> - - - - Show detailed information. - - - - - - - The fields to be returned by server. - - - '> - - - - A security_group_rule object. - - - '> - - - - A list of security_group_rule objects. - - - '> - - - - Ingress or egress: the direction in which the security group - rule is applied. For a compute instance, an ingress security - group rule is applied to incoming (ingress) traffic for that - instance. An egress rule is applied to traffic leaving the - instance. - - - - - - - Must be IPv4 or IPv6, and addresses represented in CIDR must - match the ingress or egress rules. - - - - - - - The UUID of the security group rule. - - - - - - - The 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. - - - - - - - The 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 - port_range_max attribute value. If the protocol - is ICMP, this value must be an ICMP type. - - - - - - - The protocol that is matched by the security group rule. Value - is null, icmp, icmpv6, - tcp, or udp. - - - - - - - The remote group ID to be associated with this security group - rule. You can specify either the remote_group_id - or remote_ip_prefix attribute in the request body. - - - - - - - The remote IP prefix to be associated with this security group - rule. You can specify either the remote_group_id - or remote_ip_prefix attribute in the request body. - This attribute value matches the specified IP prefix as the - source IP address of the IP packet. - - - - - - - The ID of the security group. - - - - - - - The ID of the tenant who owns the security group rule. Only - administrative users can specify a tenant ID other than their - own. - - - '> - - - - Ingress or egress: The direction in which the security group - rule is applied. For a compute instance, an ingress security - group rule is applied to incoming (ingress) traffic for that - instance. An egress rule is applied to traffic leaving the - instance. - - + name="security_group" style="plain" type="xsd:dict"> + + + A security_group object. + + +'> + + + + A list of security_group objects. + + +'> + + + + The security group description. + + + + + + + The UUID for the security group. + + + + + + + The security group name. + + + + + + + Security group rules. + + + + &securityGroupRuleCommonResponseParams;'> + + + + A symbolic name for the security group. Not required + to be unique. + + + + + The security group description. + + + + + + + The UUID of the tenant who owns the security group. Only + administrative users can specify a tenant UUID other than their own. + + +'> + + + + Show detailed information. + + + + + + + The fields to be returned by server. + + +'> + + + + A security_group_rule object. + + +'> + + + + A list of security_group_rule objects. + + +'> + + + + Ingress or egress: the direction in which the security group + rule is applied. For a compute instance, an ingress security + group rule is applied to incoming (ingress) traffic for that + instance. An egress rule is applied to traffic leaving the + instance. + + + + - - - Must be IPv4 or IPv6, and addresses represented in CIDR must - match the ingress or egress rules. - - + + + Must be IPv4 or IPv6, and addresses represented in CIDR must + match the ingress or egress rules. + + + + + + + The UUID of the security group rule. + + + + + + + The 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. + + + + + + + The 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 port_range_max attribute value. If + the protocol is ICMP, this value must be an ICMP type. + + + + + + + The protocol that is matched by the security group rule. Value is + null, icmp, icmpv6, + tcp, or udp. + + + + + + + The remote group UUID to be associated with this security group + rule. You can specify either the remote_group_id or + remote_ip_prefix attribute in the request body. + + + + + + + The remote IP prefix to be associated with this security group rule. + You can specify either the remote_group_id or + remote_ip_prefix attribute in the request body. This + attribute value matches the specified IP prefix as the source IP + address of the IP packet. + + - - - The security group ID to associate with this security group - rule. - - + + + The UUID of the security group. + + + + + + + The UUID of the tenant who owns the security group rule. Only + administrative users can specify a tenant UUID other than their own. + + +'> + + + + Ingress or egress: The direction in which the security group + rule is applied. For a compute instance, an ingress security + group rule is applied to incoming (ingress) traffic for that + instance. An egress rule is applied to traffic leaving the + instance. + + - - - The 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 - port_range_max attribute value. If the protocol - is ICMP, this value must be an ICMP type. - - + name="ethertype" style="plain" type="xsd:string"> + + + Must be IPv4 or IPv6, and addresses represented in CIDR must + match the ingress or egress rules. + + + + + + + The security group UUID to associate with this security group + rule. + + - - - The 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. - - + name="port_range_min" style="plain" type="xsd:int"> + + + The 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 + port_range_max attribute value. If the protocol + is ICMP, this value must be an ICMP type. + + - - - The protocol that is matched by the security group rule. A valid - value is null, icmp, icmpv6, - tcp, or udp. It is case insensitive. - - + name="port_range_max" style="plain" type="xsd:int"> + + + The 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. + + - - - The remote group ID to be associated with this security group - rule. You can specify either the remote_group_id - or remote_ip_prefix attribute in the request body. - - + name="protocol" style="plain" type="xsd:string"> + + + The protocol that is matched by the security group rule. Valid + values are null, tcp, udp, and icmp. + + - - - The remote IP prefix to be associated with this security group - rule. You can specify either the remote_group_id - or remote_ip_prefix attribute in the request body. - This attribute matches the specified IP prefix as the source - IP address of the IP packet. - - + name="remote_group_id" style="plain" type="csapi:uuid"> + + + The remote group UUID to be associated with this security group + rule. You can specify either the remote_group_id + or remote_ip_prefix attribute in the request body. + + + + + + + The remote IP prefix to be associated with this security group + rule. You can specify either the remote_group_id + or remote_ip_prefix attribute in the request body. + This attribute matches the specified IP prefix as the source + IP address of the IP packet. + + '> - - VPN service objects. - + + + A list of VPN service objects. + + '> - VPN service object. + + A VPN service object. + '> - ID of the router into which the VPN service is - inserted. + + The UUID of the router into which the VPN service is inserted. + - Human-readable name for the VPN service. Does - not have to be unique. + + Human-readable name for the VPN service. Does not have to be unique. + - - The administrative state of the VPN service, which is up - (true) or down (false). If down, the port - does not forward packets. - + + The administrative state of the VPN service, which is up + (true) or down (false). If down, the port + does not forward packets. + - - Read-only external (public) IPv4 address that is used for the VPN - service. The VPN plugin sets this address if an IPv4 interface is - available. - + + Read-only external (public) IPv4 address that is used for the VPN + service. The VPN plugin sets this address if an IPv4 interface is + available. + - - Read-only external (public) IPv6 address that is used for the VPN - service. The VPN plugin sets this address if an IPv6 interface is - available. + + Read-only external (public) IPv6 address that is used for the VPN + service. The VPN plugin sets this address if an IPv6 interface is + available. @@ -4270,8 +4826,8 @@ router. xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> - Owner of the VPN service. Only administrative users can specify a - tenant ID other than their own. + The owner of the VPN service. Only administrative users can specify a + tenant UUID other than their own. @@ -4280,7 +4836,9 @@ router. - The unique ID for the VPN service. + + The UUID for the VPN service. + '> + + + + Human-readable name for the IPSec policy. Does not have to be + unique. + + +'> + + + + Human-readable description for the IPSec policy. + + +'> + + + + Human-readable name for the IPSec connection. Does not have to be + unique. + + +'> + + + + Human-readable description for the IPSec connection. + + +'> + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> Owner of the VPN service. Only administrative users can specify a - tenant ID other than their own. + tenant UUID other than their own. - - (Deprecated) The subnet where the tenant wants the VPN - service. - + + + (Deprecated) The subnet where the tenant wants the VPN + service. + + - - Router ID to which the VPN service is - inserted. - + + + The UUID of the router to which the VPN service is + inserted. + + '> - - VPN service object. - + + + A VPN service object. + + - - Human-readable name for the VPN service. Does - not have to be unique. - + + + Human-readable name for the VPN service. Does + not have to be unique. + + - - Human-readable description for the VPN - service. - + + + Human-readable description for the VPN service. + + - - - The administrative state of the VPN service, which is up - (true) or down (false). If down, - connections on service are not active. - - + + + The administrative state of the VPN service, which is up + (true) or down (false). If down, + connections on service are not active. + + '> - - An ikepolicy object. - + + + An ikepolicy object. + + '> - - - Owner of the IKE policy. Only administrative users can specify a - tenant ID other than their own. - - + + + The owner of the IKE policy. Only administrative users can specify a + tenant UUID other than their own. + + '> - - Human-readable name for the IKE policy. Does - not have to be unique. - + + + Human-readable name for the IKE policy. Does + not have to be unique. + + - - Human-readable description for the IKE policy. - + + + Human-readable description for the IKE policy. + + - - - The authentication hash algorithm. A valid value is - sha1, which is the default. - - + + + The authentication hash algorithm. A valid value is + sha1, which is the default. + + - - - The encryption algorithm. A valid value is 3des, - aes-128, aes-192, aes-256, - and so on. Default is aes-128. - - + + + The encryption algorithm. A valid value is 3des, + aes-128, aes-192, aes-256, + and so on. Default is aes-128. + + - - - The IKE mode. A valid value is main, which is the default. - - + + + The IKE mode. A valid value is main, which is the default. + + - - - Perfect forward secrecy (PFS). A valid value is Group2, - Group5, Group14, and so on. Default is - Group5. - - + + + Perfect forward secrecy (PFS). A valid value is Group2, + Group5, Group14, and so on. Default is + Group5. + + - - - The IKE version. A valid value is v1 or - v2. Default is v1. - - + + + The IKE version. A valid value is v1 or + v2. Default is v1. + + - - - The lifetime of the security association. The lifetime consists of a - unit and integer value. You can omit either the unit or value - portion of the lifetime. Default unit is seconds and default value - is 3600. - - + + + The lifetime of the security association. The lifetime consists of a + unit and integer value. You can omit either the unit or value + portion of the lifetime. Default unit is seconds and default value + is 3600. + + - - - The units for the lifetime of the security association. The lifetime - consists of a unit and integer value. You can omit either the unit - or value portion of the lifetime. Default unit is seconds and - default value is 3600. - - + + + The units for the lifetime of the security association. The lifetime + consists of a unit and integer value. You can omit either the unit + or value portion of the lifetime. Default unit is seconds and + default value is 3600. + + - - - The lifetime value, as a positive integer. The lifetime consists of - a unit and integer value. You can omit either the unit or value - portion of the lifetime. Default unit is seconds and default value - is 3600. - - + + + The lifetime value, as a positive integer. The lifetime consists of + a unit and integer value. You can omit either the unit or value + portion of the lifetime. Default unit is seconds and default value + is 3600. + + '> - ikepolicy objects. + + A list of ikepolicy objects. + '> - - The unique ID for the IKE policy. - + + + The UUID for the IKE policy. + + - - - Owner of the VPN service. Only administrative users can specify a - tenant ID other than their own. - - + + + The owner of the VPN service. Only administrative users can specify a + tenant UUID other than their own. + + - - - Human-readable name for the IKE policy. Does not have to be unique. - - + + + Human-readable name for the IKE policy. Does not have to be unique. + + - - - Human-readable description for the IKE policy. - - + + + Human-readable description for the IKE policy. + + - - - The authentication hash algorithm. A valid value is - sha1, which is the default. - - + + + The authentication hash algorithm. A valid value is sha1, + which is the default. + + - - - The encryption algorithm. A valid value is 3des, - aes-128, aes-192, aes-256, - and so on. Default is aes-128. - - + + + The encryption algorithm. A valid value is 3des, + aes-128, aes-192, aes-256, + and so on. Default is aes-128. + + - - - The IKE mode. A valid value is main, which is the default. - - + + + The IKE mode. A valid value is main, which is the default. + + - - - Perfect forward secrecy (PFS). A valid value is Group2, - Group5, Group14, and so on. Default is - Group5. - - + + + Perfect forward secrecy (PFS). A valid value is Group2, + Group5, Group14, and so on. Default is + Group5. + + - - - The IKE version. A valid value is v1 or - v2. Default is v1. - - + + + The IKE version. A valid value is v1 or + v2. Default is v1. + + - - - The lifetime of the security association. The lifetime consists of a - unit and integer value. You can omit either the unit or value - portion of the lifetime. - - + + + The lifetime of the security association. The lifetime consists of a + unit and integer value. You can omit either the unit or value + portion of the lifetime. + + - - - Units for lifetime of the security association. Default is - seconds. - - + + + The units for the lifetime of the security association. The lifetime + consists of a unit and integer value. You can omit either the unit or + value portion of the lifetime. Default unit is seconds and default value + is 3600. + + - - - Lifetime value, as a positive integer. Default is 3600 seconds. - - + + + The lifetime value, as a positive integer. The lifetime consists of a + unit and integer value. You can omit either the unit or value + portion of the lifetime. Default unit is seconds and default value + is 3600. + + '> - - - Owner of the IPSec policy. Only administrative users can specify a - tenant ID other than their own. - - + + + Owner of the IPSec policy. Only administrative users can specify a + tenant UUID other than their own. + + '> - - An ipsecpolicy object. - - '> + + + An ipsecpolicy object. + + +'> - - - The transform protocol. A valid value is ESP, - AH, or AH-ESP. Default is - ESP. - - + + + The transform protocol. A valid value is ESP, + AH, or AH-ESP. Default is + ESP. + + - - - The encapsulation mode. A valid value is tunnel or - transport. Default is tunnel. - - + + + The encapsulation mode. A valid value is tunnel or + transport. Default is tunnel. + + - - - The authentication algorithm. A valid value is sha1, - which is the default. - - + + + The authentication algorithm. A valid value is sha1, + which is the default. + + - - - The encryption algorithm. A valid value is 3des, - aes-128, aes-192, aes-256, - and so on. Default is aes-128. - - + + + The encryption algorithm. A valid value is 3des, + aes-128, aes-192, aes-256, + and so on. Default is aes-128. + + - - - Perfect forward secrecy (PFS). A valid value is Group2, - Group5, Group14, and so on. Default is - Group5. - - + + + Perfect forward secrecy (PFS). A valid value is Group2, + Group5, Group14, and so on. Default is + Group5. + + - - - The lifetime of the security association. The lifetime consists of a - unit and integer value. You can omit either the unit or value - portion of the lifetime. - - + + + The lifetime of the security association. The lifetime consists of a + unit and integer value. You can omit either the unit or value + portion of the lifetime. + + - - - Units for lifetime of the security association. Default is - seconds. - - + + + The units for the lifetime of the security association. The lifetime + consists of a unit and integer value. You can omit either the unit or + value portion of the lifetime. Default unit is seconds and default value + is 3600. + + - - - Lifetime value, as a positive integer. Default is 3600 seconds. - - + + + The lifetime value, as a positive integer. The lifetime consists of a unit + and integer value. You can omit either the unit or value portion of the + lifetime. Default unit is seconds and default value is 3600. + + '> - - IPSec policy objects. - + + + A list of IPSec policy objects. + + '> - - The unique ID for the IPSec policy. - + + + The UUID for the IPSec policy. + + - - - Owner of the VPN service. Only administrative users can specify a - tenant ID other than their own. - - + + + Owner of the VPN service. Only administrative users can specify a + tenant UUID other than their own. + + - - - Human-readable name for the IPSec policy. Does not have to be - unique. - - + + + Human-readable name for the IPSec policy. Does not have to be + unique. + + - - - Human-readable description for the IPSec policy. - - + + + Human-readable description for the IPSec policy. + + - - - The transform protocol. A valid value is ESP, - AH, or AH-ESP. Default is - ESP. - - + + + The transform protocol. A valid value is ESP, + AH, or AH-ESP. Default is ESP. + + - - Encapsulation mode: tunnel(default), or transport. - + + + The encapsulation mode. A valid value is tunnel or + transport. Default is tunnel. + + - - - The authentication algorithm. A valid value is sha1, - which is the default. - - + + + The authentication algorithm. A valid value is sha1, + which is the default. + + - - - The encryption algorithm. A valid value is 3des, - aes-128, aes-192, - aes-256, and so on. Default is aes-128. - - + + + The encryption algorithm. A valid value is 3des, + aes-128, aes-192, aes-256, and so + on. Default is aes-128. + + - - - Perfect forward secrecy (PFS). A valid value is Group2, - Group5, Group14, and so on. Default is - Group5. - - + + + Perfect forward secrecy (PFS). A valid value is Group2, + Group5, Group14, and so on. Default is + Group5. + + - - - The lifetime of the security association. The lifetime consists of a - unit and integer value. You can omit either the unit or value - portion of the lifetime. - - + + + The lifetime of the security association. The lifetime consists of a + unit and integer value. You can omit either the unit or value + portion of the lifetime. + + - - - Units for lifetime of the security association. Default is seconds. - - + + + The units for the lifetime of the security association. The lifetime + consists of a unit and integer value. You can omit either the unit or + value portion of the lifetime. Default unit is seconds and default value + is 3600. + + - - Lifetime value, as a positive integer. Default is 3600 seconds. - + + + The lifetime value, as a positive integer. The lifetime consists of a + unit and integer value. You can omit either the unit or value + portion of the lifetime. Default unit is seconds and default value + is 3600. + + '> - - - Owner of the VPN endpoint group. Only administrative users can specify a - tenant ID other than their own. - - + + + Owner of the VPN endpoint group. Only administrative users can specify a + tenant UUID other than their own. + + - - - The type of the endpoints in the group. A valid value is - subnet, cidr, network, - router, or vlan. - - + + + The type of the endpoints in the group. A valid value is + subnet, cidr, network, + router, or vlan. + + - - - List of endpoints of the same type, for the endpoint group. - The values will depend on type specified. - - + + + List of endpoints of the same type, for the endpoint group. + The values will depend on type specified. + + '> - - - Human-readable name for the VPN endpoint group. Does not have to be - unique. - - + + + Human-readable name for the VPN endpoint group. Does not have to be + unique. + + - - - Human-readable description for the VPN endpoint group. - - + + + Human-readable description for the VPN endpoint group. + + '> - - VPN endpoint group objects. - + + + The VPN endpoint group objects. + + '> - - The unique ID for the VPN endpoint group. - + + + The UUID for the VPN endpoint group. + + - - - Owner of the VPN endpoint group. Only administrative users can specify a - tenant ID other than their own. - - + + + Owner of the VPN endpoint group. Only administrative users can specify a + tenant UUID other than their own. + + - - - Human-readable name for the VPN endpoint group. Does not have to - be unique. - - + + + Human-readable name for the VPN endpoint group. Does not have to + be unique. + + - - - Human-readable description for the VPN endpoint group. - - + + + Human-readable description for the VPN endpoint group. + + - - - The type of the endpoints in the group. A valid value is - subnet, cidr, network, - router, or vlan. - - + + + The type of the endpoints in the group. A valid value is + subnet, cidr, network, + router, or vlan. + + - - - A list of endpoints of the same type for the endpoint group. - Theses values depend on the specified type. - - + + + A list of endpoints of the same type for the endpoint group. + Theses values depend on the specified type. + + '> - - - Owner of the IPSec connection. Only administrative users can specify - a tenant ID other than their own. - - + + + Owner of the IPSec connection. Only administrative users can specify + a tenant UUID other than their own. + + - - - The route mode. A valid value is static, which is the - default. - - + + + The route mode. A valid value is static, which is the + default. + + - - - The authentication mode. A valid value is psk, which is - the default. - - + + + The authentication mode. A valid value is psk, which is + the default. + + @@ -5061,75 +5713,85 @@ router. - - Unique identifier of IKE policy. - + + + The UUID of the IKE policy. + + - - Unique identifier of IPSec policy. - + + + The UUID of the IPSec policy. + + - - Unique identifier of VPN service. - + + + The UUID of the VPN service. + + '> - - An ipsec_site_connection object. - + + + An ipsec_site_connection object. + + '> - - - Human-readable name for the IPSec connection. Does not have to - be unique. - - + + + Human-readable name for the IPSec connection. Does not have to + be unique. + + - - - Human-readable description for the IPSec connection. - - + + + Human-readable description for the IPSec connection. + + - - Peer gateway public IPv4/IPv6 address or FQDN. - + + + The peer gateway public IPv4 or IPv6 address or FQDN. + + + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> - Peer router identity for authentication. A valid value is an IPv4 + The peer router identity for authentication. A valid value is an IPv4 address, IPv6 address, e-mail address, key ID, or FQDN. Typically, this value matches the peer_address value. @@ -5138,10 +5800,10 @@ router. + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> - ID for the endpoint group that contains private subnets for the local + The UUID for the endpoint group that contains private subnets for the local side of the connection. Must be specified with the peer_ep_group_id parameter unless in backward-compatible mode where peer_cidrs is provided with a @@ -5152,10 +5814,10 @@ router. + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> - The ID for the endpoint group that contains private CIDRs in the form + The UUID for the endpoint group that contains private CIDRs in the form <net_address>/<prefix> for the peer side of the connection. Must be specified with the local_ep_group_id parameter unless in backward-compatible mode where peer_cidrs is @@ -5166,8 +5828,8 @@ router. + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> (Deprecated) Unique list of valid peer private CIDRs in the form <net_address>/<prefix>. @@ -5177,10 +5839,10 @@ router. + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> - The Maximum Transmission Unit (MTU) value to address fragmentation. + The maximum transmission unit (MTU) value to address fragmentation. Minimum value is 68 for IPv4, and 1280 for IPv6. @@ -5188,8 +5850,8 @@ router. + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> The pre-shared key. A valid value is any string. @@ -5198,8 +5860,8 @@ router. + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> Indicates whether this VPN can only respond to connections or both respond to and initiate connections. A valid value is @@ -5211,7 +5873,7 @@ router. + xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> The administrative state of the IPSec connection, which is up (true) or down (false). If down, the @@ -5222,8 +5884,8 @@ router. + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> A dictionary with dead peer detection (DPD) protocol controls. @@ -5234,11 +5896,11 @@ router. - - The DPD action. A valid value is clear, - hold, restart, disabled, or - restart-by-peer. Default value is hold. - + + The dead peer detection (DPD) action. A valid value is clear, + hold, restart, disabled, or + restart-by-peer. Default value is hold. + - - The DPD interval, in seconds. A valid value is a positive integer. - Default is 30. - + + The dead peer detection (DPD) interval, in seconds. A valid value is a + positive integer. Default is 30. + - - The DPD timeout in seconds. A valid value is a positive integer that - is greater than the DPD interval value. Default is 120. - + + The dead peer detection (DPD) timeout in seconds. A valid value is a + positive integer that is greater than the DPD interval + value. Default is 120. + '> - - IPSec site-to-site connection objects. - + + + A list of IPSec site-to-site connection objects. + + '> - - The unique ID for the IPSec connection. - + + + The UUID for the IPSec connection. + + - - - Owner of the IPSec connection. Only administrative users can specify - a tenant ID other than their own. - - + + + Owner of the IPSec connection. Only administrative users can specify + a tenant UUID other than their own. + + + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> Human-readable name for the IPSec connection. Does not have to be unique. @@ -5305,29 +5972,31 @@ router. - - Human-readable description for the IPSec connection. - + + + Human-readable description for the IPSec connection. + + + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> - Peer gateway public IPv4 address, IPv6 address, or FQDN. + The peer gateway public IPv4 address, IPv6 address, or FQDN. + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> - Peer router identity for authentication. Can be an IPv4 address, IPv6 + The peer router identity for authentication. Can be an IPv4 address, IPv6 address, e-mail address, key ID, or FQDN. Typically, this value matches the peer_address value. @@ -5336,10 +6005,10 @@ router. + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> - The ID for the endpoint group that contains private subnets for the + The UUID for the endpoint group that contains private subnets for the local side of the connection. This value is present with the peer_ep_group_id parameter unless in backward-compatible mode, where peer_cidrs is shown. @@ -5349,10 +6018,10 @@ router. + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> - The ID for the endpoint group that contains private CIDRs in the form + The UUID for the endpoint group that contains private CIDRs in the form <net_address>/<prefix> for the peer side of the connection. This value is present with the local_ep_group_id parameter unless in backward-compatible mode, where peer_cidrs is @@ -5363,8 +6032,8 @@ router. + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> (Deprecated) Unique list of valid peer private CIDRs in the form <net_address>/<prefix>. @@ -5373,73 +6042,75 @@ router. - - - The route mode. A valid value is static, which is the - default. - - + + + The route mode. A valid value is static, which is the + default. + + - - - The maximum transmission unit (MTU) to address fragmentation. The - minimum value for IPv4 is 68. The minimum value for IPv6 is 1280. - - + + + The maximum transmission unit (MTU) to address fragmentation. The + minimum value for IPv4 is 68. The minimum value for IPv6 is 1280. + + - - - The authentication mode. A valid value is psk, which is - the default. - - + + + The authentication mode. A valid value is psk, which is + the default. + + - - Pre Shared Key: any string - + + + The pre-shared key. A valid value is any string. + + - - - Indicates whether this VPN can only respond to connections or both - respond to and initiate connections. A valid value is response-only or bi-directional. Default is - bi-directional. - - + + + Indicates whether this VPN can only respond to connections or both + respond to and initiate connections. A valid value is response-only or bi-directional. Default is + bi-directional. + + - - - The administrative state of the IPSec connection, which is up - (true) or down (false). If down, the - connection does not forward packets. - - + + + The administrative state of the IPSec connection, which is up + (true) or down (false). If down, the + connection does not forward packets. + + + xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> Indicates whether the IPSec connection is currently operational. Value is ACTIVE, DOWN, BUILD, @@ -5449,78 +6120,89 @@ router. - - Unique identifier of IKE policy. - + + + The UUID of the IKE policy. + + - - Unique identifier of IPSec policy. - + + + The UUID of the IPSec policy. + + - - Unique identifier of VPN service. - + + + The UUID of the VPN service. + + - - A dictionary with Dead Peer Detection (DPD) protocol controls. - + + + A dictionary with dead peer detection (DPD) protocol controls. + + - - - The DPD action. A valid value is clear, - hold, restart, disabled, or - restart-by-peer. Default value is hold. - - + + + The dead peer detection (DPD) action. A valid value is + clear, hold, restart, + disabled, or restart-by-peer. Default value is + hold. + + - - - The DPD interval, in seconds. A valid value is a positive integer. - Default is 30. - - + + + The dead peer detection (DPD) interval, in seconds. A valid value is a + positive integer. Default is 30. + + - - - The DPD timeout, in seconds. A valid value is a positive integer - that is greater than the DPD interval value. - Default is 120. - - + + + The dead peer detection (DPD) timeout, in seconds. A valid value is a + positive integer that is greater than the DPD interval + value. Default is 120. + + '> - - List of dictionary pairs in this format: + name="routes" style="plain" type="xsd:dict"> + + + A list of dictionary pairs in this format: + [ { "nexthop":"IPADDRESS", @@ -5531,165 +6213,194 @@ router. - - The IP address of the next hop. + + + The IP address of the next hop. + - - The destination CIDR. + + + The destination CIDR. + '> - - A quota object. - + + + A quota object. + + '> - - The number of subnets - allowed for each tenant. - + + + The number of subnets allowed for each tenant. + + '> - - The number of routers allowed for each tenant. - + + + The number of routers allowed for each tenant. + + '> - - The number of ports allowed for each tenant. - + + + The number of ports allowed for each tenant. + + '> - - The number of networks allowed for each tenant. - + + + The number of networks allowed for each tenant. + + '> - - The number of floating IP addresses - allowed for each tenant. + + + The number of floating IP addresses allowed for each tenant. - + '> - - The number of subnet pools allowed for each tenant. - + + + The number of subnet pools allowed for each tenant. + + '> - - The number of security group rules allowed for each tenant. - + + + The number of security group rules allowed for each tenant. + + '> - - The number of security groups allowed for each tenant. - + + + The number of security groups allowed for each tenant. + + '> - - The number of health monitors for each tenant. - + + + The number of health monitors for each tenant. + + '> - - The number of virtual IP (VIP) addresses for each tenant. - + + + The number of virtual IP (VIP) addresses for each tenant. + + '> - - The number of pool members for each tenant. - + + + The number of pool members for each tenant. + + '> - - The number of pools for each tenant. - + + + The number of pools for each tenant. + + '> - - The number of role-based access control (RBAC) policies for each tenant. - + + + The number of role-based access control (RBAC) policies for each tenant. + + '> - - A name for the subnet pool. - + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> + + A name for the subnet pool. + + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> An address scope to assign to the subnet pool. @@ -5698,8 +6409,8 @@ router. + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> A list of subnet prefixes to assign to the subnet pool. The API merges adjacent prefixes and treats them as a single prefix. @@ -5713,12 +6424,12 @@ router. + 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 not specified when you create - the subnet. Default is min_prefixlen. + The size of the prefix to allocate when the cidr or + prefixlen attributes are not specified when you create + the subnet. Default is min_prefixlen. @@ -5736,8 +6447,8 @@ router. + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> The maximum prefix size that can be allocated from the subnet pool. For IPv4 subnet pools, default is @@ -5748,8 +6459,8 @@ router. + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> A per-tenant quota on the prefix space that can be allocated from the subnet pool for tenant subnets. Default is no quota is enforced on @@ -5762,41 +6473,41 @@ router. - - - The ID of the tenant who owns the subnet pool. Only administrative - users can specify a tenant ID other than their own. You cannot - change this value through authorization policies. - - + + + The UUID of the tenant who owns the subnet pool. Only administrative + users can specify a tenant UUID other than their own. You cannot + change this value through authorization policies. + + - - - Admin-only. Indicates whether this subnet pool is shared across all - tenants. - - + + + Admin-only. Indicates whether this subnet pool is shared across all + tenants. + + '> - - A name for the subnet pool. - + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> + + A name for the subnet pool. + + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> An address scope to assign to the subnet pool. @@ -5805,8 +6516,8 @@ router. + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> A list of subnet prefixes to assign to the subnet pool. The API merges adjacent prefixes and treats them as a single prefix. @@ -5827,12 +6538,12 @@ router. + 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 not specified when you create - the subnet. Default is min_prefixlen. + The size of the prefix to allocate when the cidr or + prefixlen attributes are not specified when you create + the subnet. Default is min_prefixlen. @@ -5850,20 +6561,20 @@ router. + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> - The maximum prefix size that can be allocated from the subnet pool. - For IPv4 subnet pools, default is - 32. For IPv6 subnet pools, default is 128. + The maximum prefix size that can be allocated from the subnet pool. For + IPv4 subnet pools, default is 32. For IPv6 subnet pools, + default is 128. + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> A per-tenant quota on the prefix space that can be allocated from the subnet pool for tenant subnets. Default is no quota is enforced on @@ -5881,35 +6592,35 @@ router. - - - The ID of the tenant who owns the subnet pool. Only administrative - users can specify a tenant ID other than their own. You cannot - change this value through authorization policies. - - + + + The UUID of the tenant who owns the subnet pool. Only administrative + users can specify a tenant UUID other than their own. You cannot + change this value through authorization policies. + + '> - - A list of subnetpool objects. - + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> + + A list of subnetpool objects. + '> - - A subnetpool object. - + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> + + A subnetpool object. + '> + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> The address scope. @@ -5935,30 +6646,30 @@ router. + 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 not specified when you create - the subnet. + The size of the prefix to allocate when the cidr or + prefixlen attributes are not specified when you create + the subnet. + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> - The ID of the subnet pool. + The UUID of the subnet pool. + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> The maximum prefix size that can be allocated from the subnet pool. @@ -5967,18 +6678,18 @@ router. - - The subnet pool name. - + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> + + The subnet pool name. + + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> A per-tenant quota on the prefix space that can be allocated from the subnet pool for tenant subnets. For IPv4 subnet pools, @@ -5991,18 +6702,18 @@ router. + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> - The ID of the tenant who owns the subnet pool. + The UUID of the tenant who owns the subnet pool. + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> A list of subnet prefixes that are assigned to the subnet pool. The API merges adjacent prefixes and treats them as a single prefix. @@ -6012,8 +6723,8 @@ router. + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> The IP address family of the list of prefixes passed to the prefixes attribute. @@ -6022,34 +6733,34 @@ router. - - - Indicates whether this subnet pool is shared across all - tenants. - - + + + Indicates whether this subnet pool is shared across all + tenants. + + '> - - - A security_group object. - + + + A security_group object. + '> - - A list of security_group objects. - + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN" title="Security groups object"> + + A list of security_group objects. + '> xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN" title="Security group description"> - Security group description. + The security group description. @@ -6067,9 +6778,9 @@ router. required="true"> + xml:lang="EN" title="Security group UUID"> - The security group ID. + The UUID of the security group. @@ -6087,24 +6798,23 @@ router. required="true"> + xml:lang="EN" title="Tenant UUID"> - The tenant. + The UUID of the tenant. '> - - - The number of allowed connection failures before changing the status - of the member to INACTIVE. A valid value is from 1 to - 10. - - + + + The number of allowed connection failures before changing the status of + the member to INACTIVE. A valid value is from 1 to 10. + + '> xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN" title="Service type"> - The service type, which is - CORE, - DUMMY, - FIREWALL, - FLAVORS, - L3_ROUTER_NAT, - LOADBALANCER, - LOADBALANCERV2, - METERING, - QOS, or - VPN. + The service type, which is CORE, DUMMY, + FIREWALL, FLAVORS, L3_ROUTER_NAT, + LOADBALANCER, LOADBALANCERV2, + METERING, QOS, or VPN. @@ -6147,10 +6850,9 @@ router. xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN" title="default"> - Defines whether the provider is or is not the default for - the specified service type. If this value is - true, the provider is the default. If this - value is false, the provider is not the + Defines whether the provider is or is not the default for the specified + service type. If this value is true, the provider is the + default. If this value is false, the provider is not the default. @@ -6166,49 +6868,173 @@ router. '> - - - - Human-readable name for the IPSec connection. Does not have to be - unique. - - -'> - + + + The administrative state of the firewall, which is up + (true) or down (false). + + + - - - Human-readable description for the IPSec connection. - - -'> - + + Human-readable description for the firewall + service. + + + + + + + The UUID of the firewall policy associated with the firewall. + + + + + + + The UUID for the firewall service. + + + - - - Human-readable name for the IPSec policy. Does not have to be - unique. - - + + + Human-readable name for the firewall service. Does + not have to be unique. + + + + + + + The status of the firewall service. Value is ACTIVE, + ERROR, PENDING_CREATE, + PENDING_UPDATE, or PENDING_DELETE. + + + + + + + Owner of the firewall service. Only administrative users can specify a + tenant UUID other than their own. + + '> - + + + The administrative state of the Firewall, which is up + (true) or down (false). + + + - - - Human-readable description for the IPSec policy. - - + + + Human-readable description for the firewall service. + + + + + + + The UUID of the firewall policy associated with the firewall. + + + + + + + Human-readable name for the firewall service. Does not have to + be unique. + + +'> + + + + The UUID of the firewall. + + +'> + + + + The administrative state of the firewall, which is up + (true) or down (false). + + + + + + + Human-readable description for the firewall service. + + + + + + + The UUID of the firewall policy that is associated with the + firewall. + + + + + + + Human-readable name for the firewall service. Does not have to + be unique. + + '> diff --git a/api-ref/src/wadls/netconn-api/src/os-fwaasv2.0-ext.wadl b/api-ref/src/wadls/netconn-api/src/os-fwaasv2.0-ext.wadl new file mode 100644 index 000000000..5b24c03a4 --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/os-fwaasv2.0-ext.wadl @@ -0,0 +1,190 @@ + + + + + + + + + + + %common; + + %common_project; +]> + + + + + + + + + + + + The + UUID for the firewall. + + + + + + + + + + + + + + + + + List firewalls. + Lists all firewalls. The list might be empty. + + + + + + + &FWResponseParams; + + &fault401; &fault403; + + + + Shows details for a specified firewall. + + Shows the details for a specified firewall. If the user is not + an administrative user and the firewall object does not belong + to the user's tenant account, a 403 (Forbidden) error is + returned. + + + + + + + + &FWResponseParams; + + &fault401; &fault403; &fault404; + + + + Creates a firewall. + + Creates a firewall object. The firewall must be associated + with a firewall policy. + + Example: + + + + + + + &FWRequestParams; + + + + + + + + &FWResponseParams; + + + &fault400; + &fault401; + + + + Updates a specified firewall. + + Updates the attributes for a specified firewall. To update a + service, the service status cannot be a PENDING_* + status. + + + + + + + + &FWUpdateParams; + + + + + + + + &FWResponseParams; + + + &fault400; + &fault401; + &fault404; + + + + Removes a specified firewall. + + + + + + + + + + &fault401; + &fault404; + &fault409conflict; + +