Class: Ansible::Ruby::Modules::Netapp_e_ldap

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/storage/netapp/netapp_e_ldap.rb

Overview

Configure an E-Series system to allow authentication via an LDAP server

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#attributes ⇒ String?

Returns The user attributes that should be considered for the group to role mapping.,Typically this is used with something like ‘memberOf’, and a user’s access is tested against group membership or lack thereof.

Returns:

  • (String, nil) —

    The user attributes that should be considered for the group to role mapping.,Typically this is used with something like ‘memberOf’, and a user’s access is tested against group membership or lack thereof.



28
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/netapp_e_ldap.rb', line 28

attribute :attributes

#identifier ⇒ String?

Returns This is a unique identifier for the configuration (for cases where there are multiple domains configured).,If this is not specified, but I(state=present), we will utilize a default value of ‘default’.

Returns:

  • (String, nil) —

    This is a unique identifier for the configuration (for cases where there are multiple domains configured).,If this is not specified, but I(state=present), we will utilize a default value of ‘default’.



16
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/netapp_e_ldap.rb', line 16

attribute :identifier

#log_path ⇒ Object?

Returns A local path to a file to be used for debug logging.

Returns:

  • (Object, nil) —

    A local path to a file to be used for debug logging



51
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/netapp_e_ldap.rb', line 51

attribute :log_path

#name ⇒ Object?

Returns The domain name that will be utilized when authenticating to identify which domain to utilize.,Default to use the DNS name of the I(server).,The only requirement is that the name be resolvable.,Example: [email protected].

Returns:

  • (Object, nil) —

    The domain name that will be utilized when authenticating to identify which domain to utilize.,Default to use the DNS name of the I(server).,The only requirement is that the name be resolvable.,Example: [email protected]



36
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/netapp_e_ldap.rb', line 36

attribute :name

#password ⇒ Object

Returns This is the password for the bind user account.

Returns:

  • (Object) —

    This is the password for the bind user account.



24
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/netapp_e_ldap.rb', line 24

attribute :password

#role_mappings ⇒ Hash

Returns This is where you specify which groups should have access to what permissions for the storage-system.,For example, all users in group A will be assigned all 4 available roles, which will allow access to all the management functionality of the system (super-user). Those in group B only have the storage.monitor role, which will allow only read-only acess.,This is specified as a mapping of regular expressions to a list of roles. See the examples.,The roles that will be assigned to to the group/groups matching the provided regex.,storage.admin allows users full read/write access to storage objects and operations.,storage.monitor allows users read-only access to storage objects and operations.,support.admin allows users access to hardware, diagnostic information, the Major Event Log, and other critical support-related functionality, but not the storage configuration.,security.admin allows users access to authentication/authorization configuration, as well as the audit log configuration, and certification management.

Returns:

  • (Hash) —

    This is where you specify which groups should have access to what permissions for the storage-system.,For example, all users in group A will be assigned all 4 available roles, which will allow access to all the management functionality of the system (super-user). Those in group B only have the storage.monitor role, which will allow only read-only acess.,This is specified as a mapping of regular expressions to a list of roles. See the examples.,The roles that will be assigned to to the group/groups matching the provided regex.,storage.admin allows users full read/write access to storage objects and operations.,storage.monitor allows users read-only access to storage objects and operations.,support.admin allows users access to hardware, diagnostic information, the Major Event Log, and other critical support-related functionality, but not the storage configuration.,security.admin allows users access to authentication/authorization configuration, as well as the audit log configuration, and certification management.



43
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/netapp_e_ldap.rb', line 43

attribute :role_mappings

#search_base ⇒ Array<String>, String

Returns The search base is used to find group memberships of the user.,Example: ou=users,dc=example,dc=com.

Returns:

  • (Array<String>, String) —

    The search base is used to find group memberships of the user.,Example: ou=users,dc=example,dc=com



39
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/netapp_e_ldap.rb', line 39

attribute :search_base

#server ⇒ String

Returns This is the LDAP server url.,The connection string should be specified as using the ldap or ldaps protocol along with the port information.

Returns:

  • (String) —

    This is the LDAP server url.,The connection string should be specified as using the ldap or ldaps protocol along with the port information.



32
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/netapp_e_ldap.rb', line 32

attribute :server

#state ⇒ :present, ...

Returns Enable/disable LDAP support on the system. Disabling will clear out any existing defined domains.

Returns:

  • (:present, :absent, nil) —

    Enable/disable LDAP support on the system. Disabling will clear out any existing defined domains.



12
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/netapp_e_ldap.rb', line 12

attribute :state

#user_attribute ⇒ String?

Returns This is the attribute we will use to match the provided username when a user attempts to authenticate.

Returns:

  • (String, nil) —

    This is the attribute we will use to match the provided username when a user attempts to authenticate.



47
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/netapp_e_ldap.rb', line 47

attribute :user_attribute

#username ⇒ Object

Returns This is the user account that will be used for querying the LDAP server.,Example: CN=MyBindAcct,OU=ServiceAccounts,DC=example,DC=com.

Returns:

  • (Object) —

    This is the user account that will be used for querying the LDAP server.,Example: CN=MyBindAcct,OU=ServiceAccounts,DC=example,DC=com



20
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/netapp_e_ldap.rb', line 20

attribute :username