Try SpotterManage Self-IPs on a BIG-IP system
| "added in version" 1.0.0 of f5networks.f5_modules"
Authors: Tim Rupp (@caphrim007), Wojciech Wypior (@wojtek0806)
Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0
collections:
- name: f5networks.f5_modules
version: 1.28.0Manage Self-IP addresses on a BIG-IP system.
- name: Create Self IP
bigip_selfip:
address: 10.10.10.10
name: self1
netmask: 255.255.255.0
vlan: vlan1
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Create Self IPv6
bigip_selfip:
address: fe80::10
name: self2
netmask: "ffff:ffff:ffff:ffff::"
vlan: vlan1
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Create Self IP with a Route Domain
bigip_selfip:
name: self1
address: 10.10.10.10
netmask: 255.255.255.0
vlan: vlan1
route_domain: 10
allow_service: default
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Delete Self IP
bigip_selfip:
name: self1
state: absent
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Allow management web UI to be accessed on this Self IP
bigip_selfip:
name: self1
state: absent
allow_service:
- tcp:443
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Allow HTTPS and SSH access to this Self IP
bigip_selfip:
name: self1
state: absent
allow_service:
- tcp:443
- tcp:22
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Allow all services access to this Self IP
bigip_selfip:
name: self1
state: absent
allow_service:
- all
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Allow only GRE and IGMP protocols access to this Self IP
bigip_selfip:
name: self1
state: absent
allow_service:
- gre:0
- igmp:0
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Allow all TCP, but no other protocols access to this Self IP
bigip_selfip:
name: self1
state: absent
allow_service:
- tcp:0
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
name:
description:
- The name of the self IP to create.
- If this parameter is not specified, it defaults to the value supplied in the C(address)
parameter.
required: true
type: str
vlan:
description:
- The VLAN for the new self IPs. When creating a new self IP, this value is required.
type: str
state:
choices:
- absent
- present
default: present
description:
- When C(present), guarantees the self IP exists with the provided attributes.
- When C(absent), removes the self IP from the system.
type: str
address:
description:
- The IP addresses for the new self IP. This value is ignored upon update as addresses
themselves cannot be changed after they are created.
- This value is required when creating new self IPs.
- IPv4 and IPv6 are supported.
type: str
netmask:
description:
- The netmask for the self IP. When creating a new self IP, this value is required.
type: str
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:
- Device partition to manage resources on. You can set different partitions for self
IPs, but the address used may not match any other address used by a self IP. Thus,
self IPs are not isolated by partitions as other resources on a BIG-IP are.
type: str
description:
description:
- Description of the traffic selector.
type: str
route_domain:
description:
- The route domain id of the system. When creating a new self IP, if this value is
not specified, the default value is C(0).
- This value cannot be changed after it is set.
type: int
allow_service:
description:
- Configure port lockdown for the self IP. By default, the self IP has a "default
deny" policy. This can be changed to allow TCP and UDP ports, as well as specific
protocols. This list should contain C(protocol):C(port) values.
elements: str
type: list
traffic_group:
description:
- The traffic group for the self IP addresses in an active-active, redundant load
balancer configuration. When creating a new self IP, if this value is not specified,
the default is C(/Common/traffic-group-local-only).
type: str
fw_enforced_policy:
description:
- Specifies an AFM policy to attach to Self IP.
type: str
version_added: 1.1.0
version_added_collection: f5networks.f5_modules
address: description: The address for the self IP. returned: changed sample: 192.0.2.10 type: str allow_service: description: Services that are allowed via this self IP. returned: changed sample: - igmp:0 - tcp:22 - udp:53 type: list fw_enforced_policy: description: Specifies an AFM policy to be attached to the self IP. returned: changed sample: /Common/afm-blocking-policy type: str name: description: The name of the self IP. returned: created sample: self1 type: str netmask: description: The netmask of the self IP. returned: changed sample: 255.255.255.0 type: str traffic_group: description: The traffic group of which the self IP is a member. returned: changed sample: traffic-group-local-only type: str vlan: description: The VLAN set on the self IP. returned: changed sample: vlan1 type: str