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

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Cyberark_authentication

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

• #api_base_url ⇒ String^?

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

• #cyberark_session ⇒ String^?

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

• #new_password ⇒ Object^?

  The new password of the user.

• #password ⇒ String^?

  The password of the user.

• #state ⇒ :present, ...

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

• #use_radius_authentication ⇒ :yes, ...

  Whether or not users will be authenticated via a RADIUS server.

• #use_shared_logon_authentication ⇒ :yes, ...

  Whether or not Shared Logon Authentication will be used.

• #username ⇒ String^?

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

• #validate_certs ⇒ :yes, ...

  If C(false), SSL certificates will not be validated.

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

#api_base_url ⇒ String^?

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

attribute :api_base_url

#cyberark_session ⇒ String^?

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

attribute :cyberark_session

#new_password ⇒ Object^?

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

attribute :new_password

#password ⇒ String^?

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

attribute :password

#state ⇒ :present, ...

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

attribute :state

#use_radius_authentication ⇒ :yes, ...

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

attribute :use_radius_authentication

#use_shared_logon_authentication ⇒ :yes, ...

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

attribute :use_shared_logon_authentication

#username ⇒ String^?

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

attribute :username

#validate_certs ⇒ :yes, ...

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

attribute :validate_certs