Try SpotterManages F5 BIG-IP GTM HTTPS monitors
| "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 F5 BIG-IP GTM (now BIG-IP DNS) HTTPS monitors.
- name: Create a GTM HTTPS monitor
bigip_gtm_monitor_https:
name: my_monitor
ip: 1.1.1.1
port: 80
send: my send string
receive: my receive string
state: present
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Remove HTTPS Monitor
bigip_gtm_monitor_https:
name: my_monitor
state: absent
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Add HTTPS monitor for all addresses, port 514
bigip_gtm_monitor_https:
name: my_monitor
provider:
user: admin
password: secret
server: lb.mydomain.com
port: 514
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 is '*'.
- If this value is an IP address, a C(port) number must be specified.
type: str
name:
description:
- Monitor name.
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, the default value is '*'. If specifying an IP address, you
must specify a value between 1 and 65535.
type: str
send:
description:
- The send string for the monitor call.
- When creating a new monitor, if this parameter is not provided, the default of C(GET
/\r\n) is used.
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/https
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(https) parent on the C(Common) partition.
type: str
receive:
description:
- The receive string for the monitor call.
type: str
reverse:
description:
- Instructs the system to mark the target resource down when the test is successful.
This setting is useful, for example, if the content on your web site home page is
dynamic and changes frequently, you may want to set up a reverse ECV service check
that looks for the string Error.
- A match for this string means the web server was down.
- To use this option, you must specify values for C(send) and C(receive).
type: bool
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
is 120.
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
is 30.
- 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
partition:
default: Common
description:
- Device partition to manage resources on.
type: str
client_key:
description:
- Specifies a key for a client certificate the monitor sends to the target SSL server.
type: str
cipher_list:
description:
- Specifies the list of ciphers for this monitor.
- The items in the cipher list are separated with the colon C(:) symbol.
- When creating a new monitor, if this parameter is not specified, the default list
is C(DEFAULT:+SHA:+3DES:+kEDH).
type: str
client_cert:
description:
- Specifies a fully-qualified path for a client certificate the monitor sends to the
target SSL server.
type: str
transparent:
description:
- Specifies whether the monitor operates in transparent mode.
- A monitor in transparent mode directs traffic through the associated pool members
or nodes (usually a router or firewall) to the aliased destination (that is, it
probes the C(ip)-C(port) combination specified in the monitor).
- If the monitor cannot successfully reach the aliased destination, the pool member
or node through which the monitor traffic was sent is marked down.
- When creating a new monitor, if this parameter is not provided, the default value
is C(false).
type: bool
compatibility:
description:
- When enabled, specifies the SSL options setting (in OpenSSL) is set to B(all).
- When creating a new monitor, if this value is not specified, the default is C(true)
type: bool
probe_timeout:
description:
- Specifies the number of seconds after which the system times out the probe request
to the system.
- When creating a new monitor, if this parameter is not provided, then the default
value is C(5).
type: int
target_password:
description:
- Specifies the password, if the monitored target requires authentication.
type: str
target_username:
description:
- Specifies the user name, if the monitored target requires authentication.
type: str
update_password:
choices:
- always
- on_create
default: always
description:
- C(always) updates passwords if the C(target_password) is specified.
- C(on_create) only sets the password for newly created monitors.
type: str
ignore_down_response:
description:
- Specifies the monitor allows more than one probe attempt per interval.
- When C(true), specifies the monitor ignores down responses for the duration of the
monitor timeout. Once the monitor timeout is reached without the system receiving
an up response, the system marks the object down.
- When C(false), specifies the monitor immediately marks an object down when it receives
a down response.
- When creating a new monitor, if this parameter is not provided, the default value
is C(false).
type: bool
cipher_list: description: The new value for the cipher list. returned: changed sample: +3DES:+kEDH type: str client_cert: description: The new client cert setting. returned: changed sample: /Common/default type: str client_key: description: The new client key setting. returned: changed sample: /Common/default type: str compatibility: description: The new SSL compatibility setting. returned: changed sample: true type: bool ignore_down_response: description: Whether to ignore the down response or not. returned: changed sample: true type: bool interval: description: The new interval in 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: https type: str port: description: The new port the monitor checks the resource on. returned: changed sample: 8080 type: str probe_timeout: description: The new timeout in which the system will timeout the monitor probe. returned: changed sample: 10 type: int receive: description: The new receive string for this monitor. returned: changed sample: tcp string to receive type: str reverse: description: The new value for whether the monitor operates in reverse mode. returned: changed sample: false type: bool send: description: The new send string for this monitor. returned: changed sample: tcp string to send type: str timeout: description: The new timeout in which the remote system must respond to the monitor. returned: changed sample: 10 type: int transparent: description: The new value for whether the monitor operates in transparent mode. returned: changed sample: false type: bool