deb-python-neutron-lib/api-ref/source/v2/parameters.yaml

# 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
project_id:
  description: |
    The ID of the project.
  in: path
  required: true
  type: string
project_id-path:
  description: |
    The ID of the project.
  in: path
  required: true
  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 ID of the router.
  in: path
  required: true
  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
segment_id-path:
  description: |
    The UUID of the segment.
  in: path
  required: true
  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
trunk_id:
  description: |
    The ID of the trunk.
  in: path
  required: true
  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.
    If no ``fields`` query parameter is specified,
    the networking API returns all attributes allowed by the policy settings.
    By using ``fields`` parameter, the API returns only the requested set of
    attributes. ``fields`` parameter can be specified multiple times.
    For example, if you specify ``fields=id&fields=name`` in the request URL,
    only ``id`` and ``name`` attributes will be returned.
  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 resource, which is
    up (``true``) or down (``false``).
  in: body
  required: true
  type: boolean
admin_state_up-request:
  description: |
    The administrative state of the resource, which is
    up (``true``) or down (``false``).
    Default is ``true``.
  in: body
  required: false
  type: boolean
admin_state_up_1:
  description: |
    The administrative status of the port, which 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 network, which is
    up (``true``) or down (``false``).
  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
    (``true``) or down (``false``).
  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
admin_state_up_trunk:
  description: |
    The administrative state of the trunk, 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
    address pair contains an IP address and MAC address.
  in: body
  required: false
  type: array
allowed_address_pairs_1:
  description: |
    A set of zero or more allowed address pairs. An
    address pair consists of an IP address and MAC address.
  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.
  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
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
created_at_resource:
  description: |
    Time at which the resource has been created (in UTC ISO8601 format).
  in: body
  required: true
  type: string
default:
  description: |
    Defines whether the provider is the default for
    the service type. If this value is ``true``, the provider is the
    default. If this value is ``false``, the provider is not the
    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-project quota on the prefix space that can
    be allocated from the subnet pool for project 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
    projects that use the subnet pool have the same prefix quota
    applied.
  in: body
  required: false
  type: integer
default_quota_1:
  description: |
    A per-project quota on the prefix space that can
    be allocated from the subnet pool for project 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
    projects that use the subnet pool have the same prefix quota
    applied.
  in: body
  required: true
  type: integer
default_quota_2:
  description: |
    A per-project quota on the prefix space that can
    be allocated from the subnet pool for project 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
    projects 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 project 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 resource.
  in: body
  required: true
  type: string
description-request:
  description: |
    The human-readable description for the resource.
  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
description_resource:
  description: |
    The description for the resource.
  in: body
  required: true
  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
    example, a virtual server.
  in: body
  required: false
  type: string
device_id_1:
  description: |
    The UUID of the device that uses this port. For
    example, a virtual server.
  in: body
  required: true
  type: string
device_owner:
  description: |
    The UUID of the entity that uses this port. For
    example, a DHCP agent.
  in: body
  required: false
  type: string
device_owner_1:
  description: |
    The UUID of the entity that uses this port. For
    example, a DHCP agent.
  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
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: object
dscp_marking_rules:
  description: |
    A list of ``dscp_marking_rule`` objects.
  in: body
  required: true
  type: array
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: |
    An ``extension`` object.
  in: body
  required: true
  type: object
extensions:
  description: |
    A list of ``extension`` objects.
  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
    option pair consists of an option value and name.
  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
    Networking allocates an available IP from that subnet to the port.
    If you specify both a subnet UUID and an IP address, OpenStack
    Networking tries to allocate the address to the port.
  in: body
  required: false
  type: array
fixed_ips_1:
  description: |
    The IP addresses for the port. Includes the IP
    address and UUID of the subnet.
  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
floatingips:
  description: |
    A list of ``floatingip`` objects.
  in: body
  required: true
  type: array
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.
  in: body
  required: true
  type: string
id_1:
  description: |
    The UUID of the port.
  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_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
id_resource:
  description: |
    The ID for the resource.
  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.
  in: body
  required: false
  type: string
ip_address_1:
  description: |
    The fixed IP address of the port.
  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.
  format: uri
  in: body
  required: true
  type: string
mac_address:
  description: |
    The MAC address of an allowed address pair.
  in: body
  required: false
  type: string
mac_address_1:
  description: |
    The MAC address.
  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: |
    Human-readable name of the resource.
  in: body
  required: true
  type: string
name-request:
  description: |
    Human-readable name of the resource.
    Default is an empty string.
  in: body
  required: false
  type: string
name-segment:
  description: |
    Human-readable name of the segment.
  in: body
  required: false
  type: string
name_1:
  description: |
    A symbolic name for the port.
  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_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
name_resource:
  description: |
    The name of the resource.
  in: body
  required: false
  type: string
