ansible.builtin.bigip_monitor_http (v2.4.6.0-1) — module

Install Ansible via pip

Install with pip install ansible==2.4.6.0.post1

Description

Manages F5 BIG-IP LTM monitors via iControl SOAP API

Requirements

• bigsuds

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: BIGIP F5 | Create HTTP Monitor
  bigip_monitor_http:
      state: "present"
      server: "lb.mydomain.com"
      user: "admin"
      password: "secret"
      name: "my_http_monitor"
      send: "http string to send"
      receive: "http string to receive"
  delegate_to: localhost

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: BIGIP F5 | Remove HTTP Monitor
  bigip_monitor_http:
    state: "absent"
    server: "lb.mydomain.com"
    user: "admin"
    password: "secret"
    name: "my_http_monitor"
  delegate_to: localhost

Inputs

    
ip:
    default: none
    description:
    - IP address part of the ipport definition. The default API setting is "0.0.0.0".
    required: false

name:
    aliases:
    - monitor
    default: null
    description:
    - Monitor name
    required: true

port:
    default: none
    description:
    - Port address part of the ip/port definition. The default API setting is 0.
    required: false

send:
    default: none
    description:
    - The send string for the monitor call
    required: true

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Monitor state
    required: false

parent:
    default: http
    description:
    - The parent template of this monitor template
    required: false

receive:
    default: none
    description:
    - The receive string for the monitor call
    required: true

timeout:
    default: none
    description:
    - 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 number to any number you want, however, it should be 3 times the interval number
      of seconds plus 1 second. The default API setting is 16.
    required: false

interval:
    default: none
    description:
    - The interval specifying how frequently the monitor instance of this template will
      run. By default, this interval is used for up and down states. The default API setting
      is 5.
    required: false

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
      password:
        aliases:
        - pass
        - pwd
        description:
        - The password for the user account used to connect to the BIG-IP.
        - You may omit this option by setting the environment variable C(F5_PASSWORD).
        required: true
        type: str
      server:
        description:
        - The BIG-IP 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
      ssh_keyfile:
        description:
        - Specifies the SSH keyfile to use to authenticate the connection to the remote
          device.  This argument is only used for I(cli) transports.
        - You may omit this option by setting the environment variable C(ANSIBLE_NET_SSH_KEYFILE).
        type: path
      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:
        - cli
        - 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 with. 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: '2.5'
    version_added_collection: f5networks.f5_modules

partition:
    default: Common
    description:
    - Partition for the monitor
    required: false

time_until_up:
    default: none
    description:
    - 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. The default API setting is 0.
    required: false

receive_disable:
    default: none
    description:
    - The receive disable string for the monitor call
    required: true

parent_partition:
    default: Common
    description:
    - Partition for the parent monitor
    required: false