bigip_sys_global – Manage BIG-IP global settings

From Get docs
Ansible/docs/2.7/modules/bigip sys global module


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

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

boolean

  • no
  • yes

enable or disabled the Setup utility in the browser-based Configuration utility.

lcd_display

boolean

  • 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

boolean

  • no
  • yes

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

net_reboot

boolean

  • 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 may omit this option by setting the environment variable F5_PASSWORD.


aliases: pass, pwd

provider

-

added in 2.5

Default:

null

A dict object containing connection details.

password

- / 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

- / required

The BIG-IP host.

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

server_port

-

Default:

443

The BIG-IP server port.

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

ssh_keyfile

-

Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports.

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

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.

transport

- / required

  • rest
  • cli

Configures the transport connection to use when connecting to the remote device.

user

- / 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

  • no
  • yes

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.

quiet_boot

boolean

  • 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

boolean

  • no
  • yes

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

server

- / required

The BIG-IP host.

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

server_port

-

added in 2.2

Default:

443

The BIG-IP server port.

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

state

-

  • 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 may omit this option by setting the environment variable F5_USER.

validate_certs

boolean

added in 2.0

  • no
  • yes

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.



Notes

Note

  • For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
  • Requires the f5-sdk Python package on the host. This is as easy as pip install f5-sdk.
  • 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 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
    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

integer

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:

True

lcd_display

string

changed

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


Sample:

True

mgmt_dhcp

string

changed

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


Sample:

True

net_reboot

string

changed

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


Sample:

True

quiet_boot

string

changed

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


Sample:

True

security_banner

string

changed

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


Sample:

True




Status

Authors

  • Tim Rupp (@caphrim007)

Hint

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


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/bigip_sys_global_module.html