ansible.builtin.bigip_routedomain (v2.4.6.0-1) — module

Manage route domains on a BIG-IP

| "added in version" 2.2 of ansible.builtin"

Authors: Tim Rupp (@caphrim007)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.4.6.0.post1

Description

Manage route domains on a BIG-IP


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create a route domain
  bigip_routedomain:
      id: "1234"
      password: "secret"
      server: "lb.mydomain.com"
      state: "present"
      user: "admin"
  delegate_to: localhost
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Set VLANs on the route domain
  bigip_routedomain:
      id: "1234"
      password: "secret"
      server: "lb.mydomain.com"
      state: "present"
      user: "admin"
      vlans:
          - net1
          - foo
  delegate_to: localhost

Inputs

    
id:
    description:
    - The unique identifying integer representing the route domain.
    required: true

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Whether the route domain should exist or not.
    required: false

vlans:
    description:
    - VLANs for the system to use in the route domain

parent:
    description: Specifies the route domain the system searches when it cannot find a
      route in the configured domain.
    required: false

strict:
    choices:
    - enabled
    - disabled
    description:
    - Specifies whether the system enforces cross-routing restrictions or not.

provider:
    description:
    - A dict object containing connection details.
    suboptions:
      auth_provider:
        description:
        - Configures the auth provider for to obtain authentication tokens from the remote
          device.
        - This option is really used when working with BIG-IQ devices.
        type: str
      password:
        aliases:
        - pass
        - pwd
        description:
        - The password for the user account used to connect to the BIG-IP.
        - You may omit this option by setting the environment variable C(F5_PASSWORD).
        required: true
        type: str
      server:
        description:
        - The BIG-IP host.
        - You may omit this option by setting the environment variable C(F5_SERVER).
        required: true
        type: str
      server_port:
        default: 443
        description:
        - The BIG-IP server port.
        - You may omit this option by setting the environment variable C(F5_SERVER_PORT).
        type: int
      ssh_keyfile:
        description:
        - Specifies the SSH keyfile to use to authenticate the connection to the remote
          device.  This argument is only used for I(cli) transports.
        - You may omit this option by setting the environment variable C(ANSIBLE_NET_SSH_KEYFILE).
        type: path
      timeout:
        description:
        - Specifies the timeout in seconds for communicating with the network device for
          either connecting or sending commands.  If the timeout is exceeded before the
          operation is completed, the module will error.
        type: int
      transport:
        choices:
        - cli
        - rest
        default: rest
        description:
        - Configures the transport connection to use when connecting to the remote device.
        type: str
      user:
        description:
        - The username to connect to the BIG-IP with. This user must have administrative
          privileges on the device.
        - You may omit this option by setting the environment variable C(F5_USER).
        required: true
        type: str
      validate_certs:
        default: true
        description:
        - If C(no), SSL certificates are not validated. Use this only on personally controlled
          sites using self-signed certificates.
        - You may omit this option by setting the environment variable C(F5_VALIDATE_CERTS).
        type: bool
    type: dict
    version_added: '2.5'
    version_added_collection: f5networks.f5_modules

bwc_policy:
    description:
    - The bandwidth controller for the route domain.

description:
    description:
    - Specifies descriptive text that identifies the route domain.

service_policy:
    description:
    - Service policy to associate with the route domain.

connection_limit:
    description:
    - The maximum number of concurrent connections allowed for the route domain. Setting
      this to C(0) turns off connection limits.

routing_protocol:
    choices:
    - BFD
    - BGP
    - IS-IS
    - OSPFv2
    - OSPFv3
    - PIM
    - RIP
    - RIPng
    description:
    - Dynamic routing protocols for the system to use in the route domain.

flow_eviction_policy:
    description:
    - The eviction policy to use with this route domain. Apply an eviction policy to provide
      customized responses to flow overflows and slow flows on the route domain.

Outputs

bwc_policy:
  description: The new bandwidth controller
  returned: changed
  sample: /Common/foo
  type: string
connection_limit:
  description: The new connection limit for the route domain
  returned: changed
  sample: 100
  type: int
description:
  description: The description of the route domain
  returned: changed
  sample: route domain foo
  type: string
flow_eviction_policy:
  description: The new eviction policy to use with this route domain
  returned: changed
  sample: /Common/default-eviction-policy
  type: string
id:
  description: The ID of the route domain that was changed
  returned: changed
  sample: 2
  type: int
parent:
  description: The new parent route domain
  returned: changed
  sample: 0
  type: int
routing_protocol:
  description: List of routing protocols applied to the route domain
  returned: changed
  sample:
  - bfd
  - bgp
  type: list
service_policy:
  description: The new service policy to use with this route domain
  returned: changed
  sample: /Common-my-service-policy
  type: string
strict:
  description: The new strict isolation setting
  returned: changed
  sample: enabled
  type: string
vlans:
  description: List of new VLANs the route domain is applied to
  returned: changed
  sample:
  - /Common/http-tunnel
  - /Common/socks-tunnel
  type: list