| 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 added in 2.8 | Specifies AFM policy to be attached to route domain. | ||
| 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 added in 2.5 | 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 added in 2.5 | Default: "Common" | Partition to create the route domain on. Partitions cannot be updated once they are created. | |
| provider dictionary added in 2.5 | 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. | ||
| 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. | |
| ssh_keyfile path | 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 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 |
| 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 |
| 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 |
| 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 |
| Whether the route domain should exist or not. | |
| strict boolean |
| Specifies whether the system enforces cross-routing restrictions or not. | |
| vlans list | VLANs for the system to use in the route domain. | ||
Note
- 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
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 | Specfies 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 | 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'] |
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.9/modules/bigip_routedomain_module.html