Try SpotterRun TMSH and BASH commands on F5 devices
| "added in version" 1.0.0 of f5networks.f5_modules"
Authors: Tim Rupp (@caphrim007), Wojciech Wypior (@wojtek0806)
Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0
collections:
- name: f5networks.f5_modules
version: 1.28.0Sends a TMSH or BASH command to a BIG-IP node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.
This module is B(not) idempotent, nor will it ever be. It is intended as a stop-gap measure to satisfy automation requirements until such a time as a real module has been developed to configure in the way you need.
If you are using this module, we recommend also filing an issue to have a B(real) module created for your needs.
- name: run show version on remote devices
bigip_command:
commands: show sys version
provider:
server: lb.mydomain.com
password: secret
user: admin
delegate_to: localhost
- name: sleep for 200 seconds
bigip_command:
commands: 'run /util bash -c "sleep 200"'
provider:
server: lb.mydomain.com
password: secret
user: admin
timeout: 210
delegate_to: localhost
- name: run show version and check to see if output contains BIG-IP
bigip_command:
commands: show sys version
wait_for: result[0] contains BIG-IP
provider:
server: lb.mydomain.com
password: secret
user: admin
register: result
delegate_to: localhost
- name: run multiple commands on remote nodes
bigip_command:
commands:
- show sys version
- list ltm virtual
provider:
server: lb.mydomain.com
password: secret
user: admin
delegate_to: localhost
- name: run multiple commands and evaluate the output
bigip_command:
commands:
- show sys version
- list ltm virtual
wait_for:
- result[0] contains BIG-IP
- result[1] contains my-vs
provider:
server: lb.mydomain.com
password: secret
user: admin
register: result
delegate_to: localhost
- name: tmsh prefixes will automatically be handled
bigip_command:
commands:
- show sys version
- tmsh list ltm virtual
provider:
server: lb.mydomain.com
password: secret
user: admin
delegate_to: localhost
- name: Delete all LTM nodes in Partition1, assuming no dependencies exist
bigip_command:
commands:
- delete ltm node all
chdir: Partition1
provider:
server: lb.mydomain.com
password: secret
user: admin
delegate_to: localhost
- name: Command that contains wildcard character to be passed to tmsh
bigip_command:
commands:
- modify ltm data-group internal dg_string records add { "my test\\\\\\\*string" { data "value" }}
provider:
server: lb.mydomain.com
password: secret
user: admin
delegate_to: localhost
warn:
default: true
description:
- Whether the module should raise warnings related to command idempotency or not.
- Note that the F5 Ansible developers specifically leave this on to make you aware
that your usage of this module may be better served by official F5 Ansible modules.
This module should always be used as a last resort.
type: bool
chdir:
description:
- Change into this directory before running the command.
type: str
match:
choices:
- any
- all
default: all
description:
- The I(match) argument is used in conjunction with the I(wait_for) argument to specify
the match policy. Valid values are C(all) or C(any). If the value is set to C(all),
then all conditionals in the I(wait_for) must be satisfied. If the value is set
to C(any) then only one of the values must be satisfied.
type: str
retries:
default: 10
description:
- Specifies the number of retries a command should be tried before it is considered
failed. The command is run on the target device every retry and evaluated against
the I(wait_for) conditionals.
type: int
commands:
description:
- The commands to send to the remote BIG-IP device over the configured provider. The
resulting output from the command is returned. If the I(wait_for) argument is provided,
the module is not returned until the condition is satisfied or the number of retries
has expired.
- Only C(tmsh) commands are supported. If you are piping or adding additional logic
that is outside of C(tmsh) (such as grep'ing, awk'ing or other shell related logic
that are not C(tmsh)), this behavior is not supported.
required: true
type: raw
interval:
default: 1
description:
- Configures the interval in seconds to wait between retries of the command. If the
command does not pass the specified conditional, the interval indicates how to long
to wait before trying the command again.
type: int
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
no_f5_teem:
default: false
description:
- If C(yes), TEEM telemetry data is not sent to F5.
- You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF).
- Previously used variable C(F5_TEEM) is deprecated as its name was confusing.
type: bool
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:
- Parameter in effect when C(transport) is set to C(rest)
- 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: 1.0.0
version_added_collection: f5networks.f5_modules
wait_for:
aliases:
- waitfor
description:
- Specifies what to evaluate from the output of the command and what conditionals
to apply. This argument will cause the task to wait for a particular conditional
to be true before moving forward. If the conditional is not true by the configured
retries, the task fails. See the examples.
elements: str
type: list
failed_conditions:
description: The list of conditionals that have failed.
returned: failed
sample:
- '...'
- '...'
type: list
stdout:
description: The set of responses from the commands.
returned: always
sample:
- '...'
- '...'
type: list
stdout_lines:
description: The value of stdout split into a list.
returned: always
sample:
- - '...'
- '...'
- - '...'
- - '...'
type: list
warn:
description: Whether or not to raise warnings about modification commands.
returned: changed
sample: true
type: bool