Try SpotterManage LTM virtual addresses on a BIG-IP.
| "added in version" 2.4 of ansible.builtin"
Authors: Tim Rupp (@caphrim007)
preview | supported by community
pipInstall with pip install ansible==2.4.6.0.post1
Manage LTM virtual addresses on a BIG-IP.
- name: Add virtual address
bigip_virtual_address:
server: "lb.mydomain.net"
user: "admin"
password: "secret"
state: "present"
partition: "Common"
address: "10.10.10.10"
delegate_to: localhost
- name: Enable route advertisement on the virtual address
bigip_virtual_address:
server: "lb.mydomain.net"
user: "admin"
password: "secret"
state: "present"
address: "10.10.10.10"
use_route_advertisement: yes
delegate_to: localhost
state:
choices:
- present
- absent
- enabled
- disabled
default: present
description:
- The virtual address state. If C(absent), an attempt to delete the virtual address
will be made. This will only succeed if this virtual address is not in use by a
virtual server. C(present) creates the virtual address and enables it. If C(enabled),
enable the virtual address if it exists. If C(disabled), create the virtual address
if needed, and set state to C(disabled).
address:
aliases:
- name
description:
- Virtual address. This value cannot be modified after it is set.
required: true
netmask:
default: 255.255.255.255
description:
- Netmask of the provided virtual address. This value cannot be modified after it
is set.
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
password:
aliases:
- pass
- pwd
description:
- The password for the user account used to connect to the BIG-IP.
- You may omit this option by setting the environment variable C(F5_PASSWORD).
required: true
type: str
server:
description:
- The BIG-IP 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
ssh_keyfile:
description:
- Specifies the SSH keyfile to use to authenticate the connection to the remote
device. This argument is only used for I(cli) transports.
- You may omit this option by setting the environment variable C(ANSIBLE_NET_SSH_KEYFILE).
type: path
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:
- cli
- 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 with. 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: '2.5'
version_added_collection: f5networks.f5_modules
arp_state:
choices:
- enabled
- disabled
description:
- Specifies whether the system accepts ARP requests. When (disabled), specifies that
the system does not accept ARP requests. Note that both ARP and ICMP Echo must be
disabled in order for forwarding virtual servers using that virtual address to forward
ICMP packets. If (enabled), then the packets are dropped.
icmp_echo:
choices:
- enabled
- disabled
- selective
description:
- Specifies how the systems sends responses to (ICMP) echo requests on a per-virtual
address basis for enabling route advertisement. When C(enabled), the BIG-IP system
intercepts ICMP echo request packets and responds to them directly. When C(disabled),
the BIG-IP system passes ICMP echo requests through to the backend servers. When
(selective), causes the BIG-IP system to internally enable or disable responses
based on virtual server state; C(when_any_available), C(when_all_available, or C(always),
regardless of the state of any virtual servers.
auto_delete:
choices:
- enabled
- disabled
description:
- Specifies whether the system automatically deletes the virtual address with the
deletion of the last associated virtual server. When C(disabled), specifies that
the system leaves the virtual address even when all associated virtual servers have
been deleted. When creating the virtual address, the default value is C(enabled).
advertise_route:
choices:
- always
- when_all_available
- when_any_available
description:
- Specifies what routes of the virtual address the system advertises. When C(when_any_available),
advertises the route when any virtual server is available. When C(when_all_available),
advertises the route when all virtual servers are available. When (always), always
advertises the route regardless of the virtual servers available.
connection_limit:
description:
- Specifies the number of concurrent connections that the system allows on this virtual
address.
use_route_advertisement:
choices:
- true
- false
description:
- Specifies whether the system uses route advertisement for this virtual address.
When disabled, the system does not advertise routes for this virtual address.
address: description: The address of the virtual address. returned: created sample: 2345 type: int arp_state: description: The new way the virtual address handles ARP requests. returned: changed sample: disabled type: string auto_delete: description: New setting for auto deleting virtual address. returned: changed sample: enabled type: string connection_limit: description: The new connection limit of the virtual address. returned: changed sample: 1000 type: int icmp_echo: description: New ICMP echo setting applied to virtual address. returned: changed sample: disabled type: string netmask: description: The netmask of the virtual address. returned: created sample: 2345 type: int state: description: The new state of the virtual address. returned: changed sample: disabled type: string use_route_advertisement: description: The new setting for whether to use route advertising or not. returned: changed sample: true type: bool