f5networks / f5networks.f5_modules / 1.28.0 / module / bigip_routedomain Manage route domains on a BIG-IP | "added in version" 1.0.0 of f5networks.f5_modules" Authors: Tim Rupp (@caphrim007), Wojciech Wypior (@wojtek0806)f5networks.f5_modules.bigip_routedomain (1.28.0) — module
Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0
collections: - name: f5networks.f5_modules version: 1.28.0
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.
- 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
id: description: - 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 C(name) parameter is used. In version 2.6, the C(name) value will become a required parameter. type: int name: description: - The name of the route domain. type: str state: choices: - present - absent default: present description: - Whether the route domain should exist or not. type: str vlans: description: - VLANs for the system to use in the route domain. elements: str type: list parent: description: - Specifies the route domain the system searches when it cannot find a route in the configured domain. type: str strict: description: - Specifies whether the system enforces cross-routing restrictions or not. type: bool provider: description: - A dict object containing connection details. suboptions: auth_provider: description: - Configures the auth provider for to obtain authentication tokens from the remote device. - This option is really used when working with BIG-IQ devices. type: str no_f5_teem: default: false description: - If C(yes), TEEM telemetry data is not sent to F5. - You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF). - Previously used variable C(F5_TEEM) is deprecated as its name was confusing. type: bool password: aliases: - pass - pwd description: - 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 C(F5_PASSWORD). required: true type: str server: description: - The BIG-IP host or the BIG-IQ host. - You may omit this option by setting the environment variable C(F5_SERVER). required: true type: str server_port: default: 443 description: - The BIG-IP server port. - You may omit this option by setting the environment variable C(F5_SERVER_PORT). type: int timeout: description: - 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. type: int transport: choices: - rest default: rest description: - Configures the transport connection to use when connecting to the remote device. type: str user: description: - 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 C(F5_USER). required: true type: str validate_certs: default: true description: - If C(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 C(F5_VALIDATE_CERTS). type: bool type: dict version_added: 1.0.0 version_added_collection: f5networks.f5_modules partition: default: Common description: - Partition on which you want to create the route domain. Partitions cannot be updated once they are created. type: str bwc_policy: description: - The bandwidth controller for the route domain. type: str description: description: - Specifies descriptive text that identifies the route domain. type: str service_policy: description: - Service policy to associate with the route domain. type: str connection_limit: description: - The maximum number of concurrent connections allowed for the route domain. Setting this to C(0) turns off connection limits. type: int routing_protocol: choices: - none - BFD - BGP - IS-IS - OSPFv2 - OSPFv3 - PIM - RIP - RIPng description: - Dynamic routing protocols for the system to use in the route domain. elements: str type: list fw_enforced_policy: description: - Specifies an AFM policy to be attached to route domain. - To remove attached AFM policy use C("") or C(none) as values. type: str flow_eviction_policy: description: - 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. type: str
bwc_policy: description: The new bandwidth controller. returned: changed sample: /Common/foo type: str connection_limit: description: The new connection limit for the route domain. returned: changed sample: 100 type: int description: description: The description of the route domain. returned: changed sample: route domain foo type: str flow_eviction_policy: description: The new eviction policy to use with this route domain. returned: changed sample: /Common/default-eviction-policy type: str fw_enforced_policy: description: Specifies the AFM policy to be attached to route domain. returned: changed sample: /Common/afm-blocking-policy type: str id: description: The ID of the route domain that was changed. returned: changed sample: 2 type: int parent: description: The new parent route domain. returned: changed sample: 0 type: int routing_protocol: description: List of routing protocols applied to the route domain. returned: changed sample: - bfd - bgp type: list service_policy: description: The new service policy to use with this route domain. returned: changed sample: /Common-my-service-policy type: str strict: description: The new strict isolation setting. returned: changed sample: enabled type: str vlans: description: List of new VLANs to which the route domain is applied. returned: changed sample: - /Common/http-tunnel - /Common/socks-tunnel type: list