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.18.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 version 1.0.0: of f5networks.f5_modules

Synopsis

  • Manage BIG-IP global settings.

Parameters

Parameter

Comments

banner_text

string

Specifies the text to present in the advisory banner.

console_timeout

integer

Specifies the number of seconds of inactivity before the system logs off a user that is logged on.

gui_setup

boolean

yes or no, the Setup utility in the browser-based Configuration utility.

Choices:

  • no

  • yes

lcd_display

boolean

When yes, specifies 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.

Choices:

  • no

  • yes

mgmt_dhcp

boolean

Specifies whether or not to enable DHCP client on the management interface.

Choices:

  • no

  • yes

net_reboot

boolean

When yes, specifies the next time you reboot the system, the system boots to an ISO image on the network, rather than an internal media drive.

Choices:

  • no

  • yes

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_TELEMETRY_OFF.

Previously used variable F5_TEEM is deprecated as its name was confusing.

Choices:

  • no ← (default)

  • yes

password

aliases: pass, pwd

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.

server

string / required

The BIG-IP host.

You may omit this option by setting the environment variable F5_SERVER.

server_port

integer

The BIG-IP server port.

You may omit this option by setting the environment variable F5_SERVER_PORT.

Default: 443

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.

Choices:

  • rest ← (default)

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.

Choices:

  • no

  • yes ← (default)

quiet_boot

boolean

When yes, specifies the system suppresses informational text on the console during the boot cycle. When no, the system presents messages and informational text on the console during the boot cycle.

Choices:

  • no

  • yes

security_banner

boolean

Specifies whether the system displays an advisory message on the login screen.

Choices:

  • no

  • yes

state

string

The state of the variable on the system. When present, guarantees an existing variable is set to value.

Choices:

  • present ← (default)

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: no
    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

banner_text

string

The new text to present in the advisory banner.

Returned: changed

Sample: “This is a corporate device. Do not touch.”

console_timeout

integer

The new number of seconds of inactivity before the system logs off a user that is logged on.

Returned: changed

Sample: 600

gui_setup

boolean

The new setting for the Setup utility.

Returned: changed

Sample: true

lcd_display

boolean

The new setting for displaying the system menu on the LCD.

Returned: changed

Sample: true

mgmt_dhcp

boolean

The new setting for whether the mgmt interface should use DHCP or not.

Returned: changed

Sample: true

net_reboot

boolean

The new setting for whether the system should boot to an ISO on the network or not.

Returned: changed

Sample: true

quiet_boot

boolean

The new setting for whether the system should suppress information to the console during boot or not.

Returned: changed

Sample: true

security_banner

boolean

The new setting for whether the system should display an advisory message on the login screen or not.

Returned: changed

Sample: true

Authors

  • Tim Rupp (@caphrim007)

  • Wojciech Wypior (@wojtek0806)