Try SpotterManages BIG-IP MySQL monitors
| "added in version" 1.3.0 of f5networks.f5_modules"
Authors: Andrey Kashcheev (@andreykashcheev)
Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0
collections:
- name: f5networks.f5_modules
version: 1.28.0Manages BIG-IP MySQL monitors.
- name: Create an mysql monitor
bigip_monitor_mysql:
ip: 10.10.10.10
port: 10923
name: my_mysql_monitor
send: "SELECT status FROM v$instance"
recv: OPEN
recv_column: 2
recv_row: 1
database: primary1
target_username: bigip
target_password: secret
update_password: on_create
state: present
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Modify an mysql monitor
bigip_monitor_mysql:
name: my_mysql_monitor
recv_column: 4
recv_row: 3
database: primary2
state: present
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Remove mysql monitor
bigip_monitor_mysql:
state: absent
name: my_mysql_monitor
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, then 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
recv:
description:
- Specifies the text string the monitor looks for in the returned resource.
- The most common receive expressions contain a text string that is included in a
field in your database.
- If you do not specify both a Send String and a Receive String, the monitor performs
a simple service check and connect only.
type: str
send:
description:
- Specifies the SQL query the monitor sends to the target object.
- Because the string may have special characters, the system may require the string
be enclosed with single quotation marks. If this value is C(none), then a valid
connection suffices to determine that the service is up. In this case, the system
does not need the recv, recv-row, and recv-column options and ignores them even
if not C(none).
type: str
count:
description:
- Specifies the number of monitor probes after which the connection to the database
is terminated.
type: int
debug:
description:
- Specifies whether the monitor sends error messages and additional information to
a log file created and labeled specifically for this monitor.
type: bool
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:
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(mysql) parent on the C(Common) partition.
type: str
timeout:
description:
- Specifies the number of seconds the target has in which to 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'. When
this value is set to 0 (zero), the system uses the interval from the parent monitor.
- Note that C(timeout) and C(time_until_up) combine to control when a resource is
set to up.
type: int
database:
description:
- Specifies the name of the database that the monitor tries to access.
type: str
interval:
description:
- Specifies the frequency at which the system issues the monitor check.
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
recv_row:
description:
- Specifies the row in the database where the system expects the specified Receive
String to be located.
- This is an optional setting, and is applicable only if you configure the C(send)
and C(recv) options.
type: str
partition:
default: Common
description:
- Device partition to manage resources on.
type: str
app_service:
description:
- The iApp service to be associated with this profile. When no service is specified,
the default is None.
type: str
description:
description:
- Specifies descriptive text that identifies the monitor.
type: str
recv_column:
description:
- Specifies the column in the database where the system expects the specified Receive
String to be located.
- This is an optional setting, and is applicable only if you configure the C(send)
and C(recv) options.
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 to use when checking
the health of a resource that is up.
type: int
manual_resume:
description:
- Specifies whether the system automatically changes the status of a resource to B(enabled)
at the next successful monitor check.
- If you set this option to C(true), you must manually re-enable the resource before
the system can use it for load balancing connections.
- When C(true), specifies you must manually re-enable the resource after an unsuccessful
monitor check.
- When C(false), specifies the system automatically changes the status of a resource
to B(enabled) at the next successful monitor check.
type: bool
time_until_up:
description:
- Specifies the number of seconds to wait after a resource first responds correctly
to the monitor before setting the resource to 'up'.
- During the interval, all responses from the resource must be correct.
- When the interval expires, the resource is marked 'up'.
- A value of 0, means that the resource is marked up immediately upon receipt of the
first correct response.
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) will update passwords if the C(target_password) is specified.
- C(on_create) will only set the password for newly created monitors.
type: str
app_service:
description: The iApp service associated with this monitor.
returned: changed
sample: /Common/good_service.app/good_service
type: str
database:
description: The name of the database the monitor tries to access.
returned: changed
sample: primary1
type: str
debug:
description:
- Whether the monitor sends error messages and additional information to a log file
created and labeled specifically for this monitor.
returned: changed
sample: false
type: bool
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
manual_resume:
description:
- Specifies whether the system automatically changes the status of a resource to
up at the next successful monitor check.
returned: changed
sample: true
type: bool
parent:
description: The parent monitor.
returned: changed
sample: /Common/foo_mysql
type: str
port:
description:
- Alias port or service for the monitor to check, on behalf of the pools or pool
members with which the monitor is associated.
returned: changed
sample: 80
type: str
recv:
description: The text string the monitor looks for in the returned resource.
returned: changed
sample: OPEN
type: str
recv_column:
description: The column in the database where the specified string should be located.
returned: changed
sample: 2
type: str
recv_row:
description: The row in the database where the specified string should be located.
returned: changed
sample: 1
type: str
send:
description: The SQL query the monitor sends to the target object.
returned: changed
sample: SELECT status FROM v$instance
type: str
target_username:
description: The user name for the the monitored target.
returned: changed
sample: bigip
type: str
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