f5networks.f5_modules.bigip_monitor_ftp module – Manage FTP monitors on a BIG-IP
Note
This module is part of the f5networks.f5_modules collection (version 1.30.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
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 f5networks.f5_modules 1.1.0
Synopsis
Manage FTP monitors on a BIG-IP device.
Parameters
Parameter |
Comments |
---|---|
The iApp service to be associated with this profile. When no service is specified, the default is None. |
|
Specifies whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor. When Choices:
|
|
The description of the monitor. |
|
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. |
|
The interval specifying how frequently the monitor instance of this template will run. This value must be less than the When creating a new monitor, if this parameter is not provided, the default |
|
IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is ‘*’. |
|
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 When creating a new monitor, if this parameter is not specified, the default value is When When Choices:
|
|
Specifies the data transfer process (DTP) mode. When When Choices:
|
|
Specifies the name of the monitor. |
|
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 |
|
Device partition to manage resources on. Default: |
|
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. |
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
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 |
|
The BIG-IP host or the BIG-IQ host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: |
|
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. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
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 |
|
If You may omit this option by setting the environment variable Choices:
|
|
When When Choices:
|
|
Specifies the password, if the monitored target requires authentication. |
|
Specifies the user name, if the monitored target requires authentication. |
|
Specifies the amount of time in seconds after the first successful response before a node will be marked up. A value of If this parameter is not provided when creating a new monitor, then the default value will be |
|
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 |
|
Specifies the interval at which the system performs the health check when a resource is up. When 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 |
|
Choices:
|
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 |
Description |
---|---|
The iApp service associated with this monitor. Returned: changed Sample: |
|
Whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor. Returned: changed Sample: |
|
The description of the monitor. Returned: changed Sample: |
|
Specifies the full path and file name of the file the system attempts to download. Returned: changed Sample: |
|
The new interval at which to run the monitor check. Returned: changed Sample: |
|
The new IP of IP/port definition. Returned: changed Sample: |
|
Specifies whether the system automatically changes the status of a resource to up at the next successful monitor check. Returned: changed Sample: |
|
Specifies the data transfer process (DTP) mode. Returned: changed Sample: |
|
The parent monitor. Returned: changed Sample: |
|
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: |
|
The new time in which to mark a system as up after first successful response. Returned: changed Sample: |
|
The new timeout in which the remote system must respond to the monitor. Returned: changed Sample: |
|
Interval for the system to use to perform the health check when a resource is up. Returned: changed Sample: |