bigip_routedomain – Manage route domains on a BIG-IP

New in version 2.2.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

Synopsis

Manage route domains on a BIG-IP.

Requirements

The below requirements are needed on the host that executes this module.

f5-sdk >= 3.0.16

Parameters

Parameter		Choices/Defaults	Comments
bwc_policy -			The bandwidth controller for the route domain.
connection_limit -			The maximum number of concurrent connections allowed for the route domain. Setting this to `0` turns off connection limits.
description -			Specifies descriptive text that identifies the route domain.
flow_eviction_policy -			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 -			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 - added in 2.5			The name of the route domain.
parent -			Specifies the route domain the system searches when it cannot find a route in the configured domain.
partition - added in 2.5		Default: "Common"	Partition to create the route domain on. Partitions cannot be updated once they are created.
password - / 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
provider - added in 2.5		Default: null	A dict object containing connection details.
	password - / 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 - / required		The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`.
	server_port -	Default: 443	The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`.
	ssh_keyfile -		Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. You may omit this option by setting the environment variable `ANSIBLE_NET_SSH_KEYFILE`.
	timeout -	Default: 10	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 - / required	rest cli ←	Configures the transport connection to use when connecting to the remote device.
	user - / 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	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 -		none BFD BGP IS-IS OSPFv2 OSPFv3 PIM RIP RIPng	Dynamic routing protocols for the system to use in the route domain.
server - / required			The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`.
server_port - added in 2.2		Default: 443	The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`.
service_policy -			Service policy to associate with the route domain.
state -		present ← absent	Whether the route domain should exist or not.
strict boolean		no yes	Specifies whether the system enforces cross-routing restrictions or not.
user - / 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 added in 2.0		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`.
vlans -			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 the f5-sdk Python package on the host. This is as easy as pip install f5-sdk.
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 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
    password: secret
    server: lb.mydomain.com
    state: present
    user: admin
  delegate_to: localhost

- name: Set VLANs on the route domain
  bigip_routedomain:
    name: bar
    password: secret
    server: lb.mydomain.com
    state: present
    user: admin
    vlans:
      - net1
      - foo
  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
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	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	changed	List of new VLANs the route domain is applied to. Sample: ['/Common/http-tunnel', '/Common/socks-tunnel']

Status

This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by an Ansible Partner. [certified]

Authors

Tim Rupp (@caphrim007)

Hint

If you notice any issues in this documentation you can edit this document to improve it.

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