network:
  description: |
    A ``network`` object.
  in: body
  required: true
  type: object
network_3:
  description: |
    A ``network`` object.
  in: body
  required: true
  type: object
network_id:
  description: |
    The UUID of the network.
  in: body
  required: true
  type: string
network_id_2:
  description: |
    The UUID of the attached network.
  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: object
network_name:
  description: |
    The name of the network.
  in: body
  required: true
  type: string
network_type:
  description: |
    The type of physical network that maps to this
    network resource. For example, ``flat``, ``vlan``, ``vxlan``, or
    ``gre``.
  in: body
  required: true
  type: string
networks:
  description: |
    A list of ``network`` objects.
  in: body
  required: true
  type: array
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.
  in: body
  required: false
  type: string
opt_name_1:
  description: |
    The extra DHCP option name.
  in: body
  required: true
  type: string
opt_value:
  description: |
    The extra DHCP option value.
  in: body
  required: false
  type: string
opt_value_1:
  description: |
    The extra DHCP option value.
  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_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_id_subport:
  description: |
    The ID of the subport.
  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. The status is enabled
    (``true``) or disabled (``false``).
  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
project_id-request:
  description: |
    The ID of the project that owns the resource.
    Only administrative users can specify a project ID other than their own.
    You cannot change this value through authorization policies.
  in: body
  required: false
  type: string
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
quota-floatingip:
  description: |
    The number of floating IP addresses allowed for
    each project.  A value of ``-1`` means no limit.
  in: body
  required: true
  type: integer
quota-network:
  description: |
    The number of networks allowed for each project.
  in: body
  required: true
  type: integer
quota-port:
  description: |
    The number of ports allowed for each project.
  in: body
  required: true
  type: integer
quota-rbac_policy:
  description: |
    The number of role-based access control (RBAC)
    policies for each project.
  in: body
  required: true
  type: integer
quota-router:
  description: |
    The number of routers allowed for each project.
  in: body
  required: true
  type: integer
quota-security_group:
  description: |
    The number of security groups allowed for each
    project.
  in: body
  required: true
  type: integer
quota-security_group_rule:
  description: |
    The number of security group rules allowed for
    each project.
  in: body
  required: true
  type: integer
quota-subnet:
  description: |
    The number of subnets allowed for each project.
  in: body
  required: true
  type: integer
quota-subnetpool:
  description: |
    The number of subnet pools allowed for each
    project.
  in: body
  required: true
  type: integer
quotas:
  description: |
    A list of quota objects.
  in: body
  required: true
  type: array
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
resource-collection:
  description: |
    Collection name of the resource.
  in: body
  required: true
  type: string
resource-href:
  description: |
    Link to the resource.
  in: body
  required: true
  type: string
resource-links:
  description: |
    List of links related to the resource. Each link is a dict with 'href' and 'rel'.
  in: body
  required: true
  type: array
resource-name:
  description: |
    Name of the resource.
  in: body
  required: true
  type: string
resource-rel:
  description: |
    Relationship between link and the resource.
  in: body
  required: true
  type: string
resources:
  description: |
    List of resource objects.
  in: body
  required: true
  type: array
revision_number:
  description: |
    The revision number of the resource.
  in: body
  required: true
  type: integer
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-availability_zone_hints:
  description: |
    The availability zone candidates for the router.
    It is available when ``router_availability_zone`` extension is enabled.
  in: body
  required: true
  type: array
router-availability_zone_hints-request:
  description: |
    The availability zone candidates for the router.
    It is available when ``router_availability_zone`` extension is enabled.
  in: body
  required: false
  type: array
router-availability_zones:
  description: |
    The availability zone(s) for the router.
    It is available when ``router_availability_zone`` extension is enabled.
  in: body
  required: true
  type: array
router-destination:
  description: |
    The destination CIDR.
  in: body
  required: true
  type: string
router-distributed:
  description: |
    ``true`` indicates a distributed router.
    It is available when ``dvr`` extension is enabled.
  in: body
  required: true
  type: boolean
router-distributed-request:
  description: |
    ``true`` indicates a distributed router.
    It is available when ``dvr`` extension is enabled.
  in: body
  required: false
  type: boolean
router-enable_snat:
  description: |
    Enable Source NAT (SNAT) attribute.
    ``true`` means Network Address Translation (NAT) is enabled
    for traffic generated by subnets attached to the router
    when the traffic is sent to/received from the external network.
    ``false`` means no NAT is applied for traffic from/to the external network.
    It is available when ``ext-gw-mode`` extension is enabled.
  in: body
  required: true
  type: boolean
router-enable_snat-request:
  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.
    It is available when ``ext-gw-mode`` extension is enabled.
  in: body
  required: false
  type: boolean
