f5networks.f5_modules.bigip_monitor_ftp – Manage FTP monitors on a BIG-IP

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_ftp.

New in version 1.1.0: of f5networks.f5_modules

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

Manage FTP monitors on a BIG-IP device.

Parameters

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.
debug boolean		Choices: no yes	Specifies whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor. When `yes` the system redirects error messages and additional information to the `/var/log/monitors/<monitor_name>-<node_name>-<port>.log` file.
description string			The description of the monitor.
filename string			Specifies the full path and file name of the file the system attempts to download. The health check is successful if the system can download the file.
interval integer			The interval specifying how frequently the monitor instance of this template will run. This value must be less than the `timeout` value. When creating a new monitor, if this parameter is not provided, the default `5` will be used.
ip string			IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is '*'.
manual_resume boolean		Choices: no yes	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 creating a new monitor, if this parameter is not specified, the default value is `no`. 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.
mode string		Choices: passive port	Specifies the data transfer process (DTP) mode. When `passive`, the monitor sends a data transfer request to the FTP server. When the FTP server receives the request, the FTP server initiates and establishes the data connection. When `port`, the monitor initiates and establishes the data connection with the FTP server.
name string / required			Specifies the name of the monitor.
parent string			The parent template of this monitor template. Once this value has been set, it cannot be changed. When creating a new monitor, if this parameter is not specified, the default is the system-supplied `ftp` monitor.
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 use 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	Choices: no yes	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	Choices: rest ←	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	Choices: no yes ←	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`.
state string		Choices: present ← absent	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 amount of time in seconds after the first successful response before a node will be marked up. A value of `0` will cause 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, then the default value will be `0`.
timeout integer			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, then the default value will be `31`.
up_interval integer			Specifies the interval at which the system performs 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. When creating a new monitor, if this parameter is not provided, the default `0` will be used.
update_password string		Choices: always ← on_create	`always` will update passwords if the `target_password` is specified. `on_create` will only set the password for newly created monitors.

Notes

Note

For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
Requires BIG-IP software version >= 12.
The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the f5networks.f5_modules.bigip_config module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration.

Examples

- name: Create FTP Monitor
  bigip_monitor_ftp:
    state: present
    ip: 10.10.10.10
    name: my_ft_monitor
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Remove FTP Monitor
  bigip_monitor_ftp:
    state: absent
    name: my_ftp_monitor
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Include a username and password in the FTP monitor
  bigip_monitor_ftp:
    state: absent
    name: my_ftp_monitor
    target_username: monitor_user
    target_password: monitor_pass
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

Return Values

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
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
filename string	changed	Specifies the full path and file name of the file the system attempts to download. Sample: /ftp/var/health.txt
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
mode string	changed	Specifies the data transfer process (DTP) mode. Sample: passive
parent string	changed	The parent monitor. Sample: /Common/foo_ftp
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
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.

Authors

Wojciech Wypior (@wojtek0806)

© 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_ftp_module.html