Docs4dev
Docs
ansible / 2.4 / bigip_sys_global_module.html

bigip_sys_global - Manage BIG-IP global settings.

New in version 2.3.

Synopsis

  • Manage BIG-IP global settings.

Requirements (on host that executes module)

  • f5-sdk

Options

parameter required default choices comments
banner_text
 no
Specifies the text to present in the advisory banner.
console_timeout
 no
Specifies the number of seconds of inactivity before the system logs off a user that is logged on.
gui_setup
 no
  • enabled
  • disabled
enable or disabled the Setup utility in the browser-based Configuration utility
lcd_display
 no
  • enabled
  • disabled
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
 no
  • enabled
  • disabled
Specifies whether or not to enable DHCP client on the management interface
net_reboot
 no
  • enabled
  • disabled
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
 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.
quiet_boot
 no
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
 no
  • enabled
  • disabled
Specifies whether the system displays an advisory message on the login screen.
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.
state
 no present
  • present
The state of the variable on the system. When present, guarantees that an existing variable is set to value.
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
  • True
  • False
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.

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 Return Values, the following are the fields unique to this module:

name description returned type sample
banner_text
The new text to present in the advisory banner.
changed string This is a corporate device. Do not touch.
console_timeout
The new number of seconds of inactivity before the system logs off a user that is logged on.
changed int 600
gui_setup
The new setting for the Setup utility.
changed string enabled
lcd_display
The new setting for displaying the system menu on the LCD.
changed string enabled
mgmt_dhcp
The new setting for whether the mgmt interface should DHCP or not
changed string enabled
net_reboot
The new setting for whether the system should boot to an ISO on the network or not
changed string enabled
quiet_boot
The new setting for whether the system should suppress information to the console during boot or not.
changed string enabled
security_banner
The new setting for whether the system should display an advisory message on the login screen or not
changed string enabled

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_sys_global_module.html