router-external_fixed_ips:
  description: |
    IP address(es) of the external gateway of the router.
    It is a list of IP addresses. Each element of the list
    is a dictionary of ``ip_address`` and ``subnet_id``.
  in: body
  required: true
  type: array
router-external_fixed_ips-request:
  description: |
    IP address(es) of the external gateway interface of the router.
    It is a list of IP addresses you would like to assign to the
    external gateway interface. Each element of ths list is
    a dictionary of ``ip_address`` and ``subnet_id``.
  in: body
  required: false
  type: array
router-external_gateway_info:
  description: |
    The external gateway information of the router.
    If the router has an external gateway, this would be a dict with
    ``network_id``, ``enable_snat`` and ``external_fixed_ips``.
    Otherwise, this would be ``null``.
  in: body
  required: true
  type: object
router-external_gateway_info-request:
  description: |
    The external gateway information of the router.
    If the router has an external gateway, this would be a dict with
    ``network_id``, ``enable_snat`` and ``external_fixed_ips``.
    Otherwise, this would be ``null``.
  in: body
  required: false
  type: object
router-ha:
  description: |
    ``true`` indicates a highly-available router.
    It is available when ``l3-ha`` extension is enabled.
  in: body
  required: true
  type: boolean
router-ha-request:
  description: |
    ``true`` indicates a highly-available router.
    It is available when ``l3-ha`` extension is enabled.
  in: body
  required: false
  type: boolean
router-id-body:
  description: |
    The ID of the router.
  in: body
  required: true
  type: string
router-name-request:
  description: |
    The router name.
  in: body
  required: false
  type: string
router-network_id:
  description: |
    Network ID which the router gateway is connected to.
  in: body
  required: true
  type: string
router-network_id-interface:
  description: |
    Network ID which the router interface is connected to.
  in: body
  required: true
  type: string
router-nexthop:
  description: |
    The IP address of the next hop for the corresponding destination.
    The next hop IP address must be a part of one of the subnets to
    which the router interfaces are connected.
  in: body
  required: true
  type: string
router-port_id:
  description: |
    The ID of the port which represents the router interface.
  in: body
  required: true
  type: string
router-port_id-request:
  description: |
    The ID of the port.
    One of ``subnet_id`` or ``port_id`` must be specified.
  in: body
  required: false
  type: string
router-project_id-interface:
  description: |
    The ID of the project who owns the router interface.
  in: body
  required: true
  type: string
router-routes:
  description: |
    The extra routes configuration for L3 router.
    A list of dictionaries with ``destination`` and ``nexthop`` parameters.
    It is available when ``extraroute`` extension is enabled.
  in: body
  required: true
  type: array
router-routes-request:
  description: |
    The extra routes configuration for L3 router.
    A list of dictionaries with ``destination`` and ``nexthop`` parameters.
    It is available when ``extraroute`` extension is enabled.
    Default is an empty list (``[]``).
  in: body
  required: false
  type: array
router-subnet_id:
  description: |
    The ID of the subnet which the router interface belongs to.
  in: body
  required: true
  type: string
router-subnet_id-request:
  description: |
    The ID of the subnet.
    One of ``subnet_id`` or ``port_id`` must be specified.
  in: body
  required: false
  type: string
router-subnet_ids:
  description: |
    A list of the ID of the subnet which the router interface belongs to.
    The list contains only one member.
  in: body
  required: true
  type: array
router:external:
  description: |
    Indicates whether this network can provide floating IPs via a router.
  in: body
  required: false
  type: boolean
router:external_1:
  description: |
    Indicates whether this network can provide floating IPs via a router.
  in: body
  required: true
  type: boolean
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
router_status:
  description: |
    The router status.
  in: body
  required: true
  type: string
routers:
  description: |
    A list of ``router`` objects.
  in: body
  required: true
  type: array
security_group:
  description: |
    A ``security_group`` object.
  in: body
  required: true
  type: object
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_rules:
  description: |
    A list of ``security_group_rule`` objects.
  in: body
  required: true
  type: array
security_groups:
  description: |
    One or more security group UUIDs.
  in: body
  required: false
  type: array
security_groups_1:
  description: |
    The UUIDs of any attached security groups.
  in: body
  required: true
  type: array
security_groups_2:
  description: |
    A list of ``security_group`` objects.
  in: body
  required: true
  type: array
segment_id:
  description: |
    The UUID of the segment.
  in: body
  required: true
  type: string
segmentation_id:
  description: |
    The segmentation ID for the subport.
  in: body
  required: false
  type: integer
segmentation_type:
  description: |
    The segmentation type for the subport.
  in: body
  required: false
  type: string
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.
  in: body
  required: true
  type: array
service_type:
  description: |
    The service type, which is ``CORE``, ``DUMMY``,
    ``FIREWALL``, ``FLAVORS``, ``L3_ROUTER_NAT``, ``LOADBALANCER``,
    ``LOADBALANCERV2``, ``METERING``, ``QOS``, or ``VPN``.
  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
    shared across all projects.
  in: body
  required: false
  type: boolean
shared_1:
  description: |
    Indicates whether this network is shared across
    all projects. By default, only administrative users can change this
    value.
  in: body
  required: true
  type: boolean
shared_10:
  description: |
    Indicates whether this policy is shared across
    all projects.
  in: body
  required: true
  type: boolean
shared_11:
  description: |
    Indicates whether this subnet pool is shared
    across all projects.
  in: body
  required: true
  type: boolean
shared_12:
  description: |
    Set to ``true`` to make this firewall policy
    visible to other projects. Default is ``false``.
  in: body
  required: false
  type: boolean
shared_13:
  description: |
    Set to ``true`` to share this firewall rule with
    other projects. Other projects can use a shared rule in firewall
    policies that this project 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 projects.
  in: body
  required: false
  type: boolean
shared_3:
  description: |
    Admin-only. Indicates whether this network is
    shared across all projects.
  in: body
  required: false
  type: boolean
shared_4:
  description: |
    Set to ``true`` to share this policy with other
    projects.  Default is ``false``.
  in: body
  required: false
  type: boolean
shared_5:
  description: |
    Admin-only. Indicates whether this subnet pool is
    shared across all projects.
  in: body
  required: false
  type: boolean
shared_6:
  description: |
    Indicates whether the firewall policy is shared
    across all projects.
  in: body
  required: true
  type: boolean
shared_7:
  description: |
    Indicates whether this firewall rule is shared
    with other projects. Other projects can use a shared rule in
    firewall policies that this project does not own.
  in: body
  required: true
  type: boolean
shared_8:
  description: |
    Indicates whether this metering label is shared
    across all projects.
  in: body
  required: true
  type: boolean
shared_9:
  description: |
    Indicates whether this network is shared across
    all projects.
  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.
  in: body
  required: true
  type: string
status_1:
  description: |
    The port status. Value is ``ACTIVE`` or ``DOWN``.
  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
sub_ports:
  description: |
    A list of ports associated with the trunk.
  in: body
  required: true
  type: array
subnet_id:
  description: |
    If you specify only a subnet UUID, OpenStack
    Networking allocates an available IP from that subnet to the port.
    If you specify both a subnet UUID and an IP address, OpenStack
    Networking tries to allocate the address to the port.
  in: body
  required: false
  type: string
subnet_id_1:
  description: |
    The UUID of the subnet to which the port is
    attached.
  in: body
  required: true
  type: string
subnet_id_3:
  description: |
    (Deprecated) The subnet where the VPN service should
    be provided.
  in: body
  required: false
  type: string
subnet_id_4:
  description: |
    (Deprecated) The subnet where the VPN service should
    be provided.
  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
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 ID of the project that owns the resource.
  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
trunk_details:
  description: |
    The details about the trunk.
  in: body
  required: false
  type: dict
trunk_port_id:
  description: |
    The ID of the parent port.
  in: body
  required: true
  type: string
trunk_status:
  description: |
    The status for the trunk. Possible values are  ``ACTIVE``,
    ``DOWN``, ``BUILD``, ``DEGRADED``, and ``ERROR``.
  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.
  in: body
  required: true
  type: string
updated_at_1:
  description: |
    Time at which the network has been updated.
  in: body
  required: true
  type: string
updated_at_2:
  description: |
    Time at which subnetpool has been updated.
  in: body
  required: true
  type: string
updated_at_resource:
  description: |
    Time at which the resource has been updated (in UTC ISO8601 format).
  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
version-href:
  description: |
    Link to the API.
  in: body
  required: true
  type: string
version-id:
  description: |
    Version of the API.
  in: body
  required: true
  type: string
version-links:
  description: |
    List of version links. Each link is a dict with 'href' and 'rel'.
  in: body
  required: true
  type: array
version-rel:
  description: |
    Relationship of link with the version.
  in: body
  required: true
  type: string
version-status:
  description: |
    Status of the API, which can be ``CURRENT``, ``STABLE`` or ``DEPRECATED``.
  in: body
  required: true
  type: string
versions:
  description: |
    List of versions.
  in: body
  required: true
  type: array
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_network_id:
  description: |
    The ID of the network on which to allocate
    the virtual IP (VIP) address. This option is
    required if no vip_subnet_id is given.
  in: body
  required: false
  type: string
vip_subnet_id:
  description: |
    The ID of the subnet on which to allocate the
    virtual IP (VIP) address. This option is required
    if no vip_network_id is given.
  in: body
  required: false
  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