f5networks.f5_modules.bigip_routedomain module – Manage route domains on a BIG-IP
Note
This module is part of the f5networks.f5_modules collection (version 1.32.1).
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 f5networks.f5_modules 1.0.0
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 |
Comments |
---|---|
The bandwidth controller for the route domain. |
|
The maximum number of concurrent connections allowed for the route domain. Setting this to |
|
Specifies descriptive text that identifies the route domain. |
|
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. |
|
Specifies an AFM policy to be attached to route domain. To remove attached AFM policy use |
|
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 |
|
The name of the route domain. |
|
Specifies the route domain the system searches when it cannot find a route in the configured domain. |
|
Partition on which you want to create the route domain. Partitions cannot be updated once they are created. Default: |
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
The password for the user account used to connect to the BIG-IP or the BIG-IQ. You may omit this option by setting the environment variable |
|
The BIG-IP host or the BIG-IQ host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: |
|
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. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative privileges on the device. You may omit this option by setting the environment variable |
|
If You may omit this option by setting the environment variable Choices:
|
|
Dynamic routing protocols for the system to use in the route domain. Choices:
|
|
Service policy to associate with the route domain. |
|
Whether the route domain should exist or not. Choices:
|
|
Specifies whether the system enforces cross-routing restrictions or not. Choices:
|
|
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 |
Description |
---|---|
The new bandwidth controller. Returned: changed Sample: |
|
The new connection limit for the route domain. Returned: changed Sample: |
|
The description of the route domain. Returned: changed Sample: |
|
The new eviction policy to use with this route domain. Returned: changed Sample: |
|
Specifies the AFM policy to be attached to route domain. Returned: changed Sample: |
|
The ID of the route domain that was changed. Returned: changed Sample: |
|
The new parent route domain. Returned: changed Sample: |
|
List of routing protocols applied to the route domain. Returned: changed Sample: |
|
The new service policy to use with this route domain. Returned: changed Sample: |
|
The new strict isolation setting. Returned: changed Sample: |
|
List of new VLANs to which the route domain is applied. Returned: changed Sample: |