ansible.builtin.bigip_sys_global (v2.5.6) — module

Install Ansible via pip

Install with pip install ansible==2.5.6

Description

Manage BIG-IP global settings.

Requirements

• f5-sdk

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
state:
    choices:
    - present
    default: present
    description:
    - The state of the variable on the system. When C(present), guarantees that an existing
      variable is set to C(value).

provider:
    description:
    - A dict object containing connection details.
    suboptions:
      auth_provider:
        description:
        - Configures the auth provider for to obtain authentication tokens from the remote
          device.
        - This option is really used when working with BIG-IQ devices.
        type: str
      no_f5_teem:
        default: false
        description:
        - If C(yes), TEEM telemetry data is not sent to F5.
        - You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF).
        - Previously used variable C(F5_TEEM) is deprecated as its name was confusing.
        type: bool
      password:
        aliases:
        - pass
        - pwd
        description:
        - 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 C(F5_PASSWORD).
        required: true
        type: str
      server:
        description:
        - The BIG-IP host or the BIG-IQ host.
        - You may omit this option by setting the environment variable C(F5_SERVER).
        required: true
        type: str
      server_port:
        default: 443
        description:
        - The BIG-IP server port.
        - You may omit this option by setting the environment variable C(F5_SERVER_PORT).
        type: int
      timeout:
        description:
        - 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.
        type: int
      transport:
        choices:
        - rest
        default: rest
        description:
        - Configures the transport connection to use when connecting to the remote device.
        type: str
      user:
        description:
        - 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 C(F5_USER).
        required: true
        type: str
      validate_certs:
        default: true
        description:
        - If C(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 C(F5_VALIDATE_CERTS).
        type: bool
    type: dict
    version_added: 1.0.0
    version_added_collection: f5networks.f5_modules

gui_setup:
    description:
    - C(enable) or C(disabled) the Setup utility in the browser-based Configuration utility.
    type: bool

mgmt_dhcp:
    description:
    - Specifies whether or not to enable DHCP client on the management interface
    type: bool

net_reboot:
    description:
    - Specifies, when C(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.
    type: bool

quiet_boot:
    description:
    - Specifies, when C(enabled), that the system suppresses informational text on the
      console during the boot cycle. When C(disabled), the system presents messages and
      informational text on the console during the boot cycle.
    type: bool

banner_text:
    description:
    - Specifies the text to present in the advisory banner.

lcd_display:
    description:
    - Specifies, when C(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.
    type: bool

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

security_banner:
    description:
    - Specifies whether the system displays an advisory message on the login screen.
    type: bool

Outputs

banner_text:
  description: The new text to present in the advisory banner.
  returned: changed
  sample: This is a corporate device. Do not touch.
  type: string
console_timeout:
  description: 'The new number of seconds of inactivity before the system logs off
    a user that is logged on.

    '
  returned: changed
  sample: 600
  type: int
gui_setup:
  description: The new setting for the Setup utility.
  returned: changed
  sample: enabled
  type: string
lcd_display:
  description: The new setting for displaying the system menu on the LCD.
  returned: changed
  sample: enabled
  type: string
mgmt_dhcp:
  description: The new setting for whether the mgmt interface should DHCP or not.
  returned: changed
  sample: enabled
  type: string
net_reboot:
  description: The new setting for whether the system should boot to an ISO on the
    network or not.
  returned: changed
  sample: enabled
  type: string
quiet_boot:
  description: 'The new setting for whether the system should suppress information
    to the console during boot or not.

    '
  returned: changed
  sample: enabled
  type: string
security_banner:
  description: 'The new setting for whether the system should display an advisory
    message on the login screen or not.

    '
  returned: changed
  sample: enabled
  type: string