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_sys_db.
New in version 1.0.0: of f5networks.f5_modules
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| key string / required | The database variable to manipulate. | ||
| 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 |
| The state of the variable on the system. When present, guarantees an existing variable is set to value. When reset, sets the variable back to the default value. At least one of value and state reset are required. | |
| value string | The value to set the key to. At least one of value and state reset are required. | ||
Note
- name: Set the boot.quiet DB variable on the BIG-IP
bigip_sys_db:
key: boot.quiet
value: disable
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Disable the initial setup screen
bigip_sys_db:
key: setup.run
value: false
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Reset the initial setup screen
bigip_sys_db:
key: setup.run
state: reset
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| default_value string | changed and success | The default value of the key. Sample: True |
| name string | changed and success | The key in the system database. Sample: setup.run |
| value string | changed and success | The value that you set the key to. |
© 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_sys_db_module.html