New in version 2.2.
The below requirements are needed on the host that executes this module.
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: None | A dict object containing connection details. | |
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. | |
server required | The BIG-IP host. You may omit this option by setting the environment variable F5_SERVER . | ||
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 . | ||
server_port | Default: 443 | The BIG-IP server port. You may omit this option by setting the environment variable F5_SERVER_PORT . | |
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 | ||
validate_certs bool |
| 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 . | |
transport required |
| Configures the transport connection to use when connecting to the remote device. | |
routing_protocol |
| 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 |
| Whether the route domain should exist or not. | |
strict bool |
| 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 bool (added in 2.0) |
| 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. |
Note
pip install f5-sdk
.- 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
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 int | 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 int | changed | The ID of the route domain that was changed. Sample: 2 |
parent int | 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'] |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/bigip_routedomain_module.html