Documentation

bigip_sys_global - Manage BIG-IP global settings

New in version 2.3.

Synopsis

  • Manage BIG-IP global settings.

Requirements

The below requirements are needed on the host that executes this module.

  • f5-sdk
  • f5-sdk >= 3.0.9

Parameters

Parameter Choices/Defaults Comments
banner_text
Specifies the text to present in the advisory banner.
console_timeout
Specifies the number of seconds of inactivity before the system logs off a user that is logged on.
gui_setup
bool
    Choices:
  • no
  • yes
enable or disabled the Setup utility in the browser-based Configuration utility.
lcd_display
bool
    Choices:
  • no
  • yes
Specifies, when enabled, that the system menu displays on the LCD screen on the front of the unit. This setting has no effect when used on the VE platform.
mgmt_dhcp
bool
    Choices:
  • no
  • yes
Specifies whether or not to enable DHCP client on the management interface
net_reboot
bool
    Choices:
  • no
  • yes
Specifies, when enabled, that the next time you reboot the system, the system boots to an ISO image on the network, rather than an internal media drive.
password
required
The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable F5_PASSWORD is set.

aliases: pass, pwd
provider
(added in 2.5)
A dict object containing connection details.
ssh_keyfile
Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
timeout Default:
10
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.
server
required
The BIG-IP host. You can omit this option if the environment variable F5_SERVER is set.
user
required
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable F5_USER is set.
server_port Default:
443
The BIG-IP server port. You can omit this option if the environment variable F5_SERVER_PORT is set.
password
required
The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable F5_PASSWORD is set.

aliases: pass, pwd
validate_certs
bool
    Choices:
  • no
  • yes ←
If no, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable F5_VALIDATE_CERTS is set.
transport
required
    Choices:
  • rest
  • cli ←
Configures the transport connection to use when connecting to the remote device.
quiet_boot
bool
    Choices:
  • no
  • yes
Specifies, when enabled, that the system suppresses informational text on the console during the boot cycle. When disabled, the system presents messages and informational text on the console during the boot cycle.
security_banner
bool
    Choices:
  • no
  • yes
Specifies whether the system displays an advisory message on the login screen.
server
required
The BIG-IP host. You can omit this option if the environment variable F5_SERVER is set.
server_port
(added in 2.2)
Default:
443
The BIG-IP server port. You can omit this option if the environment variable F5_SERVER_PORT is set.
state
    Choices:
  • present ←
The state of the variable on the system. When present, guarantees that an existing variable is set to value.
user
required
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable F5_USER is set.
validate_certs
bool

(added in 2.0)
    Choices:
  • no
  • yes ←
If no, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable F5_VALIDATE_CERTS is set.

Notes

Note

Examples

- name: Disable the setup utility
  bigip_sys_global:
    gui_setup: disabled
    password: secret
    server: lb.mydomain.com
    user: admin
    state: present
  delegate_to: localhost

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
banner_text
string
changed
The new text to present in the advisory banner.

Sample:
This is a corporate device. Do not touch.
console_timeout
int
changed
The new number of seconds of inactivity before the system logs off a user that is logged on.

Sample:
600
gui_setup
string
changed
The new setting for the Setup utility.

Sample:
enabled
lcd_display
string
changed
The new setting for displaying the system menu on the LCD.

Sample:
enabled
mgmt_dhcp
string
changed
The new setting for whether the mgmt interface should DHCP or not.

Sample:
enabled
net_reboot
string
changed
The new setting for whether the system should boot to an ISO on the network or not.

Sample:
enabled
quiet_boot
string
changed
The new setting for whether the system should suppress information to the console during boot or not.

Sample:
enabled
security_banner
string
changed
The new setting for whether the system should display an advisory message on the login screen or not.

Sample:
enabled


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Tim Rupp (@caphrim007)

Hint

If you notice any issues in this documentation you can edit this document to improve it.