Note
This plugin is part of the f5networks.f5_modules collection.
To install it use: ansible-galaxy collection install f5networks.f5_modules
.
To use it in a playbook, specify: f5networks.f5_modules.bigip_cli_script
.
New in version 1.0.0: of f5networks.f5_modules
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
content string | The content of the script. This parameter is typically used in conjunction with Ansible's file or template lookup plugins. See the examples in this documentation. | ||
description string | Description of the cli script. | ||
name string / required | Specifies the name of the script. | ||
partition string | Default: "Common" | Device partition on which to manage resources. | |
provider dictionary added in 1.0.0 of f5networks.f5_modules | 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_TEEM . | |
password string / 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 string / required | The BIG-IP host. You may omit this option by setting the environment variable F5_SERVER . | ||
server_port integer | Default: 443 | The BIG-IP server port. You may omit this option by setting the environment variable F5_SERVER_PORT . | |
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. | |
user string / 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 . | |
state string |
| When present , ensures the script exists.When absent , ensures the script is removed. |
Note
- 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
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 |
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/f5networks/f5_modules/bigip_cli_script_module.html