W3cubDocs

/Ansible

bigip_routedomain - Manage route domains on a BIG-IP

New in version 2.2.

Synopsis

  • Manage route domains on a BIG-IP

Requirements (on host that executes module)

  • f5-sdk

Options

parameter required default choices comments
bwc_policy
 no
The bandwidth controller for the route domain.
connection_limit
 no
The maximum number of concurrent connections allowed for the route domain. Setting this to 0 turns off connection limits.
description
 no
Specifies descriptive text that identifies the route domain.
flow_eviction_policy
 no
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.
id
 yes
The unique identifying integer representing the route domain.
parent
 no
Specifies the route domain the system searches when it cannot find a route in the configured domain.
password
 yes
The password for the user account used to connect to the BIG-IP. This option can be omitted if the environment variable F5_PASSWORD is set.
routing_protocol
 no
  • BFD
  • BGP
  • IS-IS
  • OSPFv2
  • OSPFv3
  • PIM
  • RIP
  • RIPng
Dynamic routing protocols for the system to use in the route domain.
server
 yes
The BIG-IP host. This option can be omitted if the environment variable F5_SERVER is set.
server_port
(added in 2.2)
 no 443
The BIG-IP server port. This option can be omitted if the environment variable F5_SERVER_PORT is set.
service_policy
 no
Service policy to associate with the route domain.
state
 no present
  • present
  • absent
Whether the route domain should exist or not.
strict
 no
  • enabled
  • disabled
Specifies whether the system enforces cross-routing restrictions or not.
user
 yes
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. This option can be omitted if the environment variable F5_USER is set.
validate_certs
(added in 2.0)
 no True
  • True
  • False
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. This option can be omitted if the environment variable F5_VALIDATE_CERTS is set.
vlans
 no
VLANs for the system to use in the route domain

Examples

- name: Create a route domain
  bigip_routedomain:
      id: "1234"
      password: "secret"
      server: "lb.mydomain.com"
      state: "present"
      user: "admin"
  delegate_to: localhost

- 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

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

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

Notes

Note

  • Requires the f5-sdk Python package on the host. This is as easy as pip install f5-sdk.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/bigip_routedomain_module.html