f5networks.f5_modules.bigip_remote_user module – Manages default settings for remote user accounts on a BIG-IP

Note

This module is part of the f5networks.f5_modules collection (version 1.21.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_remote_user.

New in f5networks.f5_modules 1.0.0

Synopsis

  • Manages the default settings for remote user accounts on a BIG-IP system.

Parameters

Parameter

Comments

console_access

boolean

Enables or disables the default console access for all remote user accounts.

The default system value is disabled.

Choices:

  • false

  • true

default_partition

string

Specifies the default partition for all remote user accounts.

The default system value is all for all partitions.

default_role

string

Specifies the default role for all remote user accounts.

The default system value is no-access.

Choices:

  • "acceleration-policy-editor"

  • "admin"

  • "application-editor"

  • "auditor"

  • "certificate-manager"

  • "firewall-manager"

  • "fraud-protection-manager"

  • "guest"

  • "irule-manager"

  • "manager"

  • "no-access"

  • "operator"

  • "resource-admin"

  • "user-manager"

  • "web-application-security-administrator"

  • "web-application-security-editor"

description

string

User-defined description.

provider

dictionary

added in f5networks.f5_modules 1.0.0

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:

  • false ← (default)

  • true

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:

  • false

  • true ← (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: Modify default partition and console access
  bigip_remote_user:
    default_partition: Common
    console_access: yes
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Modify default role, partition and console access
  bigip_remote_user:
    default_partition: Common
    default_role: manager
    console_access: yes
    description: "Changed new settings"
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Revert to default settings
  bigip_remote_user:
    default_partition: all
    default_role: "no-access"
    console_access: no
    description: ""
    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

console_access

boolean

The default console access for all remote user accounts.

Returned: changed

Sample: false

default_partition

string

The default partition for all remote user accounts.

Returned: changed

Sample: "Common"

default_role

string

The default role for all remote user accounts.

Returned: changed

Sample: "auditor"

description

string

The user-defined description.

Returned: changed

Sample: "Foo is bar"

Authors

  • Wojciech Wypior (@wojtek0806)