f5networks.f5_modules.bigip_routedomain – Manage route domains on a BIG-IP

Note

This plugin is part of the f5networks.f5_modules collection (version 1.12.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install f5networks.f5_modules.

To use it in a playbook, specify: f5networks.f5_modules.bigip_routedomain.

New in version 1.0.0: of f5networks.f5_modules

Synopsis

  • Manage route domains on a BIG-IP system. A route domain is a BIG-IP configuration object that isolates network traffic for a particular application on the network.

Parameters

Parameter Choices/Defaults Comments
bwc_policy
string
The bandwidth controller for the route domain.
connection_limit
integer
The maximum number of concurrent connections allowed for the route domain. Setting this to 0 turns off connection limits.
description
string
Specifies descriptive text that identifies the route domain.
flow_eviction_policy
string
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.
fw_enforced_policy
string
Specifies an AFM policy to be attached to route domain.
To remove attached AFM policy use "" or none as values.
id
integer
The unique identifying integer representing the route domain.
This field is required when creating a new route domain.
In version 2.5, this value is no longer used to reference a route domain when making modifications to it (for instance during update and delete operations). Instead, the name parameter is used. In version 2.6, the name value will become a required parameter.
name
string
The name of the route domain.
parent
string
Specifies the route domain the system searches when it cannot find a route in the configured domain.
partition
string
Default:
"Common"
Partition on which you want to create the route domain. Partitions cannot be updated once they are created.
provider
dictionary
added in 1.0.0 of f5networks.f5_modules
A dict object containing connection details.
auth_provider
string
Configures the auth provider for to obtain authentication tokens from the remote device.
This option is really used when working with BIG-IQ devices.
no_f5_teem
boolean
    Choices:
  • no ←
  • yes
If yes, TEEM telemetry data is not sent to F5.
You may omit this option by setting the environment variable F5_TELEMETRY_OFF.
Previously used variable F5_TEEM is deprecated as its name was confusing.
password
string / required
The password for the user account used to connect to the BIG-IP.
You may omit this option by setting the environment variable F5_PASSWORD.

aliases: pass, pwd
server
string / required
The BIG-IP host.
You may omit this option by setting the environment variable F5_SERVER.
server_port
integer
Default:
443
The BIG-IP server port.
You may omit this option by setting the environment variable F5_SERVER_PORT.
timeout
integer
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.
transport
string
    Choices:
  • rest ←
Configures the transport connection to use when connecting to the remote device.
user
string / required
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 F5_USER.
validate_certs
boolean
    Choices:
  • no
  • yes ←
If 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 F5_VALIDATE_CERTS.
routing_protocol
list / elements=string
    Choices:
  • none
  • BFD
  • BGP
  • IS-IS
  • OSPFv2
  • OSPFv3
  • PIM
  • RIP
  • RIPng
Dynamic routing protocols for the system to use in the route domain.
service_policy
string
Service policy to associate with the route domain.
state
string
    Choices:
  • present ←
  • absent
Whether the route domain should exist or not.
strict
boolean
    Choices:
  • no
  • yes
Specifies whether the system enforces cross-routing restrictions or not.
vlans
list / elements=string
VLANs for the system to use in the route domain.

Notes

Note

  • For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
  • Requires BIG-IP software version >= 12.
  • The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the f5networks.f5_modules.bigip_config module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration.

Examples

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

- name: Set VLANs on the route domain
  bigip_routedomain:
    name: bar
    state: present
    vlans:
      - net1
      - foo
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Return Values

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

Key Returned Description
bwc_policy
string
changed
The new bandwidth controller.

Sample:
/Common/foo
connection_limit
integer
changed
The new connection limit for the route domain.

Sample:
100
description
string
changed
The description of the route domain.

Sample:
route domain foo
flow_eviction_policy
string
changed
The new eviction policy to use with this route domain.

Sample:
/Common/default-eviction-policy
fw_enforced_policy
string
changed
Specifies the AFM policy to be attached to route domain.

Sample:
/Common/afm-blocking-policy
id
integer
changed
The ID of the route domain that was changed.

Sample:
2
parent
integer
changed
The new parent route domain.
routing_protocol
list / elements=string
changed
List of routing protocols applied to the route domain.

Sample:
['bfd', 'bgp']
service_policy
string
changed
The new service policy to use with this route domain.

Sample:
/Common-my-service-policy
strict
string
changed
The new strict isolation setting.

Sample:
enabled
vlans
list / elements=string
changed
List of new VLANs to which the route domain is applied.

Sample:
['/Common/http-tunnel', '/Common/socks-tunnel']


Authors

  • Tim Rupp (@caphrim007)
  • Wojciech Wypior (@wojtek0806)

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