Try SpotterManages F5 BIG-IP LTM HTTP 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 LTM HTTP monitors.
- name: Create HTTP Monitor
bigip_monitor_http:
state: present
ip: 10.10.10.10
name: my_http_monitor
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Remove HTTP Monitor
bigip_monitor_http:
state: absent
name: my_http_monitor
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Include a username and password in the HTTP monitor
bigip_monitor_http:
state: absent
name: my_http_monitor
target_username: monitor_user
target_password: monitor_pass
provider:
server: lb.mydomain.com
user: admin
password: secret
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 '*'.
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 value
is not provided, the default 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/http
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(http) parent on the C(Common) partition.
type: str
receive:
description:
- The Receive string for the monitor call.
type: str
reverse:
description:
- Specifies whether the monitor operates in reverse mode.
- When the monitor is in reverse mode, a successful receive string match marks the
monitored object down instead of up. You can use the this mode only if you configure
the C(receive) option.
- This parameter is not compatible with the C(time_until_up) parameter. If C(time_until_up)
is specified, it must be C(0). Or, if it already exists, it must be C(0).
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 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 is 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
partition:
default: Common
description:
- Device partition to manage resources on.
type: str
description:
description:
- The description of the monitor.
type: str
up_interval:
description:
- Specifies the interval for the system to use to perform the health check when a
resource is up.
- When C(0), specifies the system uses the interval specified in C(interval) to check
the health of the resource.
- When any other number, enables you to specify a different interval when checking
the health of a resource that is up.
type: int
version_added: 1.22.0
version_added_collection: f5networks.f5_modules
time_until_up:
description:
- Specifies the amount of time in seconds after the first successful response before
a node is marked up. A value of 0 causes a node to be marked up immediately after
a valid response is received from the node. If this parameter is not provided when
creating a new monitor, the default value is 0.
type: int
receive_disable:
description:
- This setting works like C(receive), except the system marks the node or pool member
disabled when its response matches the C(receive_disable) string but not C(receive).
To use this setting, you must specify both C(receive_disable) and C(receive).
type: str
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
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: http
type: str
reverse:
description: Whether the monitor operates in reverse mode.
returned: changed
sample: true
type: bool
time_until_up:
description: The new time in which to mark a system as up after first successful
response.
returned: changed
sample: 2
type: int
timeout:
description: The new timeout in which the remote system must respond to the monitor.
returned: changed
sample: 10
type: int
up_interval:
description: Interval for the system to use to perform the health check when a resource
is up.
returned: changed
sample: 0
type: int