Class: Ansible::Ruby::Modules::Cyberark_authentication

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/identity/cyberark/cyberark_authentication.rb

Overview

Authenticates to CyberArk Vault using Privileged Account Security Web Services SDK and creates a session fact that can be used by other modules. It returns an Ansible fact called I(cyberark_session). Every module can use this fact as C(cyberark_session) parameter.

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

#api_base_url ⇒ String?

Returns A string containing the base URL of the server hosting CyberArk’s Privileged Account Security Web Services SDK.

Returns:

  • (String, nil) —

    A string containing the base URL of the server hosting CyberArk’s Privileged Account Security Web Services SDK.



27
 
# File 'lib/ansible/ruby/modules/generated/identity/cyberark/cyberark_authentication.rb', line 27

attribute :api_base_url

#cyberark_session ⇒ String?

Returns Dictionary set by a CyberArk authentication containing the different values to perform actions on a logged-on CyberArk session.

Returns:

  • (String, nil) —

    Dictionary set by a CyberArk authentication containing the different values to perform actions on a logged-on CyberArk session.



43
 
# File 'lib/ansible/ruby/modules/generated/identity/cyberark/cyberark_authentication.rb', line 43

attribute :cyberark_session

#new_password ⇒ Object?

Returns The new password of the user. This parameter is optional, and enables you to change a password.

Returns:

  • (Object, nil) —

    The new password of the user. This parameter is optional, and enables you to change a password.



24
 
# File 'lib/ansible/ruby/modules/generated/identity/cyberark/cyberark_authentication.rb', line 24

attribute :new_password

#password ⇒ String?

Returns The password of the user.

Returns:

  • (String, nil) —

    The password of the user.



20
 
# File 'lib/ansible/ruby/modules/generated/identity/cyberark/cyberark_authentication.rb', line 20

attribute :password

#state ⇒ :present, ...

Returns Specifies if an authentication logon/logoff and a cyberark_session should be added/removed.

Returns:

  • (:present, :absent, nil) —

    Specifies if an authentication logon/logoff and a cyberark_session should be added/removed.



12
 
# File 'lib/ansible/ruby/modules/generated/identity/cyberark/cyberark_authentication.rb', line 12

attribute :state

#use_radius_authentication ⇒ :yes, ...

Returns Whether or not users will be authenticated via a RADIUS server. Valid values are true/false.

Returns:

  • (:yes, :no, nil) —

    Whether or not users will be authenticated via a RADIUS server. Valid values are true/false.



39
 
# File 'lib/ansible/ruby/modules/generated/identity/cyberark/cyberark_authentication.rb', line 39

attribute :use_radius_authentication

#use_shared_logon_authentication ⇒ :yes, ...

Returns Whether or not Shared Logon Authentication will be used.

Returns:

  • (:yes, :no, nil) —

    Whether or not Shared Logon Authentication will be used.



35
 
# File 'lib/ansible/ruby/modules/generated/identity/cyberark/cyberark_authentication.rb', line 35

attribute :use_shared_logon_authentication

#username ⇒ String?

Returns The name of the user who will logon to the Vault.

Returns:

  • (String, nil) —

    The name of the user who will logon to the Vault.



16
 
# File 'lib/ansible/ruby/modules/generated/identity/cyberark/cyberark_authentication.rb', line 16

attribute :username

#validate_certs ⇒ :yes, ...

Returns If C(false), SSL certificates will not be validated. This should only set to C(false) used on personally controlled sites using self-signed certificates.

Returns:

  • (:yes, :no, nil) —

    If C(false), SSL certificates will not be validated. This should only set to C(false) used on personally controlled sites using self-signed certificates.



31
 
# File 'lib/ansible/ruby/modules/generated/identity/cyberark/cyberark_authentication.rb', line 31

attribute :validate_certs