Class: Ansible::Ruby::Modules::Ovirt_auth

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_auth.rb

Overview

This module authenticates to oVirt/RHV engine and creates SSO token, which should be later used in all other oVirt/RHV modules, so all modules don’t need to perform login and logout. This module returns an Ansible fact called I(ovirt_auth). Every module can use this fact as C(auth) parameter, to perform authentication.

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

#ca_file ⇒ Object?

Returns A PEM file containing the trusted CA certificates. The certificate presented by the server will be verified using these CA certificates. If C(ca_file) parameter is not set, system wide CA certificate store is used. Default value is set by I(OVIRT_CAFILE) environment variable.

Returns:

  • (Object, nil) —

    A PEM file containing the trusted CA certificates. The certificate presented by the server will be verified using these CA certificates. If C(ca_file) parameter is not set, system wide CA certificate store is used. Default value is set by I(OVIRT_CAFILE) environment variable.



34
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_auth.rb', line 34

attribute :ca_file

#compress ⇒ Object?

Returns A boolean flag indicating if the SDK should ask the server to send compressed responses. The default is I(True). Note that this is a hint for the server, and that it may return uncompressed data even when this parameter is set to I(True).

Returns:

  • (Object, nil) —

    A boolean flag indicating if the SDK should ask the server to send compressed responses. The default is I(True). Note that this is a hint for the server, and that it may return uncompressed data even when this parameter is set to I(True).



40
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_auth.rb', line 40

attribute :compress

#headers ⇒ Object?

Returns A dictionary of HTTP headers to be added to each API call.

Returns:

  • (Object, nil) —

    A dictionary of HTTP headers to be added to each API call.



46
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_auth.rb', line 46

attribute :headers

#hostname ⇒ Object?

Returns A string containing the hostname of the server. For example: I(server.example.com). Default value is set by I(OVIRT_HOSTNAME) environment variable.,Either C(url) or C(hostname) is required.

Returns:

  • (Object, nil) —

    A string containing the hostname of the server. For example: I(server.example.com). Default value is set by I(OVIRT_HOSTNAME) environment variable.,Either C(url) or C(hostname) is required.



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_auth.rb', line 28

attribute :hostname

#insecure ⇒ Object?

Returns A boolean flag that indicates if the server TLS certificate and host name should be checked.

Returns:

  • (Object, nil) —

    A boolean flag that indicates if the server TLS certificate and host name should be checked.



31
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_auth.rb', line 31

attribute :insecure

#kerberos ⇒ Object?

Returns A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication.

Returns:

  • (Object, nil) —

    A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication.



43
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_auth.rb', line 43

attribute :kerberos

#password ⇒ Object?

Returns The password of the user. Default value is set by I(OVIRT_PASSWORD) environment variable.

Returns:

  • (Object, nil) —

    The password of the user. Default value is set by I(OVIRT_PASSWORD) environment variable.



19
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_auth.rb', line 19

attribute :password

#state ⇒ :present, ...

Returns Specifies if a token should be created or revoked.

Returns:

  • (:present, :absent, nil) —

    Specifies if a token should be created or revoked.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_auth.rb', line 12

attribute :state

#timeout ⇒ Object?

Returns The maximum total time to wait for the response, in seconds. A value of zero (the default) means wait forever. If the timeout expires before the response is received an exception will be raised.

Returns:

  • (Object, nil) —

    The maximum total time to wait for the response, in seconds. A value of zero (the default) means wait forever. If the timeout expires before the response is received an exception will be raised.



37
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_auth.rb', line 37

attribute :timeout

#token ⇒ Object?

Returns SSO token to be used instead of login with username/password. Default value is set by I(OVIRT_TOKEN) environment variable.

Returns:

  • (Object, nil) —

    SSO token to be used instead of login with username/password. Default value is set by I(OVIRT_TOKEN) environment variable.



22
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_auth.rb', line 22

attribute :token

#url ⇒ Object?

Returns A string containing the API URL of the server. For example: I(server.example.com/ovirt-engine/api). Default value is set by I(OVIRT_URL) environment variable.,Either C(url) or C(hostname) is required.

Returns:

  • (Object, nil) —

    A string containing the API URL of the server. For example: I(server.example.com/ovirt-engine/api). Default value is set by I(OVIRT_URL) environment variable.,Either C(url) or C(hostname) is required.



25
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_auth.rb', line 25

attribute :url

#username ⇒ Object?

Returns The name of the user. For example: I(admin@internal) Default value is set by I(OVIRT_USERNAME) environment variable.

Returns:

  • (Object, nil) —

    The name of the user. For example: I(admin@internal) Default value is set by I(OVIRT_USERNAME) environment variable.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_auth.rb', line 16

attribute :username