Class: Ansible::Ruby::Modules::Bigip_remote_role

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/network/f5/bigip_remote_role.rb

Overview

Manages remote roles on a BIG-IP. 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. Where-as authentication (and by extension, assignment to the role) is handled off-box.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#assigned_role ⇒ String?

Returns Specifies the authorization (level of access) for the account.,When creating a new remote role, if this parameter is not provided, the default is C(none).,The C(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 C(administrator), C(auditor) and C(resource-administrator) required a C(partition_access) of C(all).,A set of pre-existing roles ship with the system. They are C(none), C(guest), C(operator), C(application-editor), C(manager), C(certificate-manager), C(irule-manager), C(user-manager), C(resource-administrator), C(auditor), C(administrator), C(firewall-manager).

Returns:

  • (String, nil) —

    Specifies the authorization (level of access) for the account.,When creating a new remote role, if this parameter is not provided, the default is C(none).,The C(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 C(administrator), C(auditor) and C(resource-administrator) required a C(partition_access) of C(all).,A set of pre-existing roles ship with the system. They are C(none), C(guest), C(operator), C(application-editor), C(manager), C(certificate-manager), C(irule-manager), C(user-manager), C(resource-administrator), C(auditor), C(administrator), C(firewall-manager).



28
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_remote_role.rb', line 28

attribute :assigned_role

#attribute_string ⇒ Array<String>, ...

Returns Specifies the user account attributes saved in the group, in the format C(cn=, ou=, dc=).,When creating a new remote role, this parameter is required.

Returns:

  • (Array<String>, String, nil) —

    Specifies the user account attributes saved in the group, in the format C(cn=, ou=, dc=).,When creating a new remote role, this parameter is required.



20
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_remote_role.rb', line 20

attribute :attribute_string

#line_order ⇒ Integer?

Returns Specifies the order of the line in the file C(/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.

Returns:

  • (Integer, nil) —

    Specifies the order of the line in the file C(/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.



16
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_remote_role.rb', line 16

attribute :line_order

#name ⇒ String

Returns Specifies the name of the remote role.

Returns:

  • (String) —

    Specifies the name of the remote role.



12
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_remote_role.rb', line 12

attribute :name

#partition_access ⇒ String?

Returns Specifies the accessible partitions for the account.,This parameter supports the reserved names C(all) and C(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 C(assigned_role).,When creating a new remote role, if this parameter is not specified, the default is C(all).

Returns:

  • (String, nil) —

    Specifies the accessible partitions for the account.,This parameter supports the reserved names C(all) and C(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 C(assigned_role).,When creating a new remote role, if this parameter is not specified, the default is C(all).



32
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_remote_role.rb', line 32

attribute :partition_access

#remote_access ⇒ Symbol?

Returns 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 C(yes).

Returns:

  • (Symbol, nil) —

    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 C(yes).



24
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_remote_role.rb', line 24

attribute :remote_access

#state ⇒ :absent, ...

Returns When C(present), guarantees that the remote role exists.,When C(absent), removes the remote role from the system.

Returns:

  • (:absent, :present, nil) —

    When C(present), guarantees that the remote role exists.,When C(absent), removes the remote role from the system.



40
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_remote_role.rb', line 40

attribute :state

#terminal_access ⇒ String?

Returns Specifies terminal-based accessibility for remote accounts not already explicitly assigned a user role.,Common values for this include C(tmsh) and C(none), however custom values may also be specified.,When creating a new remote role, if this parameter is not specified, the default is C(none).

Returns:

  • (String, nil) —

    Specifies terminal-based accessibility for remote accounts not already explicitly assigned a user role.,Common values for this include C(tmsh) and C(none), however custom values may also be specified.,When creating a new remote role, if this parameter is not specified, the default is C(none).



36
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_remote_role.rb', line 36

attribute :terminal_access