Try SpotterManages external LTM monitors on a BIG-IP
| "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.0Manages external LTM monitors on a BIG-IP device.
- name: Create an external monitor
bigip_monitor_external:
name: foo
state: present
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Create an external monitor with variables
bigip_monitor_external:
name: foo
timeout: 10
variables:
var1: foo
var2: bar
state: present
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Add a variable to an existing set
bigip_monitor_external:
name: foo
timeout: 10
variables:
var1: foo
var2: bar
cat: dog
state: present
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
ip:
description:
- IP address part of the IP/port definition. If this parameter is not provided when
creating a new monitor, the default value will be '*'.
type: str
name:
description:
- Specifies the name of the monitor.
required: true
type: str
port:
description:
- Port address part of the IP/port definition. If this parameter is not provided when
creating a new monitor, then the default value will be '*'. If specifying an IP
address, you must use a value between 1 and 65535.
type: str
state:
choices:
- present
- absent
default: present
description:
- When C(present), ensures the monitor exists.
- When C(absent), ensures the monitor is removed.
type: str
parent:
default: /Common/external
description:
- The parent template of this monitor template. Once this value has been set, it cannot
be changed. By default, this value is the C(external) parent on the C(Common) partition.
type: str
timeout:
description:
- The number of seconds in which the node or service must respond to the monitor request.
- If the target responds within the set time period, it is considered up.
- If the target does not respond within the set time period, it is considered down.
- You can change this to any number, however, it should be 3 times the interval number
of seconds plus 1 second.
- If this parameter is not provided when creating a new monitor, the default value
will be C(16).
type: int
interval:
description:
- The interval specifying how frequently the monitor instance of this template will
run. If this parameter is not provided when creating a new monitor, the default
value will be 5. This value B(must) be less than the C(timeout) value.
type: int
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
arguments:
description:
- Specifies any command-line arguments the script requires.
type: str
partition:
default: Common
description:
- Device partition to manage resources on.
type: str
variables:
description:
- Specifies any variables the script requires.
- Note that double quotes in values will be suppressed.
type: dict
description:
description:
- The description of the monitor.
type: str
external_program:
description:
- Specifies the name of the file for the monitor to use. In order to reference a file,
you must first import it using options on the B(System > File Management > External
Monitor Program File List > Import) screen. The BIG-IP system automatically places
the file in the proper location on the file system.
type: str
description: description: The description of the monitor. returned: changed sample: Important Monitor type: str interval: description: The new interval at which to run the monitor check. returned: changed sample: 2 type: int ip: description: The new IP of IP/port definition. returned: changed sample: 10.12.13.14 type: str parent: description: New parent template of the monitor. returned: changed sample: external type: str timeout: description: The new timeout in which the remote system must respond to the monitor. returned: changed sample: 10 type: int