f5networks.f5_modules.bigip_sys_global module – Manage BIG-IP global settings
Note
This module is part of the f5networks.f5_modules collection (version 1.31.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install f5networks.f5_modules
.
To use it in a playbook, specify: f5networks.f5_modules.bigip_sys_global
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manage BIG-IP global settings.
Parameters
Parameter |
Comments |
---|---|
Specifies the text to present in the advisory banner. |
|
Specifies the number of seconds of inactivity before the system logs off a user that is logged on. |
|
Choices:
|
|
Choices:
|
|
When Choices:
|
|
Specifies whether or not to enable DHCP client on the management interface. Choices:
|
|
When Choices:
|
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
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 |
|
The BIG-IP host or the BIG-IQ host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: |
|
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. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
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 |
|
If You may omit this option by setting the environment variable Choices:
|
|
When Choices:
|
|
Specifies whether the system displays an advisory message on the login screen. Choices:
|
|
The state of the variable on the system. When Choices:
|
Notes
Note
For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
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 f5networks.f5_modules.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: Disable the setup utility
bigip_sys_global:
gui_setup: false
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 |
Description |
---|---|
The new text to present in the advisory banner. Returned: changed Sample: |
|
The new number of seconds of inactivity before the system logs off a user that is logged on. Returned: changed Sample: |
|
The new setting for GUI auditing. Returned: changed Sample: |
|
The new setting for the Setup utility. Returned: changed Sample: |
|
The new setting for displaying the system menu on the LCD. Returned: changed Sample: |
|
The new setting for whether the mgmt interface should use DHCP or not. Returned: changed Sample: |
|
The new setting for whether the system should boot to an ISO on the network or not. Returned: changed Sample: |
|
The new setting for whether the system should suppress information to the console during boot or not. Returned: changed Sample: |
|
The new setting for whether the system should display an advisory message on the login screen or not. Returned: changed Sample: |