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.31.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 |
---|---|
Enables or disables the default console access for all remote user accounts. The default system value is Choices:
|
|
Specifies the default partition for all remote user accounts. The default system value is |
|
Specifies the default role for all remote user accounts. The default system value is Choices:
|
|
User-defined description. |
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
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 |
|
The BIG-IP host or the BIG-IQ host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: |
|
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. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
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 |
|
If You may omit this option by setting the environment variable Choices:
|
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: true
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: true
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: false
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 |
---|---|
The default console access for all remote user accounts. Returned: changed Sample: |
|
The default partition for all remote user accounts. Returned: changed Sample: |
|
The default role for all remote user accounts. Returned: changed Sample: |
|
The user-defined description. Returned: changed Sample: |