New in version 2.7.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
assigned_role | Specifies the authorization (level of access) for the account. When creating a new remote role, if this parameter is not provided, the default is none .The partition_access parameter controls which partitions the account can access.The chosen role may affect the partitions that one is allowed to specify. Specifically, roles such as administrator , auditor and resource-administrator required a partition_access of all .A set of pre-existing roles ship with the system. They are none , guest , operator , application-editor , manager , certificate-manager , irule-manager , user-manager , resource-administrator , auditor , administrator , firewall-manager . | ||
attribute_string | Specifies the user account attributes saved in the group, in the format cn=, ou=, dc= .When creating a new remote role, this parameter is required. | ||
line_order | Specifies the order of the line in the file /config/bigip/auth/remoterole .The LDAP and Active Directory servers read this file line by line. The order of the information is important; therefore, F5 recommends that you set the first line at 1000. This allows you, in the future, to insert lines before the first line. When creating a new remote role, this parameter is required. | ||
name required | Specifies the name of the remote role. | ||
partition_access | Specifies the accessible partitions for the account. This parameter supports the reserved names all and Common , as well as specific partitions a user may access.Users who have access to a partition can operate on objects in that partition, as determined by the permissions conferred by the user's assigned_role .When creating a new remote role, if this parameter is not specified, the default is all . | ||
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: None | A dict object containing connection details. | |
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. | |
server required | The BIG-IP host. You may omit this option by setting the environment variable F5_SERVER . | ||
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 . | ||
server_port | Default: 443 | The BIG-IP server port. You may omit this option by setting the environment variable F5_SERVER_PORT . | |
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 | ||
validate_certs bool |
| 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 . | |
transport required |
| Configures the transport connection to use when connecting to the remote device. | |
remote_access bool |
| 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 yes . | |
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 |
| When present , guarantees that the remote role exists.When absent , removes the remote role from the system. | |
terminal_access | Specifies terminal-based accessibility for remote accounts not already explicitly assigned a user role. Common values for this include tmsh and none , however custom values may also be specified.When creating a new remote role, if this parameter is not specified, the default is none . | ||
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 bool (added in 2.0) |
| 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 . |
Note
pip install f5-sdk
.- name: Create a remote role bigip_remote_role: name: foo group_name: ldap_group line_order: 1 attribute_string: memberOf=cn=ldap_group,cn=ldap.group,ou=ldap remote_access: enabled assigned_role: administrator partition_access: all terminal_access: none state: present provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
assigned_role string | changed | System role that this remote role is associated with. Sample: administrator |
attribute_string string | changed | The new attribute string of the resource. Sample: memberOf=cn=ldap_group,cn=ldap.group,ou=ldap |
line_order int | changed | Order of the remote role for LDAP and Active Directory servers. Sample: 1000 |
partition_access string | changed | Partition that the role has access to. Sample: all |
remote_access bool | changed | Whether remote access is allowed or not. |
terminal_access string | changed | The terminal setting of the remote role. Sample: tmsh |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/bigip_remote_role_module.html