f5networks.f5_modules.bigip_monitor_smtp module – Manage SMTP monitors on a BIG-IP

Note

This module is part of the f5networks.f5_modules collection (version 1.27.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_smtp.

New in f5networks.f5_modules 1.1.0

Synopsis

  • Manage SMTP monitors on a BIG-IP.

Parameters

Parameter

Comments

app_service

string

The iApp service to be associated with this profile. When no service is specified, the default is None.

debug

boolean

Specifies whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor.

When true the system redirects error messages and additional information to the /var/log/monitors/<monitor_name>-<node_name>-<port>.log file.

Choices:

  • false

  • true

description

string

The description of the monitor.

domain

string

Specifies the domain name to check.

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

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 true, 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 false.

When true, specifies you must manually re-enable the resource after an unsuccessful monitor check.

When false, specifies the system automatically changes the status of a resource to enabled at the next successful monitor check.

Choices:

  • false

  • true

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 smtp monitor.

partition

string

Device partition to manage resources on.

Default: "Common"

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 f5networks.f5_modules 1.0.0

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

Previously used variable F5_TEEM is deprecated as its name was confusing.

Choices:

  • false ← (default)

  • true

password

aliases: pass, pwd

string / required

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

server

string / required

The BIG-IP host or the BIG-IQ host.

You may omit this option by setting the environment variable F5_SERVER.

server_port

integer

The BIG-IP server port.

You may omit this option by setting the environment variable F5_SERVER_PORT.

Default: 443

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.

Choices:

  • "rest" ← (default)

user

string / required

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

Choices:

  • false

  • true ← (default)

state

string

When present, ensures the monitor exists.

When absent, ensures the monitor is removed.

Choices:

  • "present" ← (default)

  • "absent"

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, the default value will be 31.

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.

When creating a new monitor, if this parameter is not provided, the default 0 will be used.

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 SMTP Monitor
  bigip_monitor_smtp:
    state: present
    ip: 10.10.10.10
    name: my_smtp_monitor
    domain: foo.com
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Remove SMTP Monitor
  bigip_monitor_smtp:
    state: absent
    name: my_smtp_monitor
    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

app_service

string

The iApp service associated with this monitor.

Returned: changed

Sample: "/Common/good_service.app/good_service"

debug

boolean

Whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor.

Returned: changed

Sample: false

description

string

The description of the monitor.

Returned: changed

Sample: "Important Monitor"

domain

string

Specifies the domain name to check.

Returned: changed

Sample: "bigipinternal.com"

interval

integer

The new interval in which to run the monitor check.

Returned: changed

Sample: 2

ip

string

The new IP of IP/port definition.

Returned: changed

Sample: "10.12.13.14"

manual_resume

boolean

Specifies whether the system automatically changes the status of a resource to up at the next successful monitor check.

Returned: changed

Sample: true

parent

string

The parent monitor.

Returned: changed

Sample: "/Common/foo_smtp"

port

string

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"

time_until_up

integer

The new time in which to mark a system as up after first successful response.

Returned: changed

Sample: 2

timeout

integer

The new timeout in which the remote system must respond to the monitor.

Returned: changed

Sample: 10

up_interval

integer

Interval for the system to use to perform the health check when a resource is up.

Returned: changed

Sample: 0

Authors

  • Wojciech Wypior (@wojtek0806)