Note
This plugin is part of the f5networks.f5_modules collection (version 1.7.1).
To install it use: ansible-galaxy collection install f5networks.f5_modules.
To use it in a playbook, specify: f5networks.f5_modules.bigip_monitor_mysql.
New in version 1.3.0: of f5networks.f5_modules
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| app_service string | The iApp service to be associated with this profile. When no service is specified, the default is None. | ||
| count integer | Specifies the number of monitor probes after which the connection to the database is terminated. | ||
| database string | Specifies the name of the database that the monitor tries to access. | ||
| debug boolean |
| Specifies whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor. | |
| description string | Specifies descriptive text that identifies the monitor. | ||
| interval integer | Specifies the frequency at which the system issues the monitor check. | ||
| ip string | IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, then the default value is '*'. | ||
| manual_resume boolean |
| Specifies whether the system automatically changes the status of a resource to enabled at the next successful monitor check. If you set this option to yes, you must manually re-enable the resource before the system can use it for load balancing connections.When yes, specifies you must manually re-enable the resource after an unsuccessful monitor check.When no, specifies the system automatically changes the status of a resource to enabled at the next successful monitor check. | |
| name string / required | Monitor name. | ||
| parent string | The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the mysql parent on the Common partition. | ||
| partition string | Default: "Common" | Device partition to manage resources on. | |
| port string | 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. | ||
| provider dictionary added in 1.0.0 of f5networks.f5_modules | A dict object containing connection details. | ||
| auth_provider string | Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. | ||
| no_f5_teem boolean |
| If yes, TEEM telemetry data is not sent to F5.You may omit this option by setting the environment variable F5_TEEM. | |
| password string / required | The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable F5_PASSWORD.aliases: pass, pwd | ||
| server string / required | The BIG-IP host. You may omit this option by setting the environment variable F5_SERVER. | ||
| server_port integer | Default: 443 | The BIG-IP server port. You may omit this option by setting the environment variable F5_SERVER_PORT. | |
| timeout integer | 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. | ||
| transport string |
| Configures the transport connection to use when connecting to the remote device. | |
| user string / required | The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable F5_USER. | ||
| validate_certs boolean |
| If 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 F5_VALIDATE_CERTS. | |
| recv string | 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. | ||
| recv_column string | 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 send and recv options. | ||
| recv_row string | 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 send and recv options. | ||
| send string | 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 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 none. | ||
| state string |
| When present, ensures the monitor exists.When absent, ensures the monitor is removed. | |
| target_password string | Specifies the password if the monitored target requires authentication. | ||
| target_username string | Specifies the user name if the monitored target requires authentication. | ||
| time_until_up integer | 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. | ||
| timeout integer | 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 timeout and time_until_up combine to control when a resource is set to up. | ||
| up_interval integer | Specifies the interval for the system to use to perform the health check when a resource is up. When 0, specifies the system uses the interval specified in 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. | ||
| update_password string |
| always will update passwords if the target_password is specified.on_create will only set the password for newly created monitors. | |
Note
- 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
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| app_service string | changed | The iApp service associated with this monitor. Sample: /Common/good_service.app/good_service |
| database string | changed | The name of the database the monitor tries to access. Sample: primary1 |
| debug boolean | changed | Whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor. |
| description string | changed | The description of the monitor. Sample: Important Monitor |
| interval integer | changed | The new interval at which to run the monitor check. Sample: 2 |
| ip string | changed | The new IP of IP/port definition. Sample: 10.12.13.14 |
| manual_resume boolean | changed | Specifies whether the system automatically changes the status of a resource to up at the next successful monitor check. Sample: True |
| parent string | changed | The parent monitor. Sample: /Common/foo_mysql |
| port string | changed | Alias port or service for the monitor to check, on behalf of the pools or pool members with which the monitor is associated. Sample: 80 |
| recv string | changed | The text string the monitor looks for in the returned resource. Sample: OPEN |
| recv_column string | changed | The column in the database where the specified string should be located. Sample: 2 |
| recv_row string | changed | The row in the database where the specified string should be located. Sample: 1 |
| send string | changed | The SQL query the monitor sends to the target object. Sample: SELECT status FROM v$instance |
| target_username string | changed | The user name for the the monitored target. Sample: bigip |
| time_until_up integer | changed | The new time in which to mark a system as up after first successful response. Sample: 2 |
| timeout integer | changed | The new timeout in which the remote system must respond to the monitor. Sample: 10 |
| up_interval integer | changed | Interval for the system to use to perform the health check when a resource is up. |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/f5networks/f5_modules/bigip_monitor_mysql_module.html