ansible / ansible.builtin / v2.4.6.0-1 / module / bigip_monitor_tcp_half_open Manages F5 BIG-IP LTM tcp monitors. | "added in version" 2.4 of ansible.builtin" Authors: Tim Rupp (@caphrim007) preview | supported by communityansible.builtin.bigip_monitor_tcp_half_open (v2.4.6.0-1) — module
pip
Install with pip install ansible==2.4.6.0.post1
Manages F5 BIG-IP LTM tcp monitors via iControl SOAP API.
- name: Create TCP Monitor bigip_monitor_tcp_half_open: state: "present" ip: "10.10.10.10" server: "lb.mydomain.com" user: "admin" password: "secret" name: "my_tcp_monitor" delegate_to: localhost
- name: Remove TCP Monitor bigip_monitor_tcp_half_open: state: "absent" server: "lb.mydomain.com" user: "admin" password: "secret" name: "my_tcp_monitor" delegate_to: localhost
ip: description: - IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, then the default value will be '*'. - If this value is an IP address, and the C(type) is C(tcp) (the default), then a C(port) number must be specified. name: aliases: - monitor description: - Monitor name. required: true parent: default: /Common/tcp description: - The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the C(tcp) parent on the C(Common) partition. timeout: 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. If this parameter is not provided when creating a new monitor, then the default value will be 16. interval: description: - The interval specifying how frequently the monitor instance of this template will run. If this parameter is not provided when creating a new monitor, then the default value will be 5. This value B(must) be less than the C(timeout) value. 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 time_until_up: 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. If this parameter is not provided when creating a new monitor, then the default value will be 0.
interval: description: The new interval in which to run the monitor check. returned: changed sample: 2 type: int ip: description: The new IP of IP/port definition. returned: changed sample: 10.12.13.14 type: string parent: description: New parent template of the monitor. returned: changed sample: tcp type: string time_until_up: description: The new time in which to mark a system as up after first successful response. returned: changed sample: 2 type: int timeout: description: The new timeout in which the remote system must respond to the monitor. returned: changed sample: 10 type: int