f5networks.f5_modules.bigip_remote_role module – Manage remote roles on a BIG-IP
Note
This module is part of the f5networks.f5_modules collection (version 1.30.1).
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_role
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manages remote roles on a BIG-IP system. Remote roles are used in situations where user authentication is handled off-box. Local access control to the BIG-IP is controlled by the defined remote role, and authentication (and by extension, assignment to the role) is handled off-box.
Parameters
Parameter |
Comments |
---|---|
Specifies the authorization (level of access) for the account. When creating a new remote role, if this parameter is not provided, the default is The The role you choose may affect the partitions that one is allowed to specify. Specifically, roles such as A set of pre-existing roles ship with the system. They are |
|
Specifies the user account attributes saved in the group, in the format When creating a new remote role, this parameter is required. |
|
Specifies the order of the line in the file The LDAP and Active Directory servers read this file line by line. The order of the information is important; therefore, F5 recommends you set the first line at 1000. This allows you to insert lines before the first line in the future. When creating a new remote role, this parameter is required. |
|
Specifies the name of the remote role. |
|
Specifies the accessible partitions for the account. This parameter supports the reserved names Users who have access to a partition can operate on objects in that partition, as determined by the permissions conferred by the user’s When creating a new remote role, if this parameter is not specified, the default is |
|
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:
|
|
Enables or disables remote access for the specified group of remotely authenticated users. When creating a new remote role, if this parameter is not specified, the default is Choices:
|
|
When When Choices:
|
|
Specifies terminal-based accessibility for remote accounts not already explicitly assigned a user role. Common values for this include When creating a new remote role, if this parameter is not specified, the default is |
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: Create a remote role
bigip_remote_role:
name: ldap_group
line_order: 1
attribute_string: memberOf=cn=ldap_group,cn=ldap.group,ou=ldap
remote_access: true
assigned_role: administrator
partition_access: all
terminal_access: none
state: present
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 |
---|---|
System role this remote role is associated with. Returned: changed Sample: |
|
The new attribute string of the resource. Returned: changed Sample: |
|
Order of the remote role for LDAP and Active Directory servers. Returned: changed Sample: |
|
Partition the role has access to. Returned: changed Sample: |
|
Whether remote access is allowed or not. Returned: changed Sample: |
|
The terminal setting of the remote role. Returned: changed Sample: |