bigip_config - Manage BIG-IP configuration sections.
New in version 2.4.
Synopsis
- Manages a BIG-IP configuration by allowing TMSH commands that modify running configuration, or merge SCF formatted files into the running configuration. Additionally, this module is of significant importance because it allows you to save your running configuration to disk. Since the F5 module only manipulate running configuration, it is important that you utilize this module to save that running config.
Requirements (on host that executes module)
- f5-sdk >= 2.2.3
Options
parameter | required | default | choices | comments |
---|---|---|---|---|
merge_content | no | Loads the specified configuration that you want to merge into the running configuration. This is equivalent to using the tmsh command load sys config from-terminal merge . If you need to read configuration from a file or template, use Ansible's file or template lookup plugins respectively. | ||
password | yes | The password for the user account used to connect to the BIG-IP. This option can be omitted if the environment variable F5_PASSWORD is set. | ||
reset | no |
| Loads the default configuration on the device. If this option is specified, the default configuration will be loaded before any commands or other provided configuration is run. | |
save | no |
| The save argument instructs the module to save the running-config to startup-config. This operation is performed after any changes are made to the current running config. If no changes are made, the configuration is still saved to the startup config. This option will always cause the module to return changed. | |
server | yes | The BIG-IP host. This option can be omitted if the environment variable F5_SERVER is set. | ||
server_port (added in 2.2)
| no | 443 | The BIG-IP server port. This option can be omitted if the environment variable F5_SERVER_PORT is set. | |
user | yes | The username to connect to the BIG-IP with. This user must have administrative privileges on the device. This option can be omitted if the environment variable F5_USER is set. | ||
validate_certs (added in 2.0)
| no | True |
| If no , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. This option can be omitted if the environment variable F5_VALIDATE_CERTS is set. |
verify | no | True |
| Validates the specified configuration to see whether they are valid to replace the running configuration. The running configuration will not be changed. |
Examples
- name: Save the running configuration of the BIG-IP bigip_config: save: yes server: "lb.mydomain.com" password: "secret" user: "admin" validate_certs: "no" delegate_to: localhost - name: Reset the BIG-IP configuration, for example, to RMA the device bigip_config: reset: yes save: yes server: "lb.mydomain.com" password: "secret" user: "admin" validate_certs: "no" delegate_to: localhost - name: Load an SCF configuration bigip_config: merge_content: "{{ lookup('file', '/path/to/config.scf') }}" server: "lb.mydomain.com" password: "secret" user: "admin" validate_certs: "no" delegate_to: localhost
Return Values
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
stdout | The set of responses from the options | always | list | ['...', '...'] |
stdout_lines | The value of stdout split into a list | always | list | [['...', '...'], ['...'], ['...']] |
Notes
Note
- Requires the f5-sdk Python package on the host. This is as easy as pip install f5-sdk.
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/bigip_config_module.html