From d6d91b666a590a68112e41ab1075b35543b042cd Mon Sep 17 00:00:00 2001 From: Akihiro Motoki Date: Fri, 29 Jul 2016 15:00:13 +0900 Subject: [PATCH] api-ref: Merge v2 and v2-ext into one directory Preparation of API-ref cleanup. Part of blueprint neutron-in-tree-api-ref Change-Id: I3d499d60b1687208a2b5882e9f655836c906a297 --- api-ref/source/index.rst | 1 - api-ref/source/v2-ext/index.rst | 26 - api-ref/source/v2-ext/parameters.yaml | 3857 ----------------- api-ref/source/{v2-ext => v2}/extensions.inc | 0 api-ref/source/{v2-ext => v2}/extraroute.inc | 0 .../flavors.inc} | 0 api-ref/source/{v2-ext => v2}/fwaas-v2.0.inc | 0 api-ref/source/v2/index.rst | 24 +- api-ref/source/{v2-ext => v2}/layer3-ext.inc | 0 api-ref/source/{v2-ext => v2}/lbaas-v1.inc | 0 api-ref/source/{v2-ext => v2}/lbaas-v2.inc | 0 .../{v2-ext => v2}/metering-labels-ext.inc | 0 .../{v2-ext => v2}/network-provider.inc | 6 +- .../networking-ip-availability-ext.inc | 6 +- .../networks-multi-provider-ext.inc | 2 +- .../networks-vlan-transparency-ext.inc | 2 +- api-ref/source/v2/parameters.yaml | 3811 +++++++++++++++- .../source/{v2-ext => v2}/port-binding.inc | 0 api-ref/source/{v2-ext => v2}/qos-ext.inc | 0 api-ref/source/{v2-ext => v2}/quotas.inc | 8 +- .../source/{v2-ext => v2}/security-groups.inc | 0 .../{v2-ext => v2}/security_group_rules.inc | 0 .../source/{v2-ext => v2}/subnetpools-ext.inc | 0 api-ref/source/{v2-ext => v2}/tag-ext.inc | 0 ...{versions-networks-v2.inc => versions.inc} | 0 api-ref/source/{v2-ext => v2}/vpnaas.inc | 0 26 files changed, 3845 insertions(+), 3898 deletions(-) delete mode 100644 api-ref/source/v2-ext/index.rst delete mode 100644 api-ref/source/v2-ext/parameters.yaml rename api-ref/source/{v2-ext => v2}/extensions.inc (100%) rename api-ref/source/{v2-ext => v2}/extraroute.inc (100%) rename api-ref/source/{v2-ext/flavors-framework-v2.0.inc => v2/flavors.inc} (100%) rename api-ref/source/{v2-ext => v2}/fwaas-v2.0.inc (100%) rename api-ref/source/{v2-ext => v2}/layer3-ext.inc (100%) rename api-ref/source/{v2-ext => v2}/lbaas-v1.inc (100%) rename api-ref/source/{v2-ext => v2}/lbaas-v2.inc (100%) rename api-ref/source/{v2-ext => v2}/metering-labels-ext.inc (100%) rename api-ref/source/{v2-ext => v2}/network-provider.inc (98%) rename api-ref/source/{v2-ext => v2}/networking-ip-availability-ext.inc (95%) rename api-ref/source/{v2-ext => v2}/networks-multi-provider-ext.inc (99%) rename api-ref/source/{v2-ext => v2}/networks-vlan-transparency-ext.inc (99%) rename api-ref/source/{v2-ext => v2}/port-binding.inc (100%) rename api-ref/source/{v2-ext => v2}/qos-ext.inc (100%) rename api-ref/source/{v2-ext => v2}/quotas.inc (95%) rename api-ref/source/{v2-ext => v2}/security-groups.inc (100%) rename api-ref/source/{v2-ext => v2}/security_group_rules.inc (100%) rename api-ref/source/{v2-ext => v2}/subnetpools-ext.inc (100%) rename api-ref/source/{v2-ext => v2}/tag-ext.inc (100%) rename api-ref/source/v2/{versions-networks-v2.inc => versions.inc} (100%) rename api-ref/source/{v2-ext => v2}/vpnaas.inc (100%) diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index 29933f93b..fca8ebde8 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -6,4 +6,3 @@ Networking Service APIs :maxdepth: 2 v2/index - v2-ext/index diff --git a/api-ref/source/v2-ext/index.rst b/api-ref/source/v2-ext/index.rst deleted file mode 100644 index d5f12730c..000000000 --- a/api-ref/source/v2-ext/index.rst +++ /dev/null @@ -1,26 +0,0 @@ -:tocdepth: 2 - -############################## -Networking API v2.0 extensions -############################## - -.. include:: extensions.inc -.. include:: tag-ext.inc -.. include:: network-provider.inc -.. include:: networking-ip-availability-ext.inc -.. include:: networks-multi-provider-ext.inc -.. include:: networks-vlan-transparency-ext.inc -.. include:: port-binding.inc -.. include:: qos-ext.inc -.. include:: quotas.inc -.. include:: security-groups.inc -.. include:: security_group_rules.inc -.. include:: subnetpools-ext.inc -.. include:: layer3-ext.inc -.. include:: extraroute.inc -.. include:: metering-labels-ext.inc -.. include:: flavors-framework-v2.0.inc -.. include:: lbaas-v2.inc -.. include:: lbaas-v1.inc -.. include:: fwaas-v2.0.inc -.. include:: vpnaas.inc diff --git a/api-ref/source/v2-ext/parameters.yaml b/api-ref/source/v2-ext/parameters.yaml deleted file mode 100644 index c524e6da6..000000000 --- a/api-ref/source/v2-ext/parameters.yaml +++ /dev/null @@ -1,3857 +0,0 @@ -# variables in header - -# variables in path -alias_1: - description: | - The alias of an extension. - in: path - required: false - type: string -connection_id: - description: | - The UUID of the IPSec site-to-site connection. - in: path - required: false - type: string -endpoint_group_id: - description: | - The UUID of the VPN endpoint group. - in: path - required: false - type: string -firewall_id: - description: | - The UUID of the firewall. - in: path - required: false - type: string -firewall_policy_id_2: - description: | - The UUID of the firewall policy. - in: path - required: false - type: string -firewall_rule_id: - description: | - The UUID for the firewall rule. - in: path - required: false - type: string -flavor_id: - description: | - The UUID of the flavor. - in: path - required: false - type: string -floatingip_id: - description: | - The UUID of the floating IP address. - in: path - required: false - type: string -health_monitor_id: - description: | - The UUID for the health monitor. - in: path - required: false - type: string -ikepolicy_id_1: - description: | - The UUID of the IKE policy. - in: path - required: false - type: string -ipsecpolicy_id_1: - description: | - The UUID of the IPSec policy. - in: path - required: false - type: string -member_id: - description: | - The UUID for the member. - in: path - required: false - type: string -network_id: - description: | - The UUID of the network. - in: path - required: false - type: string -policy_id: - description: | - The UUID of the policy. - in: path - required: false - type: string -pool_id: - description: | - The UUID for the pool. - in: path - required: false - type: string -port_id_3: - description: | - The UUID of the port. - in: path - required: false - type: string -profile_id: - description: | - The UUID of the profile. - in: path - required: false - type: string -resource_id: - description: | - The UUID of resource which the tag is set on. - in: path - required: false - type: string -resource_type: - description: | - The type of resource which the tag is set on. - in: path - required: false - type: string -router_id: - description: | - The UUID of the router. - in: path - required: false - type: string -rule_id: - description: | - The UUID of the rule. - in: path - required: false - type: string -security_group_id_2: - description: | - The UUID of the security group. - in: path - required: false - type: string -service_id: - description: | - The UUID of the VPN service. - in: path - required: false - type: string -subnetpool_id: - description: | - The UUID of the subnet pool. - in: path - required: false - type: string -tag: - description: | - The name for the tag. - in: path - required: false - type: string -tenant_id_33: - description: | - The UUID of the tenant. - in: path - required: false - type: string -vip_id_1: - description: | - The UUID for the VIP. - in: path - required: false - type: string - -# variables in query -fields: - description: | - The fields that you want the server to return. - in: query - required: false - type: string -verbose: - description: | - Show detailed information. - in: query - required: false - type: boolean - -# variables in body -action: - description: | - The action that the API performs on traffic that - matches the firewall rule. Valid value is ``allow`` or ``deny``. - Default is ``deny``. - in: body - required: false - type: string -action_1: - description: | - The dead peer detection (DPD) action. A valid - value is ``clear``, ``hold``, ``restart``, ``disabled``, or - ``restart-by-peer``. Default value is ``hold``. - in: body - required: false - type: string -action_2: - description: | - The action that the API performs on traffic that - matches the firewall rule. Value is ``allow`` or ``deny``. - in: body - required: true - type: string -action_3: - description: | - The dead peer detection (DPD) action. A valid - value is ``clear``, ``hold``, ``restart``, ``disabled``, or - ``restart-by-peer``. Default value is ``hold``. - in: body - required: true - type: string -address: - description: | - The IP address of the member. - format: ipv4 - in: body - required: true - type: string -address_1: - description: | - The IP address of the VIP. - format: ipv4 - in: body - required: false - type: string -address_2: - description: | - The IP address of the VIP. - format: ipv4 - in: body - required: true - type: string -address_scope_id: - description: | - An address scope to assign to the subnet pool. - in: body - required: false - type: string -address_scope_id_1: - description: | - The address scope. - in: body - required: true - type: string -admin_state_up: - description: | - The administrative state of the firewall, which - is up (``true``) or down (``false``). - in: body - required: false - type: boolean -admin_state_up_1: - description: | - The administrative state of the health monitor. A - valid value is up (``true``) or down (``false``). - in: body - required: false - type: boolean -admin_state_up_10: - description: | - The administrative state of the VIP. A valid - value is up (``true``) or down (``false``). - in: body - required: false - type: boolean -admin_state_up_11: - description: | - The administrative state of the VPN service, - which is up (``true``) or down (``false``). If down, connections - on service are not active. - in: body - required: false - type: boolean -admin_state_up_12: - description: | - The administrative state of the firewall, which - is up (``true``) or down (``false``). - in: body - required: true - type: boolean -admin_state_up_13: - description: | - The administrative state of the health monitor, - which is up (``true``) or down (``false``). - in: body - required: false - type: boolean -admin_state_up_14: - description: | - The administrative state of the IPSec connection, - which is up (``true``) or down (``false``). If down, the - connection does not forward packets. - in: body - required: true - type: boolean -admin_state_up_15: - description: | - The administrative state of the listener, which - is up (``true``) or down (``false``). - in: body - required: true - type: boolean -admin_state_up_16: - description: | - The administrative state of the load balancer, - which is up (``true``) or down (``false``). - in: body - required: true - type: boolean -admin_state_up_17: - description: | - The administrative state of the member. A valid - value is up (``true``) or down (``false``). - in: body - required: true - type: boolean -admin_state_up_18: - description: | - The administrative state of the network, which is - up (``true``) or down (``false``). - in: body - required: true - type: boolean -admin_state_up_19: - description: | - The administrative state of the pool, which is up - (``true``) or down (``false``). - in: body - required: true - type: boolean -admin_state_up_2: - description: | - The administrative state of the IPSec connection, - which is up (``true``) or down (``false``). If down, the - connection does not forward packets. - in: body - required: false - type: boolean -admin_state_up_20: - description: | - The administrative state of the router, which is - up (``true``) or down (``false``). - in: body - required: true - type: boolean -admin_state_up_21: - description: | - The administrative state of the VIP. A valid - value is up (``true``) or down (``false``). - in: body - required: true - type: boolean -admin_state_up_22: - description: | - The administrative state of the VPN service, - which is up (``true``) or down (``false``). If down, the port does - not forward packets. - in: body - required: true - type: boolean -admin_state_up_3: - description: | - 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. - in: body - required: false - type: boolean -admin_state_up_4: - description: | - The administrative state of the load balancer, - which is up (``true``) or down (``false``). - in: body - required: false - type: boolean -admin_state_up_5: - description: | - The administrative state of the member, which is - up (``true``) or down (``false``). - in: body - required: true - type: boolean -admin_state_up_6: - description: | - The administrative state of the member. A valid - value is up (``true``) or down (``false``). - in: body - required: false - type: boolean -admin_state_up_7: - description: | - The administrative state of the network, which is - up (``true``) or down (``false``). - in: body - required: false - type: boolean -admin_state_up_8: - description: | - The administrative state of the pool. A valid - value is up (``true``) or down (``false``). - in: body - required: false - type: boolean -admin_state_up_9: - description: | - The administrative state of the router, which is - up (``true``) or down (``false``). - in: body - required: false - type: boolean -alias: - description: | - The alias for the extension. For example, - "FOXNSOX", "os- availability-zone", "os-extended-quotas", "os- - share-unmanage" or "os-used-limits." - in: body - required: true - type: string -audited: - description: | - Each time that the firewall policy or its - associated rules are changed, the API sets this attribute to - ``false``. To audit the policy, explicitly set this attribute to - ``true``. - in: body - required: false - type: boolean -audited_1: - description: | - Indicates whether the policy has been audited. - Each time that the firewall policy or its associated rules are - changed, the API sets this attribute to ``false``. To audit the - policy, the policy owner must explicitly update the policy to set - this attribute to ``true``. - in: body - required: true - type: boolean -auth_algorithm: - description: | - The authentication hash algorithm. A valid value - is ``sha1``, which is the default. - in: body - required: false - type: string -auth_algorithm_1: - description: | - The authentication algorithm. A valid value is - ``sha1``, which is the default. - in: body - required: false - type: string -auth_algorithm_2: - description: | - The authentication hash algorithm. A valid value - is ``sha1``, which is the default. - in: body - required: true - type: string -auth_algorithm_3: - description: | - The authentication algorithm. A valid value is - ``sha1``, which is the default. - in: body - required: true - type: string -auth_mode: - description: | - The authentication mode. A valid value is - ``psk``, which is the default. - in: body - required: false - type: string -auth_mode_1: - description: | - The authentication mode. A valid value is - ``psk``, which is the default. - in: body - required: true - type: string -availability_zone_hints: - description: | - The availability zone candidate for the network. - in: body - required: true - type: array -availability_zones: - description: | - The availability zone for the network. - in: body - required: true - type: array -bandwidth_limit_rule: - description: | - A ``bandwidth_limit_rule`` object. - in: body - required: true - type: object -bandwidth_limit_rules: - description: | - A list of bandwidth limit rules associated with - the QoS policy. - in: body - required: true - type: array -cidr: - description: | - The CIDR of the subnet. - in: body - required: true - type: string -connection_limit: - description: | - The maximum number of connections permitted for - this load balancer. Default is infinite. - in: body - required: false - type: integer -connection_limit_1: - description: | - The maximum number of connections allowed for the - VIP. Value is ``-1`` if the limit is not set. - in: body - required: false - type: integer -connection_limit_2: - description: | - The maximum number of connections permitted for - this load balancer. Default is infinite. - in: body - required: true - type: integer -connection_limit_3: - description: | - The maximum number of connections allowed for the - VIP. Default is ``-1``, meaning no limit. - in: body - required: true - type: integer -created_at: - description: | - Time at which subnetpool has been created. - in: body - required: true - type: string -default_pool_id: - description: | - The UUID of default pool. Must have compatible - protocol with listener. - in: body - required: false - type: string -default_pool_id_1: - description: | - The UUID of default pool. Must have compatible - protocol with listener. - in: body - required: true - type: string -default_prefixlen: - description: | - The size of the prefix to allocate when the - ``cidr`` or ``prefixlen`` attributes are omitted when you create - the subnet. Default is ``min_prefixlen``. - in: body - required: false - type: integer -default_prefixlen_1: - description: | - The size of the prefix to allocate when the - ``cidr`` or ``prefixlen`` attributes are omitted when you create - the subnet. - in: body - required: true - type: integer -default_quota: - description: | - 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 allocations from the subnet pool. For IPv4 - subnet pools, ``default_quota`` is measured in units of /32. For - IPv6 subnet pools, ``default_quota`` is measured units of /64. All - tenants that use the subnet pool have the same prefix quota - applied. - in: body - required: false - type: integer -default_quota_1: - description: | - A per-tenant quota on the prefix space that can - be allocated from the subnet pool for tenant subnets. For IPv4 - subnet pools, ``default_quota`` is measured in units of /32. For - IPv6 subnet pools, ``default_quota`` is measured units of /64. All - tenants that use the subnet pool have the same prefix quota - applied. - in: body - required: true - type: integer -default_quota_2: - description: | - 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 allocations from the subnet pool. For IPv4 - subnet pools, ``default_quota`` is measured in units of /32. For - IPv6 subnet pools, ``default_quota`` is measured units of /64. All - tenants that use the subnet pool have the same prefix quota - applied. Updating this parameter has no effect on existing subnet - allocations. The existing subnet allocations for each tenant are - counted against the updated prefix space quota. - in: body - required: false - type: integer -default_tls_container_ref: - description: | - A reference to a container of TLS secrets. - in: body - required: false - type: string -default_tls_container_ref_1: - description: | - A reference to a container of TLS secrets. - in: body - required: true - type: string -delay: - description: | - The time, in seconds, between sending probes to - members. - in: body - required: true - type: integer -delay_1: - description: | - The amount of time, in seconds, between sending - probes to members. - in: body - required: true - type: integer -delay_2: - description: | - The amount of time, in seconds, between sending - probes to members. - in: body - required: false - type: integer -description: - description: | - The human-readable description for the firewall - policy. - in: body - required: false - type: string -description_1: - description: | - Human readable description for the firewall rule. - The maximum length is 1024 characters. No default. - in: body - required: false - type: string -description_10: - description: | - The QoS policy description. - in: body - required: false - type: string -description_11: - description: | - Human-readable description for the pool. - in: body - required: false - type: string -description_12: - description: | - The security group description. - in: body - required: false - type: string -description_13: - description: | - Human-readable description for the service - profile. - in: body - required: false - type: string -description_14: - description: | - Human-readable description for the VIP. - in: body - required: false - type: string -description_15: - description: | - Human-readable description for the VPN endpoint - group. - in: body - required: false - type: string -description_16: - description: | - Human-readable description for the VPN service. - in: body - required: false - type: string -description_17: - description: | - The human-readable description for the firewall - policy. - in: body - required: true - type: string -description_18: - description: | - The extension description. - in: body - required: true - type: string -description_19: - description: | - Human readable description for the firewall rule. - in: body - required: true - type: string -description_2: - description: | - Human-readable description for the firewall - service. - in: body - required: false - type: string -description_20: - description: | - The human-readable description for the firewall - service. - in: body - required: true - type: string -description_21: - description: | - Human-readable description for the flavor. - in: body - required: true - type: string -description_22: - description: | - Human-readable description for the IKE policy. - in: body - required: true - type: string -description_23: - description: | - Human-readable description for the IPSec - connection. - in: body - required: true - type: string -description_24: - description: | - Detailed description of the listener. - in: body - required: true - type: string -description_25: - description: | - The load balancer description. - in: body - required: true - type: string -description_26: - description: | - Description for the metering label. - in: body - required: true - type: string -description_27: - description: | - The description of the QoS policy. - in: body - required: true - type: string -description_28: - description: | - The description for the pool. - in: body - required: true - type: string -description_29: - description: | - The security group description. - in: body - required: true - type: string -description_3: - description: | - Human-readable description for the flavor. - in: body - required: false - type: string -description_30: - description: | - Human-readable description for the service - profile. - in: body - required: true - type: string -description_31: - description: | - Human-readable description for the VIP. - in: body - required: true - type: string -description_32: - description: | - Human-readable description for the VPN endpoint - group. - in: body - required: true - type: string -description_33: - description: | - Human-readable description for the VPN service. - in: body - required: true - type: string -description_34: - description: | - New human-readable description for the flavor. - in: body - required: false - type: string -description_35: - description: | - Security group description. - in: body - required: false - type: string -description_4: - description: | - Human-readable description for the IKE policy. - in: body - required: false - type: string -description_5: - description: | - Human-readable description for the IPSec policy. - in: body - required: true - type: string -description_6: - description: | - Human-readable description for the IPSec - connection. - in: body - required: false - type: string -description_7: - description: | - Detailed description of the listener. - in: body - required: false - type: string -description_8: - description: | - The load balancer description. - in: body - required: false - type: string -description_9: - description: | - The description for the metering label. - in: body - required: false - type: string -destination: - description: | - The destination CIDR. - in: body - required: false - type: string -destination_ip_address: - description: | - The destination IPv4 or IPv6 address or CIDR. No - default. - in: body - required: false - type: string -destination_ip_address_1: - description: | - The destination IPv4 or IPv6 address or CIDR. - in: body - required: true - type: string -destination_port: - description: | - The destination port or port range. A valid - value is a port number, as an integer, or a port range, in the - format of a ``:`` separated range. For a port range, include both - ends of the range. For example, ``80:90``. - in: body - required: false - type: string -destination_port_1: - description: | - The destination port or port range. - in: body - required: true - type: string -direction: - description: | - Ingress or egress, which is the direction in - which the metering rule is applied. - in: body - required: true - type: string -direction_1: - description: | - 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. - in: body - required: true - type: string -direction_2: - description: | - 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. - in: body - required: true - type: string -distributed: - description: | - If ``true``, indicates a distributed router. - in: body - required: true - type: boolean -dpd: - description: | - A dictionary with dead peer detection (DPD) - protocol controls. - in: body - required: false - type: object -dpd_1: - description: | - A dictionary with dead peer detection (DPD) - protocol controls. - in: body - required: true - type: object -driver: - description: | - Provider driver to use for this profile. Example: - ``neutron_lbaas.drivers.octavia.driver.OctaviaDriver`` - in: body - required: false - type: string -driver_1: - description: | - Driver to associate with profile. - in: body - required: true - type: string -driver_2: - description: | - Provider driver to use for this profile. Ex: - neutron_lbaas.drivers.octavia.driver.OctaviaDriver. - in: body - required: false - type: string -dscp_mark: - description: | - The DSCP mark value. - in: body - required: false - type: integer -dscp_marking_rule: - description: | - A ``dscp_marking_rule`` object. - in: body - required: true - type: dict -dscp_marking_rules: - description: | - A list of ``dscp_marking_rule`` objects. - in: body - required: true - type: array -enable_snat: - description: | - 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. - in: body - required: false - type: boolean -enable_snat_1: - description: | - Enable Source NAT (SNAT) attribute, a part of - ext-gw-mode extension. When a gateway is attached to a router - using an L3 extension, Network Address Translation (NAT) is - enabled for traffic generated by subnets attached to the router. - in: body - required: true - type: boolean -enabled: - description: | - Set to ``false`` to disable this rule in the - firewall policy. Facilitates selectively turning off rules without - having to disassociate the rule from the firewall policy. Valid - value is ``true`` or ``false``. Default is ``true``. - in: body - required: false - type: boolean -enabled_1: - description: | - Indicates whether this flavor is enabled or - disabled. Default ``true``. - in: body - required: false - type: boolean -enabled_2: - description: | - Indicates whether this service profile is enabled - or disabled. Default ``true``. - in: body - required: false - type: boolean -enabled_3: - description: | - Indicates whether this rule is enabled or - disabled in the firewall policy. - in: body - required: true - type: boolean -enabled_4: - description: | - Indicates whether this flavor is enabled or - disabled. - in: body - required: true - type: boolean -enabled_5: - description: | - Indicates whether this service profile is enabled - or disabled. - in: body - required: true - type: boolean -enabled_6: - description: | - Indicates whether this flavor is enabled or - disabled. - in: body - required: false - type: boolean -enabled_7: - description: | - Indicates whether this service profile is enabled - or disabled. Default true. - in: body - required: false - type: boolean -encapsulation_mode: - description: | - The encapsulation mode. A valid value is - ``tunnel`` or ``transport``. Default is ``tunnel``. - in: body - required: false - type: string -encapsulation_mode_1: - description: | - The encapsulation mode. A valid value is - ``tunnel`` or ``transport``. Default is ``tunnel``. - in: body - required: true - type: string -encryption_algorithm: - description: | - The encryption algorithm. A valid value is - ``3des``, ``aes-128``, ``aes-192``, ``aes-256``, and so on. - Default is ``aes-128``. - in: body - required: false - type: string -encryption_algorithm_1: - description: | - The encryption algorithm. A valid value is - ``3des``, ``aes-128``, ``aes-192``, ``aes-256``, and so on. - Default is ``aes-128``. - in: body - required: true - type: string -endpoints: - description: | - List of endpoints of the same type, for the - endpoint group. The values will depend on type. - in: body - required: true - type: array -endpoints_1: - description: | - A list of endpoints of the same type for the - endpoint group. Theses values depend on the type. - in: body - required: true - type: array -ethertype: - description: | - Must be IPv4 or IPv6, and addresses represented - in CIDR must match the ingress or egress rules. - in: body - required: false - type: string -ethertype_1: - description: | - Must be IPv4 or IPv6, and addresses represented - in CIDR must match the ingress or egress rules. - in: body - required: true - type: string -excluded: - description: | - Indicates whether to count the traffic of a - specific IP address with the ``remote_ip_prefix`` value. Default - is ``false``. - in: body - required: false - type: boolean -'excluded ': - description: | - Indicates whether to count the traffic of a - specific IP address with the ``remote_ip_prefix`` value. Default - is ``false``. - in: body - required: true - type: boolean -expected_codes: - description: | - 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 list, such - as 200, 202. - A range, such as 200-204. - in: body - required: false - type: string -expected_codes_1: - description: | - Expected HTTP codes for a passing HTTP(S) - monitor. - in: body - required: false - type: string -extension: - description: | - A list of ``extension`` object. - in: body - required: true - type: object -external_fixed_ips: - description: | - The IP address parameters. - in: body - required: false - type: array -external_fixed_ips_1: - description: | - The IP address parameters. - in: body - required: true - type: array -external_gateway_info: - description: | - The external gateway parameters, which include - the ``network_id``, ``enable_snat`` and ``external_fixed_ips`` - parameters. - in: body - required: false - type: object -external_gateway_info_1: - description: | - The external gateway parameters, which include - the ``network_id``, ``enable_snat`` and ``external_fixed_ips`` - parameters. - in: body - required: true - type: object -external_v4_ip: - description: | - 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. - in: body - required: true - type: string -external_v6_ip: - description: | - 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. - in: body - required: true - type: string -firewall: - description: | - A ``firewall`` object. - in: body - required: true - type: object -firewall_list: - description: | - A list of the UUIDs for firewall associated with - the firewall policy. - in: body - required: true - type: array -firewall_policies: - description: | - A list of ``firewall_policy`` objects. - in: body - required: true - type: array -firewall_policy: - description: | - A ``firewall_policy`` object. - in: body - required: true - type: object -firewall_policy_id: - description: | - Read-only attribute that the API populates with - the UUID of the firewall policy when you associate this firewall - rule with a policy. You can associate a firewall rule with one - policy at a time. You can update this association can to a - different firewall policy. If you do not associate the rule with - any policy, this attribute is ``null``. - in: body - required: true - type: string -firewall_policy_id_1: - description: | - The UUID of the policy that is associated with - the firewall. - in: body - required: true - type: string -firewall_policy_id_3: - description: | - The UUID of the policy that is associated with - the firewall. - in: body - required: false - type: string -firewall_rule: - description: | - A ``firewall_rule`` object. - in: body - required: true - type: object -firewall_rule_id_1: - description: | - The UUID of the firewall rule. - in: body - required: true - type: string -firewall_rules: - description: | - A list of the UUIDs for firewall rule associated - with the firewall policy. - in: body - required: true - type: array -firewall_rules_id: - description: | - A list of rules to associate with the firewall - policy. - in: body - required: false - type: array -firewalls: - description: | - A list of ``firewall_rule`` objects. - in: body - required: true - type: array -firewalls_1: - description: | - A list of ``firewall`` objects. - in: body - required: true - type: array -fixed_ip_address: - description: | - 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. - in: body - required: false - type: string -fixed_ip_address_1: - description: | - The fixed IP address that is associated with the - floating IP address. - in: body - required: true - type: string -flavor: - description: | - A ``flavor`` object. - in: body - required: true - type: object -flavor_1: - description: | - The UUID of a flavor. - in: body - required: false - type: string -flavor_2: - description: | - The UUID of a flavor if set. - in: body - required: false - type: string -flavors: - description: | - A list of ``flavor`` objects. - in: body - required: true - type: array -floating_ip_address: - description: | - The floating IP address. - in: body - required: false - type: string -floating_ip_address_1: - description: | - The floating IP address. - in: body - required: true - type: string -floating_network_id: - description: | - The UUID of the network associated with the - floating IP. - in: body - required: true - type: string -floatingip: - description: | - 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. - in: body - required: true - type: object -floatingip_1: - description: | - The number of floating IP addresses allowed for - each tenant. A value of ``-1`` means no limit. - in: body - required: true - type: integer -floatingip_2: - description: | - The number of floating IP addresses allowed for - each tenant. A value of ``-1`` means no limit. - in: body - required: false - type: integer -floatingips: - description: | - A list of ``floatingip`` objects. - in: body - required: true - type: array -ha: - description: | - If ``true``, indicates a highly-available router. - in: body - required: true - type: boolean -health_monitor: - description: | - A ``health_monitor`` object. - in: body - required: true - type: object -health_monitors: - description: | - List of health monitors that are associated with - the pool. - in: body - required: false - type: array -health_monitors_1: - description: | - A list of ``health_monitor`` objects. - in: body - required: true - type: array -health_monitors_2: - description: | - The UUID for the associated health monitor. - in: body - required: true - type: string -health_monitors_status: - description: | - The statuses of the health monitors that are - associated with the pool. - in: body - required: true - type: string -healthmonitor: - description: | - The associated healthmonitor, if any. - in: body - required: true - type: object -healthmonitor_id: - description: | - The UUID of the health monitor. - in: body - required: false - type: string -http_method: - description: | - The HTTP method that the monitor uses for - requests. - in: body - required: false - type: string -id: - description: | - The UUID of the router. - in: body - required: true - type: string -id_1: - description: | - The UUID of the service profile. - in: body - required: true - type: string -id_10: - description: | - The UUID for the IPSec policy. - in: body - required: true - type: string -id_11: - description: | - The UUID for the IPSec connection. - in: body - required: true - type: string -id_12: - description: | - The UUID of the listener. - in: body - required: true - type: string -id_13: - description: | - The UUID for the load balancer. - in: body - required: true - type: string -id_14: - description: | - The UUID for the member. - in: body - required: true - type: string -id_15: - description: | - The UUID for the metering label rule. - in: body - required: true - type: string -id_16: - description: | - The UUID of the metering label. - in: body - required: true - type: string -id_17: - description: | - The UUID of the network. - in: body - required: true - type: string -id_18: - description: | - The generated UUID of the QoS policy. - in: body - required: true - type: string -id_19: - description: | - The UUID for the pool. - in: body - required: true - type: string -id_2: - description: | - The UUID for the health monitor. - in: body - required: true - type: string -id_20: - description: | - The UUID of the security group rule. - in: body - required: true - type: string -id_21: - description: | - The UUID of the subnet pool. - in: body - required: true - type: string -id_22: - description: | - The UUID for the VIP. - in: body - required: true - type: string -id_23: - description: | - The UUID for the VPN endpoint group. - in: body - required: true - type: string -id_24: - description: | - The UUID for the VPN service. - in: body - required: true - type: string -id_25: - description: | - The UUID of network. - in: body - required: true - type: string -id_26: - description: | - The UUID of the security group. - in: body - required: true - type: string -id_3: - description: | - The UUID of the QoS policy rule. - in: body - required: true - type: string -id_4: - description: | - The UUID for the firewall policy. - in: body - required: true - type: string -id_5: - description: | - The generated UUID for the firewall rule object. - in: body - required: true - type: string -id_6: - description: | - The UUID for the firewall service. - in: body - required: true - type: string -id_7: - description: | - The UUID of the flavor. - in: body - required: true - type: string -id_8: - description: | - The UUID of the floating IP address. - in: body - required: true - type: string -id_9: - description: | - The UUID for the IKE policy. - in: body - required: true - type: string -ike_version: - description: | - The IKE version. A valid value is ``v1`` or - ``v2``. Default is ``v1``. - in: body - required: false - type: string -ike_version_1: - description: | - The IKE version. A valid value is ``v1`` or - ``v2``. Default is ``v1``. - in: body - required: true - type: string -ikepolicies: - description: | - A list of IKE policy objects. - in: body - required: true - type: array -ikepolicy: - description: | - An ``ikepolicy`` object. - in: body - required: true - type: object -ikepolicy_id: - description: | - The UUID of the IKE policy. - in: body - required: true - type: string -initiator: - description: | - 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``. - in: body - required: false - type: string -initiator_1: - description: | - 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``. - in: body - required: true - type: string -insert_after: - description: | - The UUID of the firewall_rule. A new - firewall_rule will be inserted after this firewall_rule. - in: body - required: false - type: string -insert_before: - description: | - The UUID of the firewall_rule. A new - firewall_rule will be inserted before this firewall_rule. - in: body - required: false - type: string -interval: - description: | - The dead peer detection (DPD) interval, in - seconds. A valid value is a positive integer. Default is 30. - in: body - required: false - type: integer -interval_1: - description: | - The dead peer detection (DPD) interval, in - seconds. A valid value is a positive integer. Default is 30. - in: body - required: true - type: integer -ip_version: - description: | - The IP protocol version. Valid value is ``4`` or - ``6``. Default is ``4``. - in: body - required: false - type: integer -ip_version_1: - description: | - The IP address family of the list of prefixes - passed to the ``prefixes`` attribute. - in: body - required: true - type: integer -ip_version_2: - description: | - The IP protocol version. Value is ``4`` or ``6``. - in: body - required: true - type: integer -ip_version_3: - description: | - The IP version (4 or 6) of the subnet. - in: body - required: true - type: integer -ipsec_site_connection: - description: | - An ``ipsec_site_connection`` object. - in: body - required: true - type: object -ipsecpolicies: - description: | - A list of IPSec policy objects. - in: body - required: true - type: array -ipsecpolicy: - description: | - An ``ipsecpolicy`` object. - in: body - required: true - type: object -ipsecpolicy_id: - description: | - The UUID of the IPSec policy. - in: body - required: true - type: string -lb_algorithm: - description: | - 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. - in: body - required: true - type: string -lb_method: - description: | - 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. - in: body - required: true - type: string -lb_method_1: - description: | - 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. - in: body - required: false - type: string -lifetime: - description: | - 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. - in: body - required: false - type: object -lifetime_1: - description: | - 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. - in: body - required: false - type: object -lifetime_2: - description: | - 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. - in: body - required: true - type: object -links: - description: | - The share links. - in: body - required: true - type: array -listener: - description: | - A ``listener`` object. - in: body - required: true - type: object -listener_id: - description: | - The UUID of the listener. - in: body - required: false - type: string -listeners: - description: | - The associated listeners, if any. - in: body - required: true - type: array -listeners_1: - description: | - A ``listeners`` object. - in: body - required: true - type: array -loadbalancer: - description: | - A ``loadbalancer`` object. - in: body - required: true - type: object -loadbalancer_id: - description: | - The UUID of the load balancer. - in: body - required: true - type: string -loadbalancers: - description: | - A list of load balancer objects. - in: body - required: true - type: array -local_ep_group_id: - description: | - The UUID for the endpoint group that contains - private subnets for the local side of the connection. Yo must - specify this parameter with the ``peer_ep_group_id`` parameter - unless in backward- compatible mode where ``peer_cidrs`` is - provided with a ``subnet_id`` for the VPN service. - in: body - required: false - type: string -local_ep_group_id_1: - description: | - 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. - in: body - required: true - type: string -max_burst_kbps: - description: | - The burst over the maximum KBPS value. Default is - ``0`` - in: body - required: false - type: integer -max_burst_kbps_1: - description: | - The burst over the maximum KBPS value. - in: body - required: true - type: integer -max_kbps: - description: | - The maximum KBPS value. If you specify this - value, must be greater than 0. Default is ``null``. - in: body - required: false - type: integer -max_kbps_1: - description: | - The maximum KBPS value. - in: body - required: true - type: integer -max_prefixlen: - description: | - 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``. - in: body - required: false - type: integer -max_prefixlen_1: - description: | - The maximum prefix size that can be allocated - from the subnet pool. - in: body - required: true - type: integer -max_retries: - description: | - The number of allowed connection failures before - changing the status of the member to ``INACTIVE``. A valid value - is from 1 to 10. - in: body - required: true - type: integer -member: - description: | - A ``member`` object. - in: body - required: true - type: object -members: - description: | - The list of members that belong to the pool. - in: body - required: true - type: array -members_1: - description: | - A list of ``member`` objects. - in: body - required: true - type: array -members_2: - description: | - The associated members, if any. - in: body - required: true - type: array -metainfo: - description: | - JSON-formatted meta information. - in: body - required: false - type: string -metainfo_1: - description: | - JSON metainfo to associate with profile. - in: body - required: true - type: string -metering_label: - description: | - A ``metering_label`` object. - in: body - required: true - type: object -metering_label_id: - description: | - The metering label UUID to associate with this - metering rule. - in: body - required: true - type: string -metering_label_rule: - description: | - A ``metering_label_rule`` object. - in: body - required: true - type: object -metering_label_rules: - description: | - A list of ``metering_label_rule`` objects. - in: body - required: true - type: array -metering_labels: - description: | - A list of ``metering_label`` objects. - in: body - required: true - type: array -min_prefixlen: - description: | - The smallest prefix that can be allocated from a - subnet pool. For IPv4 subnet pools, default is ``8``. For IPv6 - subnet pools, default is ``64``. - in: body - required: false - type: integer -min_prefixlen_1: - description: | - The smallest prefix that can be allocated from a - subnet pool. - in: body - required: true - type: integer -mtu: - description: | - The maximum transmission unit (MTU) value to - address fragmentation. Minimum value is 68 for IPv4, and 1280 for - IPv6. - in: body - required: false - type: integer -mtu_1: - description: | - The MTU of a network resource. - in: body - required: true - type: integer -mtu_2: - description: | - The maximum transmission unit (MTU) to address - fragmentation. The minimum value for IPv4 is 68. The minimum value - for IPv6 is 1280. - in: body - required: true - type: integer -name: - description: | - Human-readable name for the firewall policy. Does - not have to be unique. - in: body - required: false - type: string -name_1: - description: | - Human readable name for the firewall rule. - Maximum length is 255 characters. Does not have to be unique. No - default. - in: body - required: false - type: string -name_10: - description: | - The network name. - in: body - required: false - type: string -name_11: - description: | - The QoS policy name. - in: body - required: false - type: string -name_12: - description: | - The pool name. Does not have to be unique. - in: body - required: false - type: string -name_13: - description: | - The router name. - in: body - required: false - type: string -name_14: - description: | - A symbolic name for the security group. Does not - have to be unique. - in: body - required: true - type: string -name_15: - description: | - A name for the subnet pool. - in: body - required: true - type: string -name_16: - description: | - Human-readable name for the VIP. Does not have to - be unique. - in: body - required: false - type: string -name_17: - description: | - Human-readable name for the VPN endpoint group. - Does not have to be unique. - in: body - required: false - type: string -name_18: - description: | - Human-readable name for the VPN service. Does not - have to be unique. - in: body - required: false - type: string -name_19: - description: | - Human-readable name for the firewall policy. Does - not have to be unique. - in: body - required: true - type: string -name_2: - description: | - The human-readable name for the firewall service. - Does not have to be unique. - in: body - required: false - type: string -name_20: - description: | - The name of the extension. For example, "Fox In - Socks." - in: body - required: true - type: string -name_21: - description: | - Human readable name for the firewall rule. - in: body - required: true - type: string -name_22: - description: | - Human-readable name for the firewall service. - Does not have to be unique. - in: body - required: true - type: string -name_23: - description: | - Human-readable name for the flavor. Can be "" and - non-unique. - in: body - required: true - type: string -name_24: - description: | - Human-readable name for the IKE policy. Does not - have to be unique. - in: body - required: true - type: string -name_25: - description: | - Human-readable name for the IPSec connection. - Does not have to be unique. - in: body - required: true - type: string -name_26: - description: | - The load balancer name. - in: body - required: true - type: string -name_27: - description: | - The network name. - in: body - required: true - type: string -name_28: - description: | - The name of the subnet. - in: body - required: true - type: string -name_29: - description: | - The name of the QoS policy. - in: body - required: true - type: string -name_3: - description: | - Human-readable name for the flavor. Can be "" and - non-unique. - in: body - required: false - type: string -name_30: - description: | - The pool name. Does not have to be unique. - in: body - required: true - type: string -name_31: - description: | - The router name. - in: body - required: true - type: string -name_32: - description: | - The security group name. - in: body - required: true - type: string -name_33: - description: | - The subnet pool name. - in: body - required: true - type: string -name_34: - description: | - Human-readable name for the VIP. Does not have to - be unique. - in: body - required: true - type: string -name_35: - description: | - Human-readable name for the VPN endpoint group. - Does not have to be unique. - in: body - required: true - type: string -name_36: - description: | - Human-readable name for the VPN service. Does not - have to be unique. - in: body - required: true - type: string -name_37: - description: | - New human-readable name for the flavor. Can be "" - and non-unique. - in: body - required: false - type: string -name_38: - description: | - Human-readable name for the pool. Does not have - to be unique. - in: body - required: false - type: string -name_4: - description: | - Human-readable name for the IKE policy. Does not - have to be unique. - in: body - required: false - type: string -name_5: - description: | - Human-readable name for the IPSec policy. Does - not have to be unique. - in: body - required: true - type: string -name_6: - description: | - Human-readable name for the IPSec connection. - Does not have to be unique. - in: body - required: false - type: string -name_7: - description: | - The listener name. - in: body - required: true - type: string -name_8: - description: | - The load balancer name. Does not have to be - unique. - in: body - required: false - type: string -name_9: - description: | - The name of the metering label. - in: body - required: true - type: string -network: - description: | - A ``network`` object. - in: body - required: true - type: object -network_1: - description: | - The number of networks allowed for each tenant. - in: body - required: true - type: integer -network_2: - description: | - The number of networks allowed for each tenant. - in: body - required: false - type: integer -network_ip_availabilities: - description: | - The ``network_ip_availabilities`` object. - in: body - required: true - type: array -network_ip_availability: - description: | - A ``network_ip_availability`` object. - in: body - required: true - type: dict -network_name: - description: | - The name of the network. - in: body - required: true - type: string -networks: - description: | - A list of ``network`` objects. - in: body - required: true - type: array -nexthop: - description: | - The IP address of the next hop. - in: body - required: false - type: string -operating_status: - description: | - The operating status of the load balancer. This - value is ``ONLINE`` or ``OFFLINE``. - in: body - required: true - type: string -peer_address: - description: | - The peer gateway public IPv4 or IPv6 address or - FQDN. - in: body - required: true - type: string -peer_address_1: - description: | - The peer gateway public IPv4 address, IPv6 - address, or FQDN. - in: body - required: true - type: string -peer_cidrs: - description: | - (Deprecated) Unique list of valid peer private - CIDRs in the form < net_address > / < prefix > . - in: body - required: false - type: array -peer_cidrs_1: - description: | - (Deprecated) Unique list of valid peer private - CIDRs in the form < net_address > / < prefix > . - in: body - required: true - type: array -peer_ep_group_id: - description: | - The UUID for the endpoint group that contains - private CIDRs in the form < net_address > / < prefix > for the - peer side of the connection. You must specify this parameter with - the ``local_ep_group_id`` parameter unless in backward-compatible - mode where ``peer_cidrs`` is provided with a ``subnet_id`` for the - VPN service. - in: body - required: false - type: string -peer_ep_group_id_1: - description: | - 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 shown. - in: body - required: true - type: string -peer_id: - description: | - 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. - in: body - required: true - type: string -peer_id_1: - description: | - 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. - in: body - required: true - type: string -pfs: - description: | - Perfect forward secrecy (PFS). A valid value is - ``Group2``, ``Group5``, ``Group14``, and so on. Default is - ``Group5``. - in: body - required: false - type: string -pfs_1: - description: | - Perfect forward secrecy (PFS). A valid value is - ``Group2``, ``Group5``, ``Group14``, and so on. Default is - ``Group5``. - in: body - required: true - type: string -phase1_negotiation_mode: - description: | - The IKE mode. A valid value is ``main``, which is - the default. - in: body - required: false - type: string -phase1_negotiation_mode_1: - description: | - The IKE mode. A valid value is ``main``, which is - the default. - in: body - required: true - type: string -policies: - description: | - A list of QoS ``policy`` objects. - in: body - required: true - type: array -policy: - description: | - A QoS ``policy`` object. - in: body - required: true - type: object -policy_id_1: - description: | - The UUID of the QoS policy that is associated - with the rule. - in: body - required: true - type: string -pool: - description: | - A ``pool`` object. - in: body - required: true - type: object -pool_id_1: - description: | - The UUID of the pool to which the member belongs. - in: body - required: true - type: string -pool_id_2: - description: | - The UUID of the pool with which the VIP is - associated. - in: body - required: true - type: string -pool_id_3: - description: | - The UUID of the pool to which the member belongs. - in: body - required: false - type: string -pool_id_4: - description: | - The UUID of the pool with which the VIP is - associated. - in: body - required: false - type: string -pools: - description: | - List of pools that are associated with the health - monitor. - in: body - required: true - type: array -pools_1: - description: | - A list of ``pool`` objects. - in: body - required: true - type: array -pools_2: - description: | - The associated pools, if any. - in: body - required: true - type: array -port: - description: | - The number of ports allowed for each tenant. - in: body - required: true - type: integer -port_1: - description: | - The number of ports allowed for each tenant. - in: body - required: false - type: integer -port_id: - description: | - The UUID of the port. - in: body - required: true - type: string -port_id_1: - description: | - The UUID of the port. - in: body - required: false - type: string -port_id_2: - description: | - The UUID of the VIP port. - in: body - required: true - type: string -port_range_max: - description: | - 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. - in: body - required: false - type: integer -port_range_max_1: - description: | - 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. - in: body - required: true - type: integer -port_range_min: - description: | - 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. - in: body - required: false - type: integer -port_range_min_1: - description: | - 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. - in: body - required: true - type: integer -port_security_enabled: - description: | - The port security status. A valid value is - enabled (``true``) or disabled (``false``). - in: body - required: false - type: boolean -port_security_enabled_1: - description: | - The port security status. A valid value is - enabled (``true``) or disabled (``false``). - in: body - required: true - type: boolean -position: - description: | - Read-only attribute that the API assigns to this - rule when it associates it with a firewall policy. This value - indicates the position of this rule in that firewall policy. This - position number starts at 1. If the firewall rule is not - associated with any policy, the position is ``null``. - in: body - required: true - type: integer -prefixes: - description: | - A list of subnet prefixes to assign to the subnet - pool. The API merges adjacent prefixes and treats them as a single - prefix. Each subnet prefix must be unique among all subnet - prefixes in all subnet pools that are associated with the address - scope. - in: body - required: true - type: array -prefixes_1: - description: | - A list of subnet prefixes that are assigned to - the subnet pool. The API merges adjacent prefixes and treats them - as a single prefix. - in: body - required: true - type: array -prefixes_2: - description: | - A list of subnet prefixes to assign to the subnet - pool. The API merges adjacent prefixes and treats them as a single - prefix. To update the subnet prefixes, pass a list that contains - the existing set of prefixes and the new set of prefixes. You - cannot shrink the prefix list of a subnet pool. You can only add - prefixes to it to expand it. Ensure that each subnet prefix is - unique among all subnet prefixes in all subnet pools that are - associated with the address scope. - in: body - required: true - type: array -protocol: - description: | - The IP protocol. Valid value is ``icmp``, - ``tcp``, ``udp``, or ``null``. No default. - in: body - required: false - type: string -protocol_1: - description: | - The protocol to load balance. A valid value is - ``HTTP``, ``HTTPS``, ``TCP``, or ``TERMINATED_HTTPS``. - in: body - required: true - type: string -protocol_2: - description: | - The protocol of the pool, which is ``TCP``, - ``HTTP``, or ``HTTPS``. - in: body - required: true - type: string -protocol_3: - description: | - The protocol that is matched by the security - group rule. Valid values are null, tcp, udp, and icmp. - in: body - required: false - type: string -protocol_4: - description: | - The protocol that is matched by the security - group rule. Value is ``null``, ``icmp``, ``icmpv6``, ``tcp``, or - ``udp``. - in: body - required: true - type: string -protocol_5: - description: | - The protocol of the virtual IP (VIP) address. A - valid value is ``TCP``, ``HTTP``, or ``HTTPS``. - in: body - required: true - type: string -protocol_6: - description: | - The IP protocol. Value is ``icmp``, ``tcp``, - ``udp``, or ``null``. - in: body - required: true - type: string -protocol_port: - description: | - The TCP or UDP port on which to listen. - in: body - required: true - type: integer -protocol_port_1: - description: | - The port where the application is hosted. - in: body - required: true - type: integer -protocol_port_2: - description: | - 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. - in: body - required: true - type: integer -provider: - description: | - The name of the provider. - in: body - required: false - type: string -provider:network_type: - description: | - The type of physical network that maps to this - network resource. For example, ``flat``, ``vlan``, ``vxlan``, or - ``gre``. - in: body - required: false - type: string -provider:physical_network: - description: | - 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. - in: body - required: false - type: string -provider:segmentation_id: - description: | - 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. - in: body - required: false - type: string -provider_1: - description: | - The load-balancer provider. - in: body - required: true - type: string -provider_2: - description: | - The name of the provider. - in: body - required: true - type: string -provisioning_status: - description: | - The provisioning status of the load balancer. - This value is ``ACTIVE``, ``PENDING_CREATE`` or ``ERROR``. - in: body - required: true - type: string -psk: - description: | - The pre-shared key. A valid value is any string. - in: body - required: true - type: string -quota: - description: | - A ``quota`` object. - in: body - required: true - type: object -quotas: - description: | - A list of quota objects. - in: body - required: true - type: array -rbac_policy: - description: | - The number of role-based access control (RBAC) - policies for each tenant. - in: body - required: true - type: integer -rbac_policy_1: - description: | - The number of role-based access control (RBAC) - policies for each tenant. - in: body - required: false - type: integer -remote_group_id: - description: | - The remote group UUID to associate with this - security group rule. You can specify either the - ``remote_group_id`` or ``remote_ip_prefix`` attribute in the - request body. - in: body - required: false - type: string -remote_group_id_1: - description: | - The remote group UUID to associate with this - security group rule. You can specify either the - ``remote_group_id`` or ``remote_ip_prefix`` attribute in the - request body. - in: body - required: true - type: string -remote_ip_prefix: - description: | - The remote IP prefix to associate with this - metering rule packet. - in: body - required: true - type: string -remote_ip_prefix_1: - description: | - The remote IP prefix to associate 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 IP prefix as the source - IP address of the IP packet. - in: body - required: false - type: string -remote_ip_prefix_2: - description: | - The remote IP prefix to associate 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 IP prefix as the - source IP address of the IP packet. - in: body - required: true - type: string -route_mode: - description: | - The route mode. A valid value is ``static``, - which is the default. - in: body - required: false - type: string -route_mode_1: - description: | - The route mode. A valid value is ``static``, - which is the default. - in: body - required: true - type: string -router: - description: | - A ``router`` object. - in: body - required: true - type: object -router:external: - description: | - Indicates whether this network is externally - accessible. - in: body - required: false - type: boolean -router:external_1: - description: | - Indicates whether this network is externally - accessible. - in: body - required: true - type: boolean -router_1: - description: | - The number of routers allowed for each tenant. - in: body - required: true - type: integer -router_2: - description: | - The number of routers allowed for each tenant. - in: body - required: false - type: integer -router_id_1: - description: | - The UUID of the router. - in: body - required: true - type: string -router_id_2: - description: | - The UUID of the router to which the VPN service - is inserted. - in: body - required: true - type: string -router_id_3: - description: | - The UUID of the router into which the VPN service - is inserted. - in: body - required: true - type: string -router_ids: - description: | - A list of UUIDs for routers that are associated - with the firewall. - in: body - required: false - type: array -router_ids_1: - description: | - A list of UUIDs for routers that are associated - with the firewall. - in: body - required: true - type: array -routers: - description: | - A list of ``router`` objects. - in: body - required: true - type: array -routes: - description: | - The extra routes configuration for L3 router. - in: body - required: true - type: array -routes_1: - description: | - A list of dictionary pairs in this format: - - :: - - [ - { - "nexthop":"IPADDRESS", - "destination":"CIDR" - } - ] - in: body - required: false - type: object -security_group: - description: | - A ``security_group`` object. - in: body - required: true - type: object -security_group_1: - description: | - The number of security groups allowed for each - tenant. - in: body - required: true - type: integer -security_group_2: - description: | - The number of security groups allowed for each - tenant. - in: body - required: false - type: integer -security_group_id: - description: | - The security group UUID to associate with this - security group rule. - in: body - required: true - type: string -security_group_id_1: - description: | - The UUID of the security group. - in: body - required: true - type: string -security_group_rule: - description: | - A ``security_group_rule`` object. - in: body - required: true - type: object -security_group_rule_1: - description: | - The number of security group rules allowed for - each tenant. - in: body - required: true - type: integer -security_group_rule_2: - description: | - The number of security group rules allowed for - each tenant. - in: body - required: false - type: integer -security_group_rules: - description: | - A list of ``security_group_rule`` objects. - in: body - required: true - type: array -security_groups: - description: | - A list of ``security_group`` objects. - in: body - required: true - type: array -segments: - description: | - A list of provider ``segment`` objects. - in: body - required: true - type: array -service_profile: - description: | - A ``service_profile`` object. - in: body - required: true - type: object -service_profiles: - description: | - Service profile UUIDs associated with this - flavor. - in: body - required: true - type: array -service_profiles_1: - description: | - A list of ``service_profile`` objects. - in: body - required: true - type: array -service_type: - description: | - Service type (ex: LOADBALANCERV2) for the flavor. - in: body - required: true - type: string -session_persistence: - description: | - The session persistence algorithm. This algorithm - is a dictionary with type and cookie_name keys. - in: body - required: false - type: object -session_persistence_1: - description: | - 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. - in: body - required: false - type: object -session_persistence_2: - description: | - 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. - in: body - required: true - type: object -session_persistence_3: - description: | - 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. - in: body - required: false - type: object -shared: - description: | - Set to ``true`` to make this firewall policy - visible to other tenants. Default is ``false``. - in: body - required: false - type: boolean -shared_1: - description: | - Set to ``true`` to share this firewall rule with - other tenants. Other tenants can use a shared rule in firewall - policies that this tenant does not own. Valid value is ``true`` or - ``false``. Default is ``false``. - in: body - required: false - type: boolean -shared_10: - description: | - Indicates whether this policy is shared across - all tenants. - in: body - required: true - type: boolean -shared_11: - description: | - Indicates whether this subnet pool is shared - across all tenants. - in: body - required: true - type: boolean -shared_2: - description: | - Indicates whether this metering label is shared - across all tenants. - in: body - required: false - type: boolean -shared_3: - description: | - Admin-only. Indicates whether this network is - shared across all tenants. - in: body - required: false - type: boolean -shared_4: - description: | - Set to ``true`` to share this policy with other - tenants. Default is ``false``. - in: body - required: false - type: boolean -shared_5: - description: | - Admin-only. Indicates whether this subnet pool is - shared across all tenants. - in: body - required: false - type: boolean -shared_6: - description: | - Indicates whether the firewall policy is shared - across all tenants. - in: body - required: true - type: boolean -shared_7: - description: | - Indicates whether this firewall rule is shared - with other tenants. Other tenants can use a shared rule in - firewall policies that this tenant does not own. - in: body - required: true - type: boolean -shared_8: - description: | - Indicates whether this metering label is shared - across all tenants. - in: body - required: true - type: boolean -shared_9: - description: | - Indicates whether this network is shared across - all tenants. - in: body - required: true - type: boolean -sni_container_refs: - description: | - A list of references to TLS secrets. - in: body - required: false - type: array -sni_container_refs_1: - description: | - A list of references to TLS secrets. - in: body - required: true - type: array -source_ip_address: - description: | - The source IPv4 or IPv6 address or CIDR. - in: body - required: true - type: string -source_port: - description: | - The source port or port range. A valid value is - a port number, as an integer, or a port range, in the format of a - ``:`` separated range. For a port range, include both ends of the - range. For example, ``80:90``. - in: body - required: false - type: string -source_port_1: - description: | - The source port or port range. - in: body - required: true - type: string -status: - description: | - The status of the firewall service. Value is - ``ACTIVE``, ``INACTIVE``, ``ERROR``, ``PENDING_CREATE``, - ``PENDING_UPDATE``, or ``PENDING_DELETE``. - in: body - required: true - type: string -status_1: - description: | - The status of the floating IP address. - in: body - required: true - type: string -status_2: - description: | - The operational status of the IPSec connection. - Value is ``ACTIVE``, ``DOWN``, ``BUILD``, ``ERROR``, - ``PENDING_CREATE``, ``PENDING_UPDATE``, or ``PENDING_DELETE``. - in: body - required: false - type: string -status_3: - description: | - The status of the member. Indicates whether the - member is operational. - in: body - required: true - type: string -status_4: - description: | - The network status. - in: body - required: true - type: string -status_5: - description: | - The status of the pool. Indicates whether the - pool is operational. - in: body - required: true - type: string -status_6: - description: | - The status of the VIP. Indicates whether the VIP - is operational. - in: body - required: true - type: string -status_7: - description: | - Indicates whether IPSec VPN service is currently - operational. Value is ``ACTIVE``, ``DOWN``, ``BUILD``, ``ERROR``, - ``PENDING_CREATE``, ``PENDING_UPDATE``, or ``PENDING_DELETE``. - in: body - required: true - type: string -status_8: - description: | - Indicates whether the IPSec connection is - currently operational. Value is ``ACTIVE``, ``DOWN``, ``BUILD``, - ``ERROR``, ``PENDING_CREATE``, ``PENDING_UPDATE``, or - ``PENDING_DELETE``. - in: body - required: true - type: string -status_description: - description: | - Human-readable description of the status. - in: body - required: true - type: string -subnet: - description: | - The number of subnets allowed for each tenant. - in: body - required: true - type: integer -subnet_1: - description: | - The number of subnets allowed for each tenant. - in: body - required: false - type: integer -subnet_id: - description: | - The UUID of the subnet. - in: body - required: true - type: string -subnet_id_1: - description: | - If you omit this parameter, LBaaS uses the - ``vip_subnet_id`` parameter value for the subnet UUID. - in: body - required: false - type: integer -subnet_id_2: - description: | - The UUID of the subnet on which to allocate the - virtual IP (VIP) address. - in: body - required: true - type: string -subnet_id_3: - description: | - (Deprecated) The subnet where the tenant wants - the VPN service. - in: body - required: false - type: string -subnet_id_4: - description: | - (Deprecated) The subnet where the tenant wants - the VPN service. - in: body - required: true - type: string -subnet_ip_availability: - description: | - This is dictionary showing subnet IP - availability. It contains information for every subnet associated - to each network as described in the parameters. - in: body - required: true - type: array -subnet_name: - description: | - The name of the subnet. - in: body - required: true - type: string -subnetpool: - description: | - A ``subnetpool`` object. - in: body - required: true - type: object -subnetpool_1: - description: | - The number of subnet pools allowed for each - tenant. - in: body - required: true - type: integer -subnetpool_2: - description: | - The number of subnet pools allowed for each - tenant. - in: body - required: false - type: integer -subnetpools: - description: | - A list of ``subnetpool`` objects. - in: body - required: true - type: array -subnets: - description: | - The associated subnets. - in: body - required: true - type: array -tags: - description: | - The list of tags on the resource. - in: body - required: true - type: array -tenant_id: - description: | - The UUID of the tenant. - in: body - required: true - type: string -tenant_id_1: - description: | - The owner of the firewall policy. Only - administrative users can specify a tenant UUID other than their - own. - in: body - required: false - type: string -tenant_id_10: - description: | - The UUID of the tenant who owns the load - balancer. Only administrative users can specify a tenant UUID - other than their own. - in: body - required: true - type: string -tenant_id_11: - description: | - The UUID of the tenant who owns the member. Only - administrative users can specify a tenant UUID other than their - own. - in: body - required: true - type: string -tenant_id_12: - description: | - The UUID of the tenant who owns the member. Only - administrative users can specify a tenant UUID other than their - own. - in: body - required: false - type: string -tenant_id_13: - description: | - The tenant UUID for the metering label. - in: body - required: true - type: string -tenant_id_14: - description: | - 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. - in: body - required: false - type: string -tenant_id_15: - description: | - The tenant UUID of QoS policy owner. Only - administrative users can specify a tenant UUID other than their - own. You cannot change this value through authorization policies. - in: body - required: false - type: string -tenant_id_16: - description: | - The UUID of the tenant who owns the pool. Only - administrative users can specify a tenant UUID other than their - own. - in: body - required: false - type: string -tenant_id_17: - description: | - The UUID of the tenant who owns the security - group rule. Only administrative users can specify a tenant UUID - other than their own. - in: body - required: true - type: string -tenant_id_18: - description: | - The UUID of the tenant who owns the security - group. Only administrative users can specify a tenant UUID other - than their own. - in: body - required: false - type: string -tenant_id_19: - description: | - 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. - in: body - required: false - type: string -tenant_id_2: - description: | - The UUID of the tenant who owns the firewall - rule. Only administrative users can specify a tenant UUID other - than their own. - in: body - required: true - type: string -tenant_id_20: - description: | - The UUID of the tenant who owns the VIP. Only - administrative users can specify a tenant UUID other than their - own. - in: body - required: false - type: string -tenant_id_21: - description: | - Owner of the VPN endpoint group. Only - administrative users can specify a tenant UUID other than their - own. - in: body - required: true - type: string -tenant_id_22: - description: | - Owner of the VPN service. Only administrative - users can specify a tenant UUID other than their own. - in: body - required: false - type: string -tenant_id_23: - description: | - The UUID of the tenant who owns the firewall - policy. - in: body - required: true - type: string -tenant_id_24: - description: | - The UUID of the tenant who owns the firewall - rule. - in: body - required: true - type: string -tenant_id_25: - description: | - The UUID of the tenant who owns the health - monitor. Only administrative users can specify a tenant UUID other - than their own. - in: body - required: true - type: string -tenant_id_26: - description: | - The owner of the VPN service. Only administrative - users can specify a tenant UUID other than their own. - in: body - required: true - type: string -tenant_id_27: - description: | - Owner of the VPN service. Only administrative - users can specify a tenant UUID other than their own. - in: body - required: true - type: string -tenant_id_28: - description: | - The UUID of the tenant who owns the VIP. Only - administrative users can specify a tenant UUID other than their - own. - in: body - required: true - type: string -tenant_id_29: - description: | - The UUID of the tenant who owns the network. - in: body - required: true - type: string -tenant_id_3: - description: | - The owner of the firewall service. Only - administrative users can specify a tenant UUID other than their - own. - in: body - required: true - type: string -tenant_id_30: - description: | - The UUID of tenant or project. - in: body - required: true - type: string -tenant_id_31: - description: | - The UUID of the tenant who owns the QoS policy. - in: body - required: true - type: string -tenant_id_32: - description: | - The UUID of the tenant who owns the pool. Only - administrative users can specify a tenant UUID other than their - own. - in: body - required: true - type: string -tenant_id_34: - description: | - The UUID of the tenant who owns the subnet pool. - in: body - required: true - type: string -tenant_id_4: - description: | - The UUID of the tenant. Only administrative users - can specify a tenant UUID other than their own. - in: body - required: false - type: string -tenant_id_5: - description: | - The UUID of the tenant who owns the health - monitor. Only administrative users can specify a tenant UUID other - than their own. - in: body - required: false - type: string -tenant_id_6: - description: | - The owner of the IKE policy. Only administrative - users can specify a tenant UUID other than their own. - in: body - required: true - type: string -tenant_id_7: - description: | - Owner of the IPSec policy. Only administrative - users can specify a tenant UUID other than their own. - in: body - required: true - type: string -tenant_id_8: - description: | - Owner of the IPSec connection. Only - administrative users can specify a tenant UUID other than their - own. - in: body - required: true - type: string -tenant_id_9: - description: | - The UUID of the tenant who owns the listener. - Only administrative users can specify a tenant UUID other than - their own. - in: body - required: true - type: string -timeout: - description: | - The maximum time, in seconds, that a monitor - waits to connect before it times out. This value must be less than - the delay value. - in: body - required: true - type: integer -timeout_1: - description: | - 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. - in: body - required: false - type: integer -timeout_2: - description: | - 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. - in: body - required: true - type: integer -timeout_3: - description: | - The maximum time, in seconds, that a monitor - waits to connect before it times out. This value must be less than - the delay value. - in: body - required: false - type: integer -total_ips: - description: | - The total number of IP addresses in a network. - in: body - required: true - type: integer -transform_protocol: - description: | - The transform protocol. A valid value is ``ESP``, - ``AH``, or ``AH- ESP``. Default is ``ESP``. - in: body - required: false - type: string -transform_protocol_1: - description: | - The transform protocol. A valid value is ``ESP``, - ``AH``, or ``AH- ESP``. Default is ``ESP``. - in: body - required: true - type: string -type: - description: | - The type of probe sent by the load balancer to - verify the member state. A valid value is ``PING``, ``TCP``, - ``HTTP``, or ``HTTPS``. - in: body - required: true - type: string -type_1: - description: | - The type of QoS policy. - in: body - required: false - type: string -type_2: - description: | - The type of the endpoints in the group. A valid - value is ``subnet``, ``cidr``, ``network``, ``router``, or - ``vlan``. - in: body - required: true - type: string -type_3: - description: | - The type of probe sent by the load balancer to - verify the member state, which is ``PING``, ``TCP``, ``HTTP``, or - ``HTTPS``. - in: body - required: true - type: string -units: - description: | - 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. - in: body - required: false - type: string -units_1: - description: | - 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. - in: body - required: true - type: string -updated: - description: | - The date and time stamp when the extension was - last updated. - in: body - required: true - type: string -updated_at: - description: | - Time at which subnetpool has been updated. - in: body - required: true - type: string -url_path: - description: | - 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 (/). - in: body - required: false - type: string -url_path_1: - description: | - 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 (/). - in: body - required: false - type: string -url_path_2: - description: | - 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 (/). - in: body - required: true - type: string -used_ips: - description: | - The number of used IP addresses of all subnets in - a network. - in: body - required: true - type: integer -value: - description: | - 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. - in: body - required: false - type: integer -value_1: - description: | - 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. - in: body - required: true - type: integer -vip: - description: | - A ``vip`` object. - in: body - required: true - type: object -vip_address: - description: | - The IP address of the VIP. - format: ipv4 - in: body - required: false - type: string -vip_address_1: - description: | - The IP address of the VIP. - format: ipv4 - in: body - required: true - type: string -vip_id: - description: | - The UUID of the virtual IP (VIP) address. - in: body - required: true - type: string -vip_subnet_id: - description: | - The UUID of the subnet on which to allocate the - virtual IP (VIP) address. - in: body - required: true - type: string -vips: - description: | - A list of ``vip`` objects. - in: body - required: true - type: array -vlan_transparent: - description: | - The state of the network, which is VLAN - transparent (``true``) or not VLAN transparent (``false``). - in: body - required: true - type: boolean -vpnservice: - description: | - A ``vpnservice`` object. - in: body - required: true - type: object -vpnservice_id: - description: | - The UUID of the VPN service. - in: body - required: true - type: string -vpnservices: - description: | - A list of VPN service objects. - in: body - required: true - type: array -weight: - description: | - 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. - in: body - required: false - type: integer -weight_1: - description: | - 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. - in: body - required: false - type: integer -weight_2: - description: | - 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. - in: body - required: true - type: integer - diff --git a/api-ref/source/v2-ext/extensions.inc b/api-ref/source/v2/extensions.inc similarity index 100% rename from api-ref/source/v2-ext/extensions.inc rename to api-ref/source/v2/extensions.inc diff --git a/api-ref/source/v2-ext/extraroute.inc b/api-ref/source/v2/extraroute.inc similarity index 100% rename from api-ref/source/v2-ext/extraroute.inc rename to api-ref/source/v2/extraroute.inc diff --git a/api-ref/source/v2-ext/flavors-framework-v2.0.inc b/api-ref/source/v2/flavors.inc similarity index 100% rename from api-ref/source/v2-ext/flavors-framework-v2.0.inc rename to api-ref/source/v2/flavors.inc diff --git a/api-ref/source/v2-ext/fwaas-v2.0.inc b/api-ref/source/v2/fwaas-v2.0.inc similarity index 100% rename from api-ref/source/v2-ext/fwaas-v2.0.inc rename to api-ref/source/v2/fwaas-v2.0.inc diff --git a/api-ref/source/v2/index.rst b/api-ref/source/v2/index.rst index c507a910f..02e9e1536 100644 --- a/api-ref/source/v2/index.rst +++ b/api-ref/source/v2/index.rst @@ -4,8 +4,30 @@ Networking API v2.0 ################### -.. include:: versions-networks-v2.inc +.. rest_expand_all:: + +.. include:: versions.inc +.. include:: extensions.inc .. include:: networks.inc +.. include:: network-provider.inc +.. include:: networks-multi-provider-ext.inc +.. include:: networks-vlan-transparency-ext.inc .. include:: subnets.inc .. include:: ports.inc +.. include:: port-binding.inc +.. include:: subnetpools-ext.inc +.. include:: layer3-ext.inc +.. include:: extraroute.inc +.. include:: security-groups.inc +.. include:: security_group_rules.inc +.. include:: quotas.inc .. include:: service-type.inc +.. include:: flavors.inc +.. include:: tag-ext.inc +.. include:: networking-ip-availability-ext.inc +.. include:: qos-ext.inc +.. include:: metering-labels-ext.inc +.. include:: lbaas-v2.inc +.. include:: lbaas-v1.inc +.. include:: fwaas-v2.0.inc +.. include:: vpnaas.inc diff --git a/api-ref/source/v2-ext/layer3-ext.inc b/api-ref/source/v2/layer3-ext.inc similarity index 100% rename from api-ref/source/v2-ext/layer3-ext.inc rename to api-ref/source/v2/layer3-ext.inc diff --git a/api-ref/source/v2-ext/lbaas-v1.inc b/api-ref/source/v2/lbaas-v1.inc similarity index 100% rename from api-ref/source/v2-ext/lbaas-v1.inc rename to api-ref/source/v2/lbaas-v1.inc diff --git a/api-ref/source/v2-ext/lbaas-v2.inc b/api-ref/source/v2/lbaas-v2.inc similarity index 100% rename from api-ref/source/v2-ext/lbaas-v2.inc rename to api-ref/source/v2/lbaas-v2.inc diff --git a/api-ref/source/v2-ext/metering-labels-ext.inc b/api-ref/source/v2/metering-labels-ext.inc similarity index 100% rename from api-ref/source/v2-ext/metering-labels-ext.inc rename to api-ref/source/v2/metering-labels-ext.inc diff --git a/api-ref/source/v2-ext/network-provider.inc b/api-ref/source/v2/network-provider.inc similarity index 98% rename from api-ref/source/v2-ext/network-provider.inc rename to api-ref/source/v2/network-provider.inc index 66ace0c07..8d626efd4 100644 --- a/api-ref/source/v2-ext/network-provider.inc +++ b/api-ref/source/v2/network-provider.inc @@ -36,7 +36,7 @@ Request .. rest_parameters:: parameters.yaml - - network_id: network_id + - network_id: network_id_3 Response Parameters ------------------- @@ -94,7 +94,7 @@ Request - port_security_enabled: port_security_enabled - provider:segmentation_id: provider:segmentation_id - name: name - - network_id: network_id + - network_id: network_id_3 Request Example --------------- @@ -142,7 +142,7 @@ Request .. rest_parameters:: parameters.yaml - - network_id: network_id + - network_id: network_id_3 List networks (provider network) ================================ diff --git a/api-ref/source/v2-ext/networking-ip-availability-ext.inc b/api-ref/source/v2/networking-ip-availability-ext.inc similarity index 95% rename from api-ref/source/v2-ext/networking-ip-availability-ext.inc rename to api-ref/source/v2/networking-ip-availability-ext.inc index ca7ce99e7..00e0b2371 100644 --- a/api-ref/source/v2-ext/networking-ip-availability-ext.inc +++ b/api-ref/source/v2/networking-ip-availability-ext.inc @@ -28,7 +28,7 @@ Request .. rest_parameters:: parameters.yaml - - network_id: network_id + - network_id: network_id_3 Response Parameters ------------------- @@ -37,7 +37,7 @@ Response Parameters - used_ips: used_ips - subnet_ip_availability: subnet_ip_availability - - network_id: network_id + - network_id: network_id_3 - tenant_id: tenant_id - total_ips: total_ips - network_ip_availability: network_ip_availability @@ -74,7 +74,7 @@ Response Parameters - used_ips: used_ips - subnet_ip_availability: subnet_ip_availability - - network_id: network_id + - network_id: network_id_3 - tenant_id: tenant_id - total_ips: total_ips - subnet_id: subnet_id diff --git a/api-ref/source/v2-ext/networks-multi-provider-ext.inc b/api-ref/source/v2/networks-multi-provider-ext.inc similarity index 99% rename from api-ref/source/v2-ext/networks-multi-provider-ext.inc rename to api-ref/source/v2/networks-multi-provider-ext.inc index 74601797a..a57a75934 100644 --- a/api-ref/source/v2-ext/networks-multi-provider-ext.inc +++ b/api-ref/source/v2/networks-multi-provider-ext.inc @@ -49,7 +49,7 @@ Request .. rest_parameters:: parameters.yaml - - network_id: network_id + - network_id: network_id_3 Response Parameters ------------------- diff --git a/api-ref/source/v2-ext/networks-vlan-transparency-ext.inc b/api-ref/source/v2/networks-vlan-transparency-ext.inc similarity index 99% rename from api-ref/source/v2-ext/networks-vlan-transparency-ext.inc rename to api-ref/source/v2/networks-vlan-transparency-ext.inc index b98774c51..c0ebb99f8 100644 --- a/api-ref/source/v2-ext/networks-vlan-transparency-ext.inc +++ b/api-ref/source/v2/networks-vlan-transparency-ext.inc @@ -40,7 +40,7 @@ Request .. rest_parameters:: parameters.yaml - - network_id: network_id + - network_id: network_id_3 Response Parameters ------------------- diff --git a/api-ref/source/v2/parameters.yaml b/api-ref/source/v2/parameters.yaml index f21a215f2..9650e7891 100644 --- a/api-ref/source/v2/parameters.yaml +++ b/api-ref/source/v2/parameters.yaml @@ -1,28 +1,266 @@ # variables in header # variables in path +alias_1: + description: | + The alias of an extension. + in: path + required: false + type: string +connection_id: + description: | + The UUID of the IPSec site-to-site connection. + in: path + required: false + type: string +endpoint_group_id: + description: | + The UUID of the VPN endpoint group. + in: path + required: false + type: string +firewall_id: + description: | + The UUID of the firewall. + in: path + required: false + type: string +firewall_policy_id_2: + description: | + The UUID of the firewall policy. + in: path + required: false + type: string +firewall_rule_id: + description: | + The UUID for the firewall rule. + in: path + required: false + type: string +flavor_id: + description: | + The UUID of the flavor. + in: path + required: false + type: string +floatingip_id: + description: | + The UUID of the floating IP address. + in: path + required: false + type: string +health_monitor_id: + description: | + The UUID for the health monitor. + in: path + required: false + type: string +ikepolicy_id_1: + description: | + The UUID of the IKE policy. + in: path + required: false + type: string +ipsecpolicy_id_1: + description: | + The UUID of the IPSec policy. + in: path + required: false + type: string +member_id: + description: | + The UUID for the member. + in: path + required: false + type: string network_id_1: description: | The UUID of the network. in: path required: false type: string +network_id_3: + description: | + The UUID of the network. + in: path + required: false + type: string +policy_id: + description: | + The UUID of the policy. + in: path + required: false + type: string +pool_id: + description: | + The UUID for the pool. + in: path + required: false + type: string port_id: description: | The UUID of the port. in: path required: false type: string +port_id_3: + description: | + The UUID of the port. + in: path + required: false + type: string +profile_id: + description: | + The UUID of the profile. + in: path + required: false + type: string +resource_id: + description: | + The UUID of resource which the tag is set on. + in: path + required: false + type: string +resource_type: + description: | + The type of resource which the tag is set on. + in: path + required: false + type: string +router_id: + description: | + The UUID of the router. + in: path + required: false + type: string +rule_id: + description: | + The UUID of the rule. + in: path + required: false + type: string +security_group_id_2: + description: | + The UUID of the security group. + in: path + required: false + type: string +service_id: + description: | + The UUID of the VPN service. + in: path + required: false + type: string subnet_id_2: description: | The UUID of the subnet. in: path required: false type: string +subnetpool_id: + description: | + The UUID of the subnet pool. + in: path + required: false + type: string +tag: + description: | + The name for the tag. + in: path + required: false + type: string +tenant_id_33: + description: | + The UUID of the tenant. + in: path + required: false + type: string +vip_id_1: + description: | + The UUID for the VIP. + in: path + required: false + type: string # variables in query +fields: + description: | + The fields that you want the server to return. + in: query + required: false + type: string +verbose: + description: | + Show detailed information. + in: query + required: false + type: boolean # variables in body +action: + description: | + The action that the API performs on traffic that + matches the firewall rule. Valid value is ``allow`` or ``deny``. + Default is ``deny``. + in: body + required: false + type: string +action_1: + description: | + The dead peer detection (DPD) action. A valid + value is ``clear``, ``hold``, ``restart``, ``disabled``, or + ``restart-by-peer``. Default value is ``hold``. + in: body + required: false + type: string +action_2: + description: | + The action that the API performs on traffic that + matches the firewall rule. Value is ``allow`` or ``deny``. + in: body + required: true + type: string +action_3: + description: | + The dead peer detection (DPD) action. A valid + value is ``clear``, ``hold``, ``restart``, ``disabled``, or + ``restart-by-peer``. Default value is ``hold``. + in: body + required: true + type: string +address: + description: | + The IP address of the member. + format: ipv4 + in: body + required: true + type: string +address_1: + description: | + The IP address of the VIP. + format: ipv4 + in: body + required: false + type: string +address_2: + description: | + The IP address of the VIP. + format: ipv4 + in: body + required: true + type: string +address_scope_id: + description: | + An address scope to assign to the subnet pool. + in: body + required: false + type: string +address_scope_id_1: + description: | + The address scope. + in: body + required: true + type: string admin_state_up: description: | The administrative state of the network, which is @@ -37,6 +275,78 @@ admin_state_up_1: in: body required: false type: boolean +admin_state_up_10: + description: | + The administrative state of the VIP. A valid + value is up (``true``) or down (``false``). + in: body + required: false + type: boolean +admin_state_up_11: + description: | + The administrative state of the VPN service, + which is up (``true``) or down (``false``). If down, connections + on service are not active. + in: body + required: false + type: boolean +admin_state_up_12: + description: | + The administrative state of the firewall, which + is up (``true``) or down (``false``). + in: body + required: true + type: boolean +admin_state_up_13: + description: | + The administrative state of the health monitor, + which is up (``true``) or down (``false``). + in: body + required: false + type: boolean +admin_state_up_14: + description: | + The administrative state of the IPSec connection, + which is up (``true``) or down (``false``). If down, the + connection does not forward packets. + in: body + required: true + type: boolean +admin_state_up_15: + description: | + The administrative state of the listener, which + is up (``true``) or down (``false``). + in: body + required: true + type: boolean +admin_state_up_16: + description: | + The administrative state of the load balancer, + which is up (``true``) or down (``false``). + in: body + required: true + type: boolean +admin_state_up_17: + description: | + The administrative state of the member. A valid + value is up (``true``) or down (``false``). + in: body + required: true + type: boolean +admin_state_up_18: + description: | + The administrative state of the network, which is + up (``true``) or down (``false``). + in: body + required: true + type: boolean +admin_state_up_19: + description: | + The administrative state of the pool, which is up + (``true``) or down (``false``). + in: body + required: true + type: boolean admin_state_up_2: description: | The administrative state of the network, which is @@ -44,6 +354,59 @@ admin_state_up_2: in: body required: true type: boolean +admin_state_up_20: + description: | + The administrative state of the router, which is + up (``true``) or down (``false``). + in: body + required: true + type: boolean +admin_state_up_21: + description: | + The administrative state of the VIP. A valid + value is up (``true``) or down (``false``). + in: body + required: true + type: boolean +admin_state_up_22: + description: | + The administrative state of the VPN service, + which is up (``true``) or down (``false``). If down, the port does + not forward packets. + in: body + required: true + type: boolean +admin_state_up_23: + description: | + The administrative state of the firewall, which + is up (``true``) or down (``false``). + in: body + required: false + type: boolean +admin_state_up_24: + description: | + The administrative state of the health monitor. A + valid value is up (``true``) or down (``false``). + in: body + required: false + type: boolean +admin_state_up_25: + description: | + 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. + in: body + required: false + type: boolean +admin_state_up_26: + description: | + The administrative state of the IPSec connection, + which is up (``true``) or down (``false``). If down, the + connection does not forward packets. + in: body + required: false + type: boolean admin_state_up_3: description: | The administrative state of the port, which is up @@ -51,6 +414,56 @@ admin_state_up_3: in: body required: true type: boolean +admin_state_up_4: + description: | + The administrative state of the load balancer, + which is up (``true``) or down (``false``). + in: body + required: false + type: boolean +admin_state_up_5: + description: | + The administrative state of the member, which is + up (``true``) or down (``false``). + in: body + required: true + type: boolean +admin_state_up_6: + description: | + The administrative state of the member. A valid + value is up (``true``) or down (``false``). + in: body + required: false + type: boolean +admin_state_up_7: + description: | + The administrative state of the network, which is + up (``true``) or down (``false``). + in: body + required: false + type: boolean +admin_state_up_8: + description: | + The administrative state of the pool. A valid + value is up (``true``) or down (``false``). + in: body + required: false + type: boolean +admin_state_up_9: + description: | + The administrative state of the router, which is + up (``true``) or down (``false``). + in: body + required: false + type: boolean +alias: + description: | + The alias for the extension. For example, + "FOXNSOX", "os- availability-zone", "os-extended-quotas", "os- + share-unmanage" or "os-used-limits." + in: body + required: true + type: string allowed_address_pairs: description: | A set of zero or more allowed address pairs. An @@ -65,6 +478,67 @@ allowed_address_pairs_1: in: body required: true type: array +audited: + description: | + Each time that the firewall policy or its + associated rules are changed, the API sets this attribute to + ``false``. To audit the policy, explicitly set this attribute to + ``true``. + in: body + required: false + type: boolean +audited_1: + description: | + Indicates whether the policy has been audited. + Each time that the firewall policy or its associated rules are + changed, the API sets this attribute to ``false``. To audit the + policy, the policy owner must explicitly update the policy to set + this attribute to ``true``. + in: body + required: true + type: boolean +auth_algorithm: + description: | + The authentication hash algorithm. A valid value + is ``sha1``, which is the default. + in: body + required: false + type: string +auth_algorithm_1: + description: | + The authentication algorithm. A valid value is + ``sha1``, which is the default. + in: body + required: false + type: string +auth_algorithm_2: + description: | + The authentication hash algorithm. A valid value + is ``sha1``, which is the default. + in: body + required: true + type: string +auth_algorithm_3: + description: | + The authentication algorithm. A valid value is + ``sha1``, which is the default. + in: body + required: true + type: string +auth_mode: + description: | + The authentication mode. A valid value is + ``psk``, which is the default. + in: body + required: false + type: string +auth_mode_1: + description: | + The authentication mode. A valid value is + ``psk``, which is the default. + in: body + required: true + type: string availability_zone_hints: description: | The availability zone candidate for the network. @@ -77,18 +551,71 @@ availability_zones: in: body required: true type: array +bandwidth_limit_rule: + description: | + A ``bandwidth_limit_rule`` object. + in: body + required: true + type: object +bandwidth_limit_rules: + description: | + A list of bandwidth limit rules associated with + the QoS policy. + in: body + required: true + type: array changed_at: description: | Time at which the network has been created. in: body required: true type: string +cidr: + description: | + The CIDR of the subnet. + in: body + required: true + type: string +connection_limit: + description: | + The maximum number of connections permitted for + this load balancer. Default is infinite. + in: body + required: false + type: integer +connection_limit_1: + description: | + The maximum number of connections allowed for the + VIP. Value is ``-1`` if the limit is not set. + in: body + required: false + type: integer +connection_limit_2: + description: | + The maximum number of connections permitted for + this load balancer. Default is infinite. + in: body + required: true + type: integer +connection_limit_3: + description: | + The maximum number of connections allowed for the + VIP. Default is ``-1``, meaning no limit. + in: body + required: true + type: integer created_at: description: | Time at which port has been created. in: body required: true type: string +created_at_1: + description: | + Time at which subnetpool has been created. + in: body + required: true + type: string default: description: | Defines whether the provider is the default for @@ -98,6 +625,367 @@ default: in: body required: true type: boolean +default_pool_id: + description: | + The UUID of default pool. Must have compatible + protocol with listener. + in: body + required: false + type: string +default_pool_id_1: + description: | + The UUID of default pool. Must have compatible + protocol with listener. + in: body + required: true + type: string +default_prefixlen: + description: | + The size of the prefix to allocate when the + ``cidr`` or ``prefixlen`` attributes are omitted when you create + the subnet. Default is ``min_prefixlen``. + in: body + required: false + type: integer +default_prefixlen_1: + description: | + The size of the prefix to allocate when the + ``cidr`` or ``prefixlen`` attributes are omitted when you create + the subnet. + in: body + required: true + type: integer +default_quota: + description: | + 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 allocations from the subnet pool. For IPv4 + subnet pools, ``default_quota`` is measured in units of /32. For + IPv6 subnet pools, ``default_quota`` is measured units of /64. All + tenants that use the subnet pool have the same prefix quota + applied. + in: body + required: false + type: integer +default_quota_1: + description: | + A per-tenant quota on the prefix space that can + be allocated from the subnet pool for tenant subnets. For IPv4 + subnet pools, ``default_quota`` is measured in units of /32. For + IPv6 subnet pools, ``default_quota`` is measured units of /64. All + tenants that use the subnet pool have the same prefix quota + applied. + in: body + required: true + type: integer +default_quota_2: + description: | + 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 allocations from the subnet pool. For IPv4 + subnet pools, ``default_quota`` is measured in units of /32. For + IPv6 subnet pools, ``default_quota`` is measured units of /64. All + tenants that use the subnet pool have the same prefix quota + applied. Updating this parameter has no effect on existing subnet + allocations. The existing subnet allocations for each tenant are + counted against the updated prefix space quota. + in: body + required: false + type: integer +default_tls_container_ref: + description: | + A reference to a container of TLS secrets. + in: body + required: false + type: string +default_tls_container_ref_1: + description: | + A reference to a container of TLS secrets. + in: body + required: true + type: string +delay: + description: | + The time, in seconds, between sending probes to + members. + in: body + required: true + type: integer +delay_1: + description: | + The amount of time, in seconds, between sending + probes to members. + in: body + required: true + type: integer +delay_2: + description: | + The amount of time, in seconds, between sending + probes to members. + in: body + required: false + type: integer +description: + description: | + The human-readable description for the firewall + policy. + in: body + required: false + type: string +description_1: + description: | + Human readable description for the firewall rule. + The maximum length is 1024 characters. No default. + in: body + required: false + type: string +description_10: + description: | + The QoS policy description. + in: body + required: false + type: string +description_11: + description: | + Human-readable description for the pool. + in: body + required: false + type: string +description_12: + description: | + The security group description. + in: body + required: false + type: string +description_13: + description: | + Human-readable description for the service + profile. + in: body + required: false + type: string +description_14: + description: | + Human-readable description for the VIP. + in: body + required: false + type: string +description_15: + description: | + Human-readable description for the VPN endpoint + group. + in: body + required: false + type: string +description_16: + description: | + Human-readable description for the VPN service. + in: body + required: false + type: string +description_17: + description: | + The human-readable description for the firewall + policy. + in: body + required: true + type: string +description_18: + description: | + The extension description. + in: body + required: true + type: string +description_19: + description: | + Human readable description for the firewall rule. + in: body + required: true + type: string +description_2: + description: | + Human-readable description for the firewall + service. + in: body + required: false + type: string +description_20: + description: | + The human-readable description for the firewall + service. + in: body + required: true + type: string +description_21: + description: | + Human-readable description for the flavor. + in: body + required: true + type: string +description_22: + description: | + Human-readable description for the IKE policy. + in: body + required: true + type: string +description_23: + description: | + Human-readable description for the IPSec + connection. + in: body + required: true + type: string +description_24: + description: | + Detailed description of the listener. + in: body + required: true + type: string +description_25: + description: | + The load balancer description. + in: body + required: true + type: string +description_26: + description: | + Description for the metering label. + in: body + required: true + type: string +description_27: + description: | + The description of the QoS policy. + in: body + required: true + type: string +description_28: + description: | + The description for the pool. + in: body + required: true + type: string +description_29: + description: | + The security group description. + in: body + required: true + type: string +description_3: + description: | + Human-readable description for the flavor. + in: body + required: false + type: string +description_30: + description: | + Human-readable description for the service + profile. + in: body + required: true + type: string +description_31: + description: | + Human-readable description for the VIP. + in: body + required: true + type: string +description_32: + description: | + Human-readable description for the VPN endpoint + group. + in: body + required: true + type: string +description_33: + description: | + Human-readable description for the VPN service. + in: body + required: true + type: string +description_34: + description: | + New human-readable description for the flavor. + in: body + required: false + type: string +description_35: + description: | + Security group description. + in: body + required: false + type: string +description_4: + description: | + Human-readable description for the IKE policy. + in: body + required: false + type: string +description_5: + description: | + Human-readable description for the IPSec policy. + in: body + required: true + type: string +description_6: + description: | + Human-readable description for the IPSec + connection. + in: body + required: false + type: string +description_7: + description: | + Detailed description of the listener. + in: body + required: false + type: string +description_8: + description: | + The load balancer description. + in: body + required: false + type: string +description_9: + description: | + The description for the metering label. + in: body + required: false + type: string +destination: + description: | + The destination CIDR. + in: body + required: false + type: string +destination_ip_address: + description: | + The destination IPv4 or IPv6 address or CIDR. No + default. + in: body + required: false + type: string +destination_ip_address_1: + description: | + The destination IPv4 or IPv6 address or CIDR. + in: body + required: true + type: string +destination_port: + description: | + The destination port or port range. A valid + value is a port number, as an integer, or a port range, in the + format of a ``:`` separated range. For a port range, include both + ends of the range. For example, ``80:90``. + in: body + required: false + type: string +destination_port_1: + description: | + The destination port or port range. + in: body + required: true + type: string device_id: description: | The UUID of the device that uses this port. For @@ -126,6 +1014,306 @@ device_owner_1: in: body required: true type: string +direction: + description: | + Ingress or egress, which is the direction in + which the metering rule is applied. + in: body + required: true + type: string +direction_1: + description: | + 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. + in: body + required: true + type: string +direction_2: + description: | + 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. + in: body + required: true + type: string +distributed: + description: | + If ``true``, indicates a distributed router. + in: body + required: true + type: boolean +dpd: + description: | + A dictionary with dead peer detection (DPD) + protocol controls. + in: body + required: false + type: object +dpd_1: + description: | + A dictionary with dead peer detection (DPD) + protocol controls. + in: body + required: true + type: object +driver: + description: | + Provider driver to use for this profile. Example: + ``neutron_lbaas.drivers.octavia.driver.OctaviaDriver`` + in: body + required: false + type: string +driver_1: + description: | + Driver to associate with profile. + in: body + required: true + type: string +driver_2: + description: | + Provider driver to use for this profile. Ex: + neutron_lbaas.drivers.octavia.driver.OctaviaDriver. + in: body + required: false + type: string +dscp_mark: + description: | + The DSCP mark value. + in: body + required: false + type: integer +dscp_marking_rule: + description: | + A ``dscp_marking_rule`` object. + in: body + required: true + type: dict +dscp_marking_rules: + description: | + A list of ``dscp_marking_rule`` objects. + in: body + required: true + type: array +enable_snat: + description: | + 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. + in: body + required: false + type: boolean +enable_snat_1: + description: | + Enable Source NAT (SNAT) attribute, a part of + ext-gw-mode extension. When a gateway is attached to a router + using an L3 extension, Network Address Translation (NAT) is + enabled for traffic generated by subnets attached to the router. + in: body + required: true + type: boolean +enabled: + description: | + Set to ``false`` to disable this rule in the + firewall policy. Facilitates selectively turning off rules without + having to disassociate the rule from the firewall policy. Valid + value is ``true`` or ``false``. Default is ``true``. + in: body + required: false + type: boolean +enabled_1: + description: | + Indicates whether this flavor is enabled or + disabled. Default ``true``. + in: body + required: false + type: boolean +enabled_2: + description: | + Indicates whether this service profile is enabled + or disabled. Default ``true``. + in: body + required: false + type: boolean +enabled_3: + description: | + Indicates whether this rule is enabled or + disabled in the firewall policy. + in: body + required: true + type: boolean +enabled_4: + description: | + Indicates whether this flavor is enabled or + disabled. + in: body + required: true + type: boolean +enabled_5: + description: | + Indicates whether this service profile is enabled + or disabled. + in: body + required: true + type: boolean +enabled_6: + description: | + Indicates whether this flavor is enabled or + disabled. + in: body + required: false + type: boolean +enabled_7: + description: | + Indicates whether this service profile is enabled + or disabled. Default true. + in: body + required: false + type: boolean +encapsulation_mode: + description: | + The encapsulation mode. A valid value is + ``tunnel`` or ``transport``. Default is ``tunnel``. + in: body + required: false + type: string +encapsulation_mode_1: + description: | + The encapsulation mode. A valid value is + ``tunnel`` or ``transport``. Default is ``tunnel``. + in: body + required: true + type: string +encryption_algorithm: + description: | + The encryption algorithm. A valid value is + ``3des``, ``aes-128``, ``aes-192``, ``aes-256``, and so on. + Default is ``aes-128``. + in: body + required: false + type: string +encryption_algorithm_1: + description: | + The encryption algorithm. A valid value is + ``3des``, ``aes-128``, ``aes-192``, ``aes-256``, and so on. + Default is ``aes-128``. + in: body + required: true + type: string +endpoints: + description: | + List of endpoints of the same type, for the + endpoint group. The values will depend on type. + in: body + required: true + type: array +endpoints_1: + description: | + A list of endpoints of the same type for the + endpoint group. Theses values depend on the type. + in: body + required: true + type: array +ethertype: + description: | + Must be IPv4 or IPv6, and addresses represented + in CIDR must match the ingress or egress rules. + in: body + required: false + type: string +ethertype_1: + description: | + Must be IPv4 or IPv6, and addresses represented + in CIDR must match the ingress or egress rules. + in: body + required: true + type: string +excluded: + description: | + Indicates whether to count the traffic of a + specific IP address with the ``remote_ip_prefix`` value. Default + is ``false``. + in: body + required: false + type: boolean +'excluded ': + description: | + Indicates whether to count the traffic of a + specific IP address with the ``remote_ip_prefix`` value. Default + is ``false``. + in: body + required: true + type: boolean +expected_codes: + description: | + 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 list, such + as 200, 202. - A range, such as 200-204. + in: body + required: false + type: string +expected_codes_1: + description: | + Expected HTTP codes for a passing HTTP(S) + monitor. + in: body + required: false + type: string +extension: + description: | + A list of ``extension`` object. + in: body + required: true + type: object +external_fixed_ips: + description: | + The IP address parameters. + in: body + required: false + type: array +external_fixed_ips_1: + description: | + The IP address parameters. + in: body + required: true + type: array +external_gateway_info: + description: | + The external gateway parameters, which include + the ``network_id``, ``enable_snat`` and ``external_fixed_ips`` + parameters. + in: body + required: false + type: object +external_gateway_info_1: + description: | + The external gateway parameters, which include + the ``network_id``, ``enable_snat`` and ``external_fixed_ips`` + parameters. + in: body + required: true + type: object +external_v4_ip: + description: | + 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. + in: body + required: true + type: string +external_v6_ip: + description: | + 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. + in: body + required: true + type: string extra_dhcp_opts: description: | A set of zero or more extra DHCP option pairs. An @@ -133,6 +1321,112 @@ extra_dhcp_opts: in: body required: true type: array +firewall: + description: | + A ``firewall`` object. + in: body + required: true + type: object +firewall_list: + description: | + A list of the UUIDs for firewall associated with + the firewall policy. + in: body + required: true + type: array +firewall_policies: + description: | + A list of ``firewall_policy`` objects. + in: body + required: true + type: array +firewall_policy: + description: | + A ``firewall_policy`` object. + in: body + required: true + type: object +firewall_policy_id: + description: | + Read-only attribute that the API populates with + the UUID of the firewall policy when you associate this firewall + rule with a policy. You can associate a firewall rule with one + policy at a time. You can update this association can to a + different firewall policy. If you do not associate the rule with + any policy, this attribute is ``null``. + in: body + required: true + type: string +firewall_policy_id_1: + description: | + The UUID of the policy that is associated with + the firewall. + in: body + required: true + type: string +firewall_policy_id_3: + description: | + The UUID of the policy that is associated with + the firewall. + in: body + required: false + type: string +firewall_rule: + description: | + A ``firewall_rule`` object. + in: body + required: true + type: object +firewall_rule_id_1: + description: | + The UUID of the firewall rule. + in: body + required: true + type: string +firewall_rules: + description: | + A list of the UUIDs for firewall rule associated + with the firewall policy. + in: body + required: true + type: array +firewall_rules_id: + description: | + A list of rules to associate with the firewall + policy. + in: body + required: false + type: array +firewalls: + description: | + A list of ``firewall_rule`` objects. + in: body + required: true + type: array +firewalls_1: + description: | + A list of ``firewall`` objects. + in: body + required: true + type: array +fixed_ip_address: + description: | + 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. + in: body + required: false + type: string +fixed_ip_address_1: + description: | + The fixed IP address that is associated with the + floating IP address. + in: body + required: true + type: string fixed_ips: description: | If you specify only a subnet UUID, OpenStack @@ -149,6 +1443,135 @@ fixed_ips_1: in: body required: true type: array +flavor: + description: | + A ``flavor`` object. + in: body + required: true + type: object +flavor_1: + description: | + The UUID of a flavor. + in: body + required: false + type: string +flavor_2: + description: | + The UUID of a flavor if set. + in: body + required: false + type: string +flavors: + description: | + A list of ``flavor`` objects. + in: body + required: true + type: array +floating_ip_address: + description: | + The floating IP address. + in: body + required: false + type: string +floating_ip_address_1: + description: | + The floating IP address. + in: body + required: true + type: string +floating_network_id: + description: | + The UUID of the network associated with the + floating IP. + in: body + required: true + type: string +floatingip: + description: | + 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. + in: body + required: true + type: object +floatingip_1: + description: | + The number of floating IP addresses allowed for + each tenant. A value of ``-1`` means no limit. + in: body + required: true + type: integer +floatingip_2: + description: | + The number of floating IP addresses allowed for + each tenant. A value of ``-1`` means no limit. + in: body + required: false + type: integer +floatingips: + description: | + A list of ``floatingip`` objects. + in: body + required: true + type: array +ha: + description: | + If ``true``, indicates a highly-available router. + in: body + required: true + type: boolean +health_monitor: + description: | + A ``health_monitor`` object. + in: body + required: true + type: object +health_monitors: + description: | + List of health monitors that are associated with + the pool. + in: body + required: false + type: array +health_monitors_1: + description: | + A list of ``health_monitor`` objects. + in: body + required: true + type: array +health_monitors_2: + description: | + The UUID for the associated health monitor. + in: body + required: true + type: string +health_monitors_status: + description: | + The statuses of the health monitors that are + associated with the pool. + in: body + required: true + type: string +healthmonitor: + description: | + The associated healthmonitor, if any. + in: body + required: true + type: object +healthmonitor_id: + description: | + The UUID of the health monitor. + in: body + required: false + type: string +http_method: + description: | + The HTTP method that the monitor uses for + requests. + in: body + required: false + type: string id: description: | The UUID of the network. @@ -161,6 +1584,246 @@ id_1: in: body required: true type: string +id_10: + description: | + The UUID for the IPSec policy. + in: body + required: true + type: string +id_11: + description: | + The UUID for the IPSec connection. + in: body + required: true + type: string +id_12: + description: | + The UUID of the listener. + in: body + required: true + type: string +id_13: + description: | + The UUID for the load balancer. + in: body + required: true + type: string +id_14: + description: | + The UUID for the member. + in: body + required: true + type: string +id_15: + description: | + The UUID for the metering label rule. + in: body + required: true + type: string +id_16: + description: | + The UUID of the metering label. + in: body + required: true + type: string +id_17: + description: | + The UUID of the network. + in: body + required: true + type: string +id_18: + description: | + The generated UUID of the QoS policy. + in: body + required: true + type: string +id_19: + description: | + The UUID for the pool. + in: body + required: true + type: string +id_2: + description: | + The UUID for the health monitor. + in: body + required: true + type: string +id_20: + description: | + The UUID of the security group rule. + in: body + required: true + type: string +id_21: + description: | + The UUID of the subnet pool. + in: body + required: true + type: string +id_22: + description: | + The UUID for the VIP. + in: body + required: true + type: string +id_23: + description: | + The UUID for the VPN endpoint group. + in: body + required: true + type: string +id_24: + description: | + The UUID for the VPN service. + in: body + required: true + type: string +id_25: + description: | + The UUID of network. + in: body + required: true + type: string +id_26: + description: | + The UUID of the security group. + in: body + required: true + type: string +id_27: + description: | + The UUID of the router. + in: body + required: true + type: string +id_28: + description: | + The UUID of the service profile. + in: body + required: true + type: string +id_3: + description: | + The UUID of the QoS policy rule. + in: body + required: true + type: string +id_4: + description: | + The UUID for the firewall policy. + in: body + required: true + type: string +id_5: + description: | + The generated UUID for the firewall rule object. + in: body + required: true + type: string +id_6: + description: | + The UUID for the firewall service. + in: body + required: true + type: string +id_7: + description: | + The UUID of the flavor. + in: body + required: true + type: string +id_8: + description: | + The UUID of the floating IP address. + in: body + required: true + type: string +id_9: + description: | + The UUID for the IKE policy. + in: body + required: true + type: string +ike_version: + description: | + The IKE version. A valid value is ``v1`` or + ``v2``. Default is ``v1``. + in: body + required: false + type: string +ike_version_1: + description: | + The IKE version. A valid value is ``v1`` or + ``v2``. Default is ``v1``. + in: body + required: true + type: string +ikepolicies: + description: | + A list of IKE policy objects. + in: body + required: true + type: array +ikepolicy: + description: | + An ``ikepolicy`` object. + in: body + required: true + type: object +ikepolicy_id: + description: | + The UUID of the IKE policy. + in: body + required: true + type: string +initiator: + description: | + 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``. + in: body + required: false + type: string +initiator_1: + description: | + 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``. + in: body + required: true + type: string +insert_after: + description: | + The UUID of the firewall_rule. A new + firewall_rule will be inserted after this firewall_rule. + in: body + required: false + type: string +insert_before: + description: | + The UUID of the firewall_rule. A new + firewall_rule will be inserted before this firewall_rule. + in: body + required: false + type: string +interval: + description: | + The dead peer detection (DPD) interval, in + seconds. A valid value is a positive integer. Default is 30. + in: body + required: false + type: integer +interval_1: + description: | + The dead peer detection (DPD) interval, in + seconds. A valid value is a positive integer. Default is 30. + in: body + required: true + type: integer ip_address: description: | The IP address of an allowed address pair. @@ -173,6 +1836,181 @@ ip_address_1: in: body required: true type: string +ip_version: + description: | + The IP protocol version. Valid value is ``4`` or + ``6``. Default is ``4``. + in: body + required: false + type: integer +ip_version_1: + description: | + The IP address family of the list of prefixes + passed to the ``prefixes`` attribute. + in: body + required: true + type: integer +ip_version_2: + description: | + The IP protocol version. Value is ``4`` or ``6``. + in: body + required: true + type: integer +ip_version_3: + description: | + The IP version (4 or 6) of the subnet. + in: body + required: true + type: integer +ipsec_site_connection: + description: | + An ``ipsec_site_connection`` object. + in: body + required: true + type: object +ipsecpolicies: + description: | + A list of IPSec policy objects. + in: body + required: true + type: array +ipsecpolicy: + description: | + An ``ipsecpolicy`` object. + in: body + required: true + type: object +ipsecpolicy_id: + description: | + The UUID of the IPSec policy. + in: body + required: true + type: string +lb_algorithm: + description: | + 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. + in: body + required: true + type: string +lb_method: + description: | + 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. + in: body + required: true + type: string +lb_method_1: + description: | + 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. + in: body + required: false + type: string +lifetime: + description: | + 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. + in: body + required: false + type: object +lifetime_1: + description: | + 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. + in: body + required: false + type: object +lifetime_2: + description: | + 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. + in: body + required: true + type: object +links: + description: | + The share links. + in: body + required: true + type: array +listener: + description: | + A ``listener`` object. + in: body + required: true + type: object +listener_id: + description: | + The UUID of the listener. + in: body + required: false + type: string +listeners: + description: | + The associated listeners, if any. + in: body + required: true + type: array +listeners_1: + description: | + A ``listeners`` object. + in: body + required: true + type: array +loadbalancer: + description: | + A ``loadbalancer`` object. + in: body + required: true + type: object +loadbalancer_id: + description: | + The UUID of the load balancer. + in: body + required: true + type: string +loadbalancers: + description: | + A list of load balancer objects. + in: body + required: true + type: array +local_ep_group_id: + description: | + The UUID for the endpoint group that contains + private subnets for the local side of the connection. Yo must + specify this parameter with the ``peer_ep_group_id`` parameter + unless in backward- compatible mode where ``peer_cidrs`` is + provided with a ``subnet_id`` for the VPN service. + in: body + required: false + type: string +local_ep_group_id_1: + description: | + 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. + in: body + required: true + type: string location: description: | Full URL to a service or server. @@ -192,12 +2030,165 @@ mac_address_1: in: body required: true type: string +max_burst_kbps: + description: | + The burst over the maximum KBPS value. Default is + ``0`` + in: body + required: false + type: integer +max_burst_kbps_1: + description: | + The burst over the maximum KBPS value. + in: body + required: true + type: integer +max_kbps: + description: | + The maximum KBPS value. If you specify this + value, must be greater than 0. Default is ``null``. + in: body + required: false + type: integer +max_kbps_1: + description: | + The maximum KBPS value. + in: body + required: true + type: integer +max_prefixlen: + description: | + 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``. + in: body + required: false + type: integer +max_prefixlen_1: + description: | + The maximum prefix size that can be allocated + from the subnet pool. + in: body + required: true + type: integer +max_retries: + description: | + The number of allowed connection failures before + changing the status of the member to ``INACTIVE``. A valid value + is from 1 to 10. + in: body + required: true + type: integer +member: + description: | + A ``member`` object. + in: body + required: true + type: object +members: + description: | + The list of members that belong to the pool. + in: body + required: true + type: array +members_1: + description: | + A list of ``member`` objects. + in: body + required: true + type: array +members_2: + description: | + The associated members, if any. + in: body + required: true + type: array +metainfo: + description: | + JSON-formatted meta information. + in: body + required: false + type: string +metainfo_1: + description: | + JSON metainfo to associate with profile. + in: body + required: true + type: string +metering_label: + description: | + A ``metering_label`` object. + in: body + required: true + type: object +metering_label_id: + description: | + The metering label UUID to associate with this + metering rule. + in: body + required: true + type: string +metering_label_rule: + description: | + A ``metering_label_rule`` object. + in: body + required: true + type: object +metering_label_rules: + description: | + A list of ``metering_label_rule`` objects. + in: body + required: true + type: array +metering_labels: + description: | + A list of ``metering_label`` objects. + in: body + required: true + type: array +min_prefixlen: + description: | + The smallest prefix that can be allocated from a + subnet pool. For IPv4 subnet pools, default is ``8``. For IPv6 + subnet pools, default is ``64``. + in: body + required: false + type: integer +min_prefixlen_1: + description: | + The smallest prefix that can be allocated from a + subnet pool. + in: body + required: true + type: integer mtu: description: | The MTU of a network resource. in: body required: true type: integer +mtu_1: + description: | + The MTU of a network resource. + in: body + required: true + type: integer +mtu_2: + description: | + The maximum transmission unit (MTU) to address + fragmentation. The minimum value for IPv4 is 68. The minimum value + for IPv6 is 1280. + in: body + required: true + type: integer +mtu_3: + description: | + The maximum transmission unit (MTU) value to + address fragmentation. Minimum value is 68 for IPv4, and 1280 for + IPv6. + in: body + required: false + type: integer name: description: | The network name. @@ -210,30 +2201,306 @@ name_1: in: body required: false type: string +name_10: + description: | + The network name. + in: body + required: false + type: string +name_11: + description: | + The QoS policy name. + in: body + required: false + type: string +name_12: + description: | + The pool name. Does not have to be unique. + in: body + required: false + type: string +name_13: + description: | + The router name. + in: body + required: false + type: string +name_14: + description: | + A symbolic name for the security group. Does not + have to be unique. + in: body + required: true + type: string +name_15: + description: | + A name for the subnet pool. + in: body + required: true + type: string +name_16: + description: | + Human-readable name for the VIP. Does not have to + be unique. + in: body + required: false + type: string +name_17: + description: | + Human-readable name for the VPN endpoint group. + Does not have to be unique. + in: body + required: false + type: string +name_18: + description: | + Human-readable name for the VPN service. Does not + have to be unique. + in: body + required: false + type: string +name_19: + description: | + Human-readable name for the firewall policy. Does + not have to be unique. + in: body + required: true + type: string name_2: description: | The network name. in: body required: true type: string +name_20: + description: | + The name of the extension. For example, "Fox In + Socks." + in: body + required: true + type: string +name_21: + description: | + Human readable name for the firewall rule. + in: body + required: true + type: string +name_22: + description: | + Human-readable name for the firewall service. + Does not have to be unique. + in: body + required: true + type: string +name_23: + description: | + Human-readable name for the flavor. Can be "" and + non-unique. + in: body + required: true + type: string +name_24: + description: | + Human-readable name for the IKE policy. Does not + have to be unique. + in: body + required: true + type: string +name_25: + description: | + Human-readable name for the IPSec connection. + Does not have to be unique. + in: body + required: true + type: string +name_26: + description: | + The load balancer name. + in: body + required: true + type: string +name_27: + description: | + The network name. + in: body + required: true + type: string +name_28: + description: | + The name of the subnet. + in: body + required: true + type: string +name_29: + description: | + The name of the QoS policy. + in: body + required: true + type: string name_3: description: | The port name. in: body required: true type: string +name_30: + description: | + The pool name. Does not have to be unique. + in: body + required: true + type: string +name_31: + description: | + The router name. + in: body + required: true + type: string +name_32: + description: | + The security group name. + in: body + required: true + type: string +name_33: + description: | + The subnet pool name. + in: body + required: true + type: string +name_34: + description: | + Human-readable name for the VIP. Does not have to + be unique. + in: body + required: true + type: string +name_35: + description: | + Human-readable name for the VPN endpoint group. + Does not have to be unique. + in: body + required: true + type: string +name_36: + description: | + Human-readable name for the VPN service. Does not + have to be unique. + in: body + required: true + type: string +name_37: + description: | + New human-readable name for the flavor. Can be "" + and non-unique. + in: body + required: false + type: string +name_38: + description: | + Human-readable name for the pool. Does not have + to be unique. + in: body + required: false + type: string +name_39: + description: | + Human-readable name for the firewall policy. Does + not have to be unique. + in: body + required: false + type: string name_4: description: | User-facing provider name. in: body required: true type: string +name_40: + description: | + Human readable name for the firewall rule. + Maximum length is 255 characters. Does not have to be unique. No + default. + in: body + required: false + type: string +name_41: + description: | + Human-readable name for the flavor. Can be "" and + non-unique. + in: body + required: false + type: string +name_42: + description: | + The human-readable name for the firewall service. + Does not have to be unique. + in: body + required: false + type: string +name_43: + description: | + Human-readable name for the IKE policy. Does not + have to be unique. + in: body + required: false + type: string +name_5: + description: | + Human-readable name for the IPSec policy. Does + not have to be unique. + in: body + required: true + type: string +name_6: + description: | + Human-readable name for the IPSec connection. + Does not have to be unique. + in: body + required: false + type: string +name_7: + description: | + The listener name. + in: body + required: true + type: string +name_8: + description: | + The load balancer name. Does not have to be + unique. + in: body + required: false + type: string +name_9: + description: | + The name of the metering label. + in: body + required: true + type: string network: description: | A ``network`` object. in: body required: true type: object +network_1: + description: | + The number of networks allowed for each tenant. + in: body + required: true + type: integer +network_2: + description: | + The number of networks allowed for each tenant. + in: body + required: false + type: integer +network_3: + description: | + A ``network`` object. + in: body + required: true + type: object network_id: description: | The UUID of the network. @@ -246,12 +2513,43 @@ network_id_2: in: body required: true type: string +network_ip_availabilities: + description: | + The ``network_ip_availabilities`` object. + in: body + required: true + type: array +network_ip_availability: + description: | + A ``network_ip_availability`` object. + in: body + required: true + type: dict +network_name: + description: | + The name of the network. + in: body + required: true + type: string networks: description: | A list of ``network`` objects. in: body required: true type: array +nexthop: + description: | + The IP address of the next hop. + in: body + required: false + type: string +operating_status: + description: | + The operating status of the load balancer. This + value is ``ONLINE`` or ``OFFLINE``. + in: body + required: true + type: string opt_name: description: | The extra DHCP option name. @@ -276,12 +2574,246 @@ opt_value_1: in: body required: true type: string +peer_address: + description: | + The peer gateway public IPv4 or IPv6 address or + FQDN. + in: body + required: true + type: string +peer_address_1: + description: | + The peer gateway public IPv4 address, IPv6 + address, or FQDN. + in: body + required: true + type: string +peer_cidrs: + description: | + (Deprecated) Unique list of valid peer private + CIDRs in the form < net_address > / < prefix > . + in: body + required: false + type: array +peer_cidrs_1: + description: | + (Deprecated) Unique list of valid peer private + CIDRs in the form < net_address > / < prefix > . + in: body + required: true + type: array +peer_ep_group_id: + description: | + The UUID for the endpoint group that contains + private CIDRs in the form < net_address > / < prefix > for the + peer side of the connection. You must specify this parameter with + the ``local_ep_group_id`` parameter unless in backward-compatible + mode where ``peer_cidrs`` is provided with a ``subnet_id`` for the + VPN service. + in: body + required: false + type: string +peer_ep_group_id_1: + description: | + 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 shown. + in: body + required: true + type: string +peer_id: + description: | + 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. + in: body + required: true + type: string +peer_id_1: + description: | + 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. + in: body + required: true + type: string +pfs: + description: | + Perfect forward secrecy (PFS). A valid value is + ``Group2``, ``Group5``, ``Group14``, and so on. Default is + ``Group5``. + in: body + required: false + type: string +pfs_1: + description: | + Perfect forward secrecy (PFS). A valid value is + ``Group2``, ``Group5``, ``Group14``, and so on. Default is + ``Group5``. + in: body + required: true + type: string +phase1_negotiation_mode: + description: | + The IKE mode. A valid value is ``main``, which is + the default. + in: body + required: false + type: string +phase1_negotiation_mode_1: + description: | + The IKE mode. A valid value is ``main``, which is + the default. + in: body + required: true + type: string +policies: + description: | + A list of QoS ``policy`` objects. + in: body + required: true + type: array +policy: + description: | + A QoS ``policy`` object. + in: body + required: true + type: object +policy_id_1: + description: | + The UUID of the QoS policy that is associated + with the rule. + in: body + required: true + type: string +pool: + description: | + A ``pool`` object. + in: body + required: true + type: object +pool_id_1: + description: | + The UUID of the pool to which the member belongs. + in: body + required: true + type: string +pool_id_2: + description: | + The UUID of the pool with which the VIP is + associated. + in: body + required: true + type: string +pool_id_3: + description: | + The UUID of the pool to which the member belongs. + in: body + required: false + type: string +pool_id_4: + description: | + The UUID of the pool with which the VIP is + associated. + in: body + required: false + type: string +pools: + description: | + List of pools that are associated with the health + monitor. + in: body + required: true + type: array +pools_1: + description: | + A list of ``pool`` objects. + in: body + required: true + type: array +pools_2: + description: | + The associated pools, if any. + in: body + required: true + type: array port: description: | A ``port`` object. in: body required: true type: object +port_1: + description: | + The number of ports allowed for each tenant. + in: body + required: false + type: integer +port_2: + description: | + The number of ports allowed for each tenant. + in: body + required: true + type: integer +port_id_1: + description: | + The UUID of the port. + in: body + required: false + type: string +port_id_2: + description: | + The UUID of the VIP port. + in: body + required: true + type: string +port_id_4: + description: | + The UUID of the port. + in: body + required: true + type: string +port_range_max: + description: | + 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. + in: body + required: false + type: integer +port_range_max_1: + description: | + 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. + in: body + required: true + type: integer +port_range_min: + description: | + 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. + in: body + required: false + type: integer +port_range_min_1: + description: | + 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. + in: body + required: true + type: integer port_security_enabled: description: | The port security status. A valid value is @@ -296,18 +2828,286 @@ port_security_enabled_1: in: body required: true type: boolean +port_security_enabled_2: + description: | + The port security status. A valid value is + enabled (``true``) or disabled (``false``). + in: body + required: true + type: boolean ports: description: | A list of ``port`` objects. in: body required: true type: array +position: + description: | + Read-only attribute that the API assigns to this + rule when it associates it with a firewall policy. This value + indicates the position of this rule in that firewall policy. This + position number starts at 1. If the firewall rule is not + associated with any policy, the position is ``null``. + in: body + required: true + type: integer +prefixes: + description: | + A list of subnet prefixes to assign to the subnet + pool. The API merges adjacent prefixes and treats them as a single + prefix. Each subnet prefix must be unique among all subnet + prefixes in all subnet pools that are associated with the address + scope. + in: body + required: true + type: array +prefixes_1: + description: | + A list of subnet prefixes that are assigned to + the subnet pool. The API merges adjacent prefixes and treats them + as a single prefix. + in: body + required: true + type: array +prefixes_2: + description: | + A list of subnet prefixes to assign to the subnet + pool. The API merges adjacent prefixes and treats them as a single + prefix. To update the subnet prefixes, pass a list that contains + the existing set of prefixes and the new set of prefixes. You + cannot shrink the prefix list of a subnet pool. You can only add + prefixes to it to expand it. Ensure that each subnet prefix is + unique among all subnet prefixes in all subnet pools that are + associated with the address scope. + in: body + required: true + type: array +protocol: + description: | + The IP protocol. Valid value is ``icmp``, + ``tcp``, ``udp``, or ``null``. No default. + in: body + required: false + type: string +protocol_1: + description: | + The protocol to load balance. A valid value is + ``HTTP``, ``HTTPS``, ``TCP``, or ``TERMINATED_HTTPS``. + in: body + required: true + type: string +protocol_2: + description: | + The protocol of the pool, which is ``TCP``, + ``HTTP``, or ``HTTPS``. + in: body + required: true + type: string +protocol_3: + description: | + The protocol that is matched by the security + group rule. Valid values are null, tcp, udp, and icmp. + in: body + required: false + type: string +protocol_4: + description: | + The protocol that is matched by the security + group rule. Value is ``null``, ``icmp``, ``icmpv6``, ``tcp``, or + ``udp``. + in: body + required: true + type: string +protocol_5: + description: | + The protocol of the virtual IP (VIP) address. A + valid value is ``TCP``, ``HTTP``, or ``HTTPS``. + in: body + required: true + type: string +protocol_6: + description: | + The IP protocol. Value is ``icmp``, ``tcp``, + ``udp``, or ``null``. + in: body + required: true + type: string +protocol_port: + description: | + The TCP or UDP port on which to listen. + in: body + required: true + type: integer +protocol_port_1: + description: | + The port where the application is hosted. + in: body + required: true + type: integer +protocol_port_2: + description: | + 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. + in: body + required: true + type: integer +provider: + description: | + The name of the provider. + in: body + required: false + type: string +provider:network_type: + description: | + The type of physical network that maps to this + network resource. For example, ``flat``, ``vlan``, ``vxlan``, or + ``gre``. + in: body + required: false + type: string +provider:physical_network: + description: | + 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. + in: body + required: false + type: string +provider:segmentation_id: + description: | + 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. + in: body + required: false + type: string +provider_1: + description: | + The load-balancer provider. + in: body + required: true + type: string +provider_2: + description: | + The name of the provider. + in: body + required: true + type: string +provisioning_status: + description: | + The provisioning status of the load balancer. + This value is ``ACTIVE``, ``PENDING_CREATE`` or ``ERROR``. + in: body + required: true + type: string +psk: + description: | + The pre-shared key. A valid value is any string. + in: body + required: true + type: string qos_policy_id: description: | The UUID of the QoS policy. in: body required: false type: string +quota: + description: | + A ``quota`` object. + in: body + required: true + type: object +quotas: + description: | + A list of quota objects. + in: body + required: true + type: array +rbac_policy: + description: | + The number of role-based access control (RBAC) + policies for each tenant. + in: body + required: true + type: integer +rbac_policy_1: + description: | + The number of role-based access control (RBAC) + policies for each tenant. + in: body + required: false + type: integer +remote_group_id: + description: | + The remote group UUID to associate with this + security group rule. You can specify either the + ``remote_group_id`` or ``remote_ip_prefix`` attribute in the + request body. + in: body + required: false + type: string +remote_group_id_1: + description: | + The remote group UUID to associate with this + security group rule. You can specify either the + ``remote_group_id`` or ``remote_ip_prefix`` attribute in the + request body. + in: body + required: true + type: string +remote_ip_prefix: + description: | + The remote IP prefix to associate with this + metering rule packet. + in: body + required: true + type: string +remote_ip_prefix_1: + description: | + The remote IP prefix to associate 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 IP prefix as the source + IP address of the IP packet. + in: body + required: false + type: string +remote_ip_prefix_2: + description: | + The remote IP prefix to associate 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 IP prefix as the + source IP address of the IP packet. + in: body + required: true + type: string +route_mode: + description: | + The route mode. A valid value is ``static``, + which is the default. + in: body + required: false + type: string +route_mode_1: + description: | + The route mode. A valid value is ``static``, + which is the default. + in: body + required: true + type: string +router: + description: | + A ``router`` object. + in: body + required: true + type: object router:external: description: | Indicates whether this network is externally @@ -322,6 +3122,138 @@ router:external_1: in: body required: true type: boolean +router_1: + description: | + The number of routers allowed for each tenant. + in: body + required: true + type: integer +router_2: + description: | + The number of routers allowed for each tenant. + in: body + required: false + type: integer +router_id_1: + description: | + The UUID of the router. + in: body + required: true + type: string +router_id_2: + description: | + The UUID of the router to which the VPN service + is inserted. + in: body + required: true + type: string +router_id_3: + description: | + The UUID of the router into which the VPN service + is inserted. + in: body + required: true + type: string +router_ids: + description: | + A list of UUIDs for routers that are associated + with the firewall. + in: body + required: false + type: array +router_ids_1: + description: | + A list of UUIDs for routers that are associated + with the firewall. + in: body + required: true + type: array +routers: + description: | + A list of ``router`` objects. + in: body + required: true + type: array +routes: + description: | + The extra routes configuration for L3 router. + in: body + required: true + type: array +routes_1: + description: | + A list of dictionary pairs in this format: + + :: + + [ + { + "nexthop":"IPADDRESS", + "destination":"CIDR" + } + ] + in: body + required: false + type: object +security_group: + description: | + A ``security_group`` object. + in: body + required: true + type: object +security_group_2: + description: | + The number of security groups allowed for each + tenant. + in: body + required: false + type: integer +security_group_4: + description: | + The number of security groups allowed for each + tenant. + in: body + required: true + type: integer +security_group_id: + description: | + The security group UUID to associate with this + security group rule. + in: body + required: true + type: string +security_group_id_1: + description: | + The UUID of the security group. + in: body + required: true + type: string +security_group_rule: + description: | + A ``security_group_rule`` object. + in: body + required: true + type: object +security_group_rule_1: + description: | + The number of security group rules allowed for + each tenant. + in: body + required: true + type: integer +security_group_rule_2: + description: | + The number of security group rules allowed for + each tenant. + in: body + required: false + type: integer +security_group_rules: + description: | + A list of ``security_group_rule`` objects. + in: body + required: true + type: array security_groups: description: | One or more security group UUIDs. @@ -334,6 +3266,37 @@ security_groups_1: in: body required: true type: array +security_groups_2: + description: | + A list of ``security_group`` objects. + in: body + required: true + type: array +segments: + description: | + A list of provider ``segment`` objects. + in: body + required: true + type: array +service_profile: + description: | + A ``service_profile`` object. + in: body + required: true + type: object +service_profiles: + description: | + Service profile UUIDs associated with this + flavor. + in: body + required: true + type: array +service_profiles_1: + description: | + A list of ``service_profile`` objects. + in: body + required: true + type: array service_providers: description: | A list of ``service_provider`` objects. @@ -348,6 +3311,55 @@ service_type: in: body required: true type: string +service_type_1: + description: | + Service type (ex: LOADBALANCERV2) for the flavor. + in: body + required: true + type: string +session_persistence: + description: | + The session persistence algorithm. This algorithm + is a dictionary with type and cookie_name keys. + in: body + required: false + type: object +session_persistence_1: + description: | + 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. + in: body + required: false + type: object +session_persistence_2: + description: | + 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. + in: body + required: true + type: object +session_persistence_3: + description: | + 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. + in: body + required: false + type: object shared: description: | Admin-only. Indicates whether this network is @@ -363,6 +3375,126 @@ shared_1: in: body required: true type: boolean +shared_10: + description: | + Indicates whether this policy is shared across + all tenants. + in: body + required: true + type: boolean +shared_11: + description: | + Indicates whether this subnet pool is shared + across all tenants. + in: body + required: true + type: boolean +shared_12: + description: | + Set to ``true`` to make this firewall policy + visible to other tenants. Default is ``false``. + in: body + required: false + type: boolean +shared_13: + description: | + Set to ``true`` to share this firewall rule with + other tenants. Other tenants can use a shared rule in firewall + policies that this tenant does not own. Valid value is ``true`` or + ``false``. Default is ``false``. + in: body + required: false + type: boolean +shared_2: + description: | + Indicates whether this metering label is shared + across all tenants. + in: body + required: false + type: boolean +shared_3: + description: | + Admin-only. Indicates whether this network is + shared across all tenants. + in: body + required: false + type: boolean +shared_4: + description: | + Set to ``true`` to share this policy with other + tenants. Default is ``false``. + in: body + required: false + type: boolean +shared_5: + description: | + Admin-only. Indicates whether this subnet pool is + shared across all tenants. + in: body + required: false + type: boolean +shared_6: + description: | + Indicates whether the firewall policy is shared + across all tenants. + in: body + required: true + type: boolean +shared_7: + description: | + Indicates whether this firewall rule is shared + with other tenants. Other tenants can use a shared rule in + firewall policies that this tenant does not own. + in: body + required: true + type: boolean +shared_8: + description: | + Indicates whether this metering label is shared + across all tenants. + in: body + required: true + type: boolean +shared_9: + description: | + Indicates whether this network is shared across + all tenants. + in: body + required: true + type: boolean +sni_container_refs: + description: | + A list of references to TLS secrets. + in: body + required: false + type: array +sni_container_refs_1: + description: | + A list of references to TLS secrets. + in: body + required: true + type: array +source_ip_address: + description: | + The source IPv4 or IPv6 address or CIDR. + in: body + required: true + type: string +source_port: + description: | + The source port or port range. A valid value is + a port number, as an integer, or a port range, in the format of a + ``:`` separated range. For a port range, include both ends of the + range. For example, ``80:90``. + in: body + required: false + type: string +source_port_1: + description: | + The source port or port range. + in: body + required: true + type: string status: description: | The network status. @@ -375,6 +3507,90 @@ status_1: in: body required: true type: string +status_10: + description: | + The status of the floating IP address. + in: body + required: true + type: string +status_2: + description: | + The operational status of the IPSec connection. + Value is ``ACTIVE``, ``DOWN``, ``BUILD``, ``ERROR``, + ``PENDING_CREATE``, ``PENDING_UPDATE``, or ``PENDING_DELETE``. + in: body + required: false + type: string +status_3: + description: | + The status of the member. Indicates whether the + member is operational. + in: body + required: true + type: string +status_4: + description: | + The network status. + in: body + required: true + type: string +status_5: + description: | + The status of the pool. Indicates whether the + pool is operational. + in: body + required: true + type: string +status_6: + description: | + The status of the VIP. Indicates whether the VIP + is operational. + in: body + required: true + type: string +status_7: + description: | + Indicates whether IPSec VPN service is currently + operational. Value is ``ACTIVE``, ``DOWN``, ``BUILD``, ``ERROR``, + ``PENDING_CREATE``, ``PENDING_UPDATE``, or ``PENDING_DELETE``. + in: body + required: true + type: string +status_8: + description: | + Indicates whether the IPSec connection is + currently operational. Value is ``ACTIVE``, ``DOWN``, ``BUILD``, + ``ERROR``, ``PENDING_CREATE``, ``PENDING_UPDATE``, or + ``PENDING_DELETE``. + in: body + required: true + type: string +status_9: + description: | + The status of the firewall service. Value is + ``ACTIVE``, ``INACTIVE``, ``ERROR``, ``PENDING_CREATE``, + ``PENDING_UPDATE``, or ``PENDING_DELETE``. + in: body + required: true + type: string +status_description: + description: | + Human-readable description of the status. + in: body + required: true + type: string +subnet: + description: | + The number of subnets allowed for each tenant. + in: body + required: true + type: integer +subnet_1: + description: | + The number of subnets allowed for each tenant. + in: body + required: false + type: integer subnet_id: description: | If you specify only a subnet UUID, OpenStack @@ -391,12 +3607,98 @@ subnet_id_1: in: body required: true type: string +subnet_id_3: + description: | + (Deprecated) The subnet where the tenant wants + the VPN service. + in: body + required: false + type: string +subnet_id_4: + description: | + (Deprecated) The subnet where the tenant wants + the VPN service. + in: body + required: true + type: string +subnet_id_5: + description: | + The UUID of the subnet. + in: body + required: true + type: string +subnet_id_6: + description: | + If you omit this parameter, LBaaS uses the + ``vip_subnet_id`` parameter value for the subnet UUID. + in: body + required: false + type: integer +subnet_id_7: + description: | + The UUID of the subnet on which to allocate the + virtual IP (VIP) address. + in: body + required: true + type: string +subnet_ip_availability: + description: | + This is dictionary showing subnet IP + availability. It contains information for every subnet associated + to each network as described in the parameters. + in: body + required: true + type: array +subnet_name: + description: | + The name of the subnet. + in: body + required: true + type: string +subnetpool: + description: | + A ``subnetpool`` object. + in: body + required: true + type: object +subnetpool_1: + description: | + The number of subnet pools allowed for each + tenant. + in: body + required: true + type: integer +subnetpool_2: + description: | + The number of subnet pools allowed for each + tenant. + in: body + required: false + type: integer +subnetpools: + description: | + A list of ``subnetpool`` objects. + in: body + required: true + type: array subnets: description: | The associated subnets. in: body required: true type: array +subnets_1: + description: | + The associated subnets. + in: body + required: true + type: array +tags: + description: | + The list of tags on the resource. + in: body + required: true + type: array tenant_id: description: | The UUID of the tenant who owns the network. Only @@ -411,6 +3713,85 @@ tenant_id_1: in: body required: true type: string +tenant_id_10: + description: | + The UUID of the tenant who owns the load + balancer. Only administrative users can specify a tenant UUID + other than their own. + in: body + required: true + type: string +tenant_id_11: + description: | + The UUID of the tenant who owns the member. Only + administrative users can specify a tenant UUID other than their + own. + in: body + required: true + type: string +tenant_id_12: + description: | + The UUID of the tenant who owns the member. Only + administrative users can specify a tenant UUID other than their + own. + in: body + required: false + type: string +tenant_id_13: + description: | + The tenant UUID for the metering label. + in: body + required: true + type: string +tenant_id_14: + description: | + 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. + in: body + required: false + type: string +tenant_id_15: + description: | + The tenant UUID of QoS policy owner. Only + administrative users can specify a tenant UUID other than their + own. You cannot change this value through authorization policies. + in: body + required: false + type: string +tenant_id_16: + description: | + The UUID of the tenant who owns the pool. Only + administrative users can specify a tenant UUID other than their + own. + in: body + required: false + type: string +tenant_id_17: + description: | + The UUID of the tenant who owns the security + group rule. Only administrative users can specify a tenant UUID + other than their own. + in: body + required: true + type: string +tenant_id_18: + description: | + The UUID of the tenant who owns the security + group. Only administrative users can specify a tenant UUID other + than their own. + in: body + required: false + type: string +tenant_id_19: + description: | + 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. + in: body + required: false + type: string tenant_id_2: description: | The UUID of the tenant who owns the network. Only @@ -419,6 +3800,287 @@ tenant_id_2: in: body required: true type: string +tenant_id_20: + description: | + The UUID of the tenant who owns the VIP. Only + administrative users can specify a tenant UUID other than their + own. + in: body + required: false + type: string +tenant_id_21: + description: | + Owner of the VPN endpoint group. Only + administrative users can specify a tenant UUID other than their + own. + in: body + required: true + type: string +tenant_id_22: + description: | + Owner of the VPN service. Only administrative + users can specify a tenant UUID other than their own. + in: body + required: false + type: string +tenant_id_23: + description: | + The UUID of the tenant who owns the firewall + policy. + in: body + required: true + type: string +tenant_id_24: + description: | + The UUID of the tenant who owns the firewall + rule. + in: body + required: true + type: string +tenant_id_25: + description: | + The UUID of the tenant who owns the health + monitor. Only administrative users can specify a tenant UUID other + than their own. + in: body + required: true + type: string +tenant_id_26: + description: | + The owner of the VPN service. Only administrative + users can specify a tenant UUID other than their own. + in: body + required: true + type: string +tenant_id_27: + description: | + Owner of the VPN service. Only administrative + users can specify a tenant UUID other than their own. + in: body + required: true + type: string +tenant_id_28: + description: | + The UUID of the tenant who owns the VIP. Only + administrative users can specify a tenant UUID other than their + own. + in: body + required: true + type: string +tenant_id_29: + description: | + The UUID of the tenant who owns the network. + in: body + required: true + type: string +tenant_id_3: + description: | + The owner of the firewall service. Only + administrative users can specify a tenant UUID other than their + own. + in: body + required: true + type: string +tenant_id_30: + description: | + The UUID of tenant or project. + in: body + required: true + type: string +tenant_id_31: + description: | + The UUID of the tenant who owns the QoS policy. + in: body + required: true + type: string +tenant_id_32: + description: | + The UUID of the tenant who owns the pool. Only + administrative users can specify a tenant UUID other than their + own. + in: body + required: true + type: string +tenant_id_34: + description: | + The UUID of the tenant who owns the subnet pool. + in: body + required: true + type: string +tenant_id_35: + description: | + The UUID of the tenant. + in: body + required: true + type: string +tenant_id_36: + description: | + The owner of the firewall policy. Only + administrative users can specify a tenant UUID other than their + own. + in: body + required: false + type: string +tenant_id_37: + description: | + The UUID of the tenant who owns the firewall + rule. Only administrative users can specify a tenant UUID other + than their own. + in: body + required: true + type: string +tenant_id_4: + description: | + The UUID of the tenant. Only administrative users + can specify a tenant UUID other than their own. + in: body + required: false + type: string +tenant_id_5: + description: | + The UUID of the tenant who owns the health + monitor. Only administrative users can specify a tenant UUID other + than their own. + in: body + required: false + type: string +tenant_id_6: + description: | + The owner of the IKE policy. Only administrative + users can specify a tenant UUID other than their own. + in: body + required: true + type: string +tenant_id_7: + description: | + Owner of the IPSec policy. Only administrative + users can specify a tenant UUID other than their own. + in: body + required: true + type: string +tenant_id_8: + description: | + Owner of the IPSec connection. Only + administrative users can specify a tenant UUID other than their + own. + in: body + required: true + type: string +tenant_id_9: + description: | + The UUID of the tenant who owns the listener. + Only administrative users can specify a tenant UUID other than + their own. + in: body + required: true + type: string +timeout: + description: | + The maximum time, in seconds, that a monitor + waits to connect before it times out. This value must be less than + the delay value. + in: body + required: true + type: integer +timeout_1: + description: | + 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. + in: body + required: false + type: integer +timeout_2: + description: | + 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. + in: body + required: true + type: integer +timeout_3: + description: | + The maximum time, in seconds, that a monitor + waits to connect before it times out. This value must be less than + the delay value. + in: body + required: false + type: integer +total_ips: + description: | + The total number of IP addresses in a network. + in: body + required: true + type: integer +transform_protocol: + description: | + The transform protocol. A valid value is ``ESP``, + ``AH``, or ``AH- ESP``. Default is ``ESP``. + in: body + required: false + type: string +transform_protocol_1: + description: | + The transform protocol. A valid value is ``ESP``, + ``AH``, or ``AH- ESP``. Default is ``ESP``. + in: body + required: true + type: string +type: + description: | + The type of probe sent by the load balancer to + verify the member state. A valid value is ``PING``, ``TCP``, + ``HTTP``, or ``HTTPS``. + in: body + required: true + type: string +type_1: + description: | + The type of QoS policy. + in: body + required: false + type: string +type_2: + description: | + The type of the endpoints in the group. A valid + value is ``subnet``, ``cidr``, ``network``, ``router``, or + ``vlan``. + in: body + required: true + type: string +type_3: + description: | + The type of probe sent by the load balancer to + verify the member state, which is ``PING``, ``TCP``, ``HTTP``, or + ``HTTPS``. + in: body + required: true + type: string +units: + description: | + 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. + in: body + required: false + type: string +units_1: + description: | + 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. + in: body + required: true + type: string +updated: + description: | + The date and time stamp when the extension was + last updated. + in: body + required: true + type: string updated_at: description: | Time at which port has been updated. @@ -431,4 +4093,151 @@ updated_at_1: in: body required: true type: string - +updated_at_2: + description: | + Time at which subnetpool has been updated. + in: body + required: true + type: string +url_path: + description: | + 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 (/). + in: body + required: false + type: string +url_path_1: + description: | + 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 (/). + in: body + required: false + type: string +url_path_2: + description: | + 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 (/). + in: body + required: true + type: string +used_ips: + description: | + The number of used IP addresses of all subnets in + a network. + in: body + required: true + type: integer +value: + description: | + 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. + in: body + required: false + type: integer +value_1: + description: | + 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. + in: body + required: true + type: integer +vip: + description: | + A ``vip`` object. + in: body + required: true + type: object +vip_address: + description: | + The IP address of the VIP. + format: ipv4 + in: body + required: false + type: string +vip_address_1: + description: | + The IP address of the VIP. + format: ipv4 + in: body + required: true + type: string +vip_id: + description: | + The UUID of the virtual IP (VIP) address. + in: body + required: true + type: string +vip_subnet_id: + description: | + The UUID of the subnet on which to allocate the + virtual IP (VIP) address. + in: body + required: true + type: string +vips: + description: | + A list of ``vip`` objects. + in: body + required: true + type: array +vlan_transparent: + description: | + The state of the network, which is VLAN + transparent (``true``) or not VLAN transparent (``false``). + in: body + required: true + type: boolean +vpnservice: + description: | + A ``vpnservice`` object. + in: body + required: true + type: object +vpnservice_id: + description: | + The UUID of the VPN service. + in: body + required: true + type: string +vpnservices: + description: | + A list of VPN service objects. + in: body + required: true + type: array +weight: + description: | + 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. + in: body + required: false + type: integer +weight_1: + description: | + 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. + in: body + required: false + type: integer +weight_2: + description: | + 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. + in: body + required: true + type: integer diff --git a/api-ref/source/v2-ext/port-binding.inc b/api-ref/source/v2/port-binding.inc similarity index 100% rename from api-ref/source/v2-ext/port-binding.inc rename to api-ref/source/v2/port-binding.inc diff --git a/api-ref/source/v2-ext/qos-ext.inc b/api-ref/source/v2/qos-ext.inc similarity index 100% rename from api-ref/source/v2-ext/qos-ext.inc rename to api-ref/source/v2/qos-ext.inc diff --git a/api-ref/source/v2-ext/quotas.inc b/api-ref/source/v2/quotas.inc similarity index 95% rename from api-ref/source/v2-ext/quotas.inc rename to api-ref/source/v2/quotas.inc index f6e26286d..d4bc07a1d 100644 --- a/api-ref/source/v2-ext/quotas.inc +++ b/api-ref/source/v2/quotas.inc @@ -38,7 +38,7 @@ Response Parameters - subnetpool: subnetpool - quotas: quotas - security_group_rule: security_group_rule - - security_group: security_group + - security_group: security_group_2 - router: router - rbac_policy: rbac_policy - port: port @@ -78,7 +78,7 @@ Response Parameters - subnetpool: subnetpool - quota: quota - security_group_rule: security_group_rule - - security_group: security_group + - security_group: security_group_2 - router: router - rbac_policy: rbac_policy - port: port @@ -111,7 +111,7 @@ Request - subnetpool: subnetpool - quota: quota - security_group_rule: security_group_rule - - security_group: security_group + - security_group: security_group_2 - router: router - rbac_policy: rbac_policy - port: port @@ -134,7 +134,7 @@ Response Parameters - subnetpool: subnetpool - quota: quota - security_group_rule: security_group_rule - - security_group: security_group + - security_group: security_group_2 - router: router - rbac_policy: rbac_policy - port: port diff --git a/api-ref/source/v2-ext/security-groups.inc b/api-ref/source/v2/security-groups.inc similarity index 100% rename from api-ref/source/v2-ext/security-groups.inc rename to api-ref/source/v2/security-groups.inc diff --git a/api-ref/source/v2-ext/security_group_rules.inc b/api-ref/source/v2/security_group_rules.inc similarity index 100% rename from api-ref/source/v2-ext/security_group_rules.inc rename to api-ref/source/v2/security_group_rules.inc diff --git a/api-ref/source/v2-ext/subnetpools-ext.inc b/api-ref/source/v2/subnetpools-ext.inc similarity index 100% rename from api-ref/source/v2-ext/subnetpools-ext.inc rename to api-ref/source/v2/subnetpools-ext.inc diff --git a/api-ref/source/v2-ext/tag-ext.inc b/api-ref/source/v2/tag-ext.inc similarity index 100% rename from api-ref/source/v2-ext/tag-ext.inc rename to api-ref/source/v2/tag-ext.inc diff --git a/api-ref/source/v2/versions-networks-v2.inc b/api-ref/source/v2/versions.inc similarity index 100% rename from api-ref/source/v2/versions-networks-v2.inc rename to api-ref/source/v2/versions.inc diff --git a/api-ref/source/v2-ext/vpnaas.inc b/api-ref/source/v2/vpnaas.inc similarity index 100% rename from api-ref/source/v2-ext/vpnaas.inc rename to api-ref/source/v2/vpnaas.inc