bigip_cli_script – Manage CLI scripts on a BIG-IP¶
New in version 2.7.
Synopsis¶
- Manages CLI scripts on a BIG-IP. CLI scripts, otherwise known as tmshell scripts or TMSH scripts allow you to create custom scripts that can run to manage objects within a BIG-IP.
Requirements¶
The below requirements are needed on the host that executes this module.
- f5-sdk >= 3.0.16
Parameters¶
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
content
-
|
The content of the script.
This parameter is typically used in conjunction with Ansible's
file , or template lookup plugins. If this sounds foreign to you, see the examples in this documentation. |
||
description
-
|
Description of the cli script.
|
||
name
-
/ required
|
Specifies the name of the script.
|
||
partition
-
|
Default: "Common"
|
Device partition to manage resources on.
|
|
password
-
/ required
|
The password for the user account used to connect to the BIG-IP.
You may omit this option by setting the environment variable
F5_PASSWORD .aliases: pass, pwd |
||
provider
-
added in 2.5 |
Default: null
|
A dict object containing connection details.
|
|
password
-
/ required
|
The password for the user account used to connect to the BIG-IP.
You may omit this option by setting the environment variable
F5_PASSWORD .aliases: pass, pwd |
||
server
-
/ required
|
The BIG-IP host.
You may omit this option by setting the environment variable
F5_SERVER . |
||
server_port
-
|
Default: 443
|
The BIG-IP server port.
You may omit this option by setting the environment variable
F5_SERVER_PORT . |
|
ssh_keyfile
-
|
Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports.
You may omit this option by setting the environment variable
ANSIBLE_NET_SSH_KEYFILE . |
||
timeout
-
|
Default: 10
|
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
-
/ required
|
|
Configures the transport connection to use when connecting to the remote device.
|
|
user
-
/ required
|
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
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 . |
|
server
-
/ required
|
The BIG-IP host.
You may omit this option by setting the environment variable
F5_SERVER . |
||
server_port
-
added in 2.2 |
Default: 443
|
The BIG-IP server port.
You may omit this option by setting the environment variable
F5_SERVER_PORT . |
|
state
-
|
|
When
present , ensures that the script exists.When
absent , ensures the script is removed. |
|
user
-
/ required
|
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
F5_USER . |
||
validate_certs
boolean
added in 2.0 |
|
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 . |
Notes¶
Note
- For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
- Requires the f5-sdk Python package on the host. This is as easy as
pip install f5-sdk
. - 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 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 a cli script from an existing file
bigip_cli_script:
name: foo
content: "{{ lookup('file', '/absolute/path/to/cli/script.tcl') }}"
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Create a cli script from a jinja template representing a cli script
bigip_cli_script:
name: foo
content: "{{ lookup('template', '/absolute/path/to/cli/script.tcl') }}"
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
param1
boolean
|
changed |
The new param1 value of the resource.
Sample:
True
|
param2
string
|
changed |
The new param2 value of the resource.
Sample:
Foo is bar
|
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]
Authors¶
- Tim Rupp (@caphrim007)
Hint
If you notice any issues in this documentation you can edit this document to improve it.