f5networks / f5networks.f5_modules / 1.28.0 / module / bigip_cli_script Manage CLI scripts on a BIG-IP | "added in version" 1.0.0 of f5networks.f5_modules" Authors: Tim Rupp (@caphrim007), Wojciech Wypior (@wojtek0806)f5networks.f5_modules.bigip_cli_script (1.28.0) — module
Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0
collections: - name: f5networks.f5_modules version: 1.28.0
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.
- 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
name: description: - Specifies the name of the script. required: true type: str state: choices: - present - absent default: present description: - When C(present), ensures the script exists. - When C(absent), ensures the script is removed. type: str content: description: - The content of the script. - This parameter is typically used in conjunction with Ansible's C(file) or template lookup plugins. See the examples in this documentation. type: str 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 or the BIG-IQ. - You may omit this option by setting the environment variable C(F5_PASSWORD). required: true type: str server: description: - The BIG-IP host or the BIG-IQ 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 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: - 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 or the BIG-IQ. 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 partition: default: Common description: - Device partition on which to manage resources. type: str description: description: - Description of the cli script. type: str
param1: description: The new param1 value of the resource. returned: changed sample: true type: bool param2: description: The new param2 value of the resource. returned: changed sample: Foo is bar type: str