Class: VSphereAutomation::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/vsphere-automation-appliance/configuration.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize {|_self| ... } ⇒ Configuration

Returns a new instance of Configuration.

Yields:

  • (_self)

Yield Parameters:



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/vsphere-automation-appliance/configuration.rb', line 126

def initialize
  @scheme = 'https'
  @host = '<vcenter>'
  @base_path = '/rest'
  @api_key = {}
  @api_key_prefix = {}
  @timeout = 0
  @client_side_validation = true
  @verify_ssl = true
  @verify_ssl_host = true
  @params_encoding = nil
  @cert_file = nil
  @key_file = nil
  @debugging = false
  @inject_format = false
  @force_ending_format = false
  @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)

  yield(self) if block_given?
end

Instance Attribute Details

#access_token ⇒ Object

Defines the access token (Bearer) used with OAuth2.



49
50
51
 
# File 'lib/vsphere-automation-appliance/configuration.rb', line 49

def access_token
  @access_token
end

#api_key ⇒ Hash

Defines API keys used with API Key authentications.

Examples:

parameter name is “api_key”, API key is “xxx” (e.g. “api_key=xxx” in query string)

config.api_key['api_key'] = 'xxx'

Returns:

  • (Hash) —

    key: parameter name, value: parameter value (API key)



28
29
30
 
# File 'lib/vsphere-automation-appliance/configuration.rb', line 28

def api_key
  @api_key
end

#api_key_prefix ⇒ Hash

Defines API key prefixes used with API Key authentications.

Examples:

parameter name is “Authorization”, API key prefix is “Token” (e.g. “Authorization: Token xxx” in headers)

config.api_key_prefix['api_key'] = 'Token'

Returns:

  • (Hash) —

    key: parameter name, value: API key prefix



36
37
38
 
# File 'lib/vsphere-automation-appliance/configuration.rb', line 36

def api_key_prefix
  @api_key_prefix
end

#base_path ⇒ Object

Defines url base path



20
21
22
 
# File 'lib/vsphere-automation-appliance/configuration.rb', line 20

def base_path
  @base_path
end

#cert_file ⇒ Object

TLS/SSL setting Client certificate file (for client certificate)



109
110
111
 
# File 'lib/vsphere-automation-appliance/configuration.rb', line 109

def cert_file
  @cert_file
end

#client_side_validation ⇒ true, false

Set this to false to skip client side validation in the operation. Default to true.

Returns:

  • (true, false) 


78
79
80
 
# File 'lib/vsphere-automation-appliance/configuration.rb', line 78

def client_side_validation
  @client_side_validation
end

#debugging ⇒ true, false

Set this to enable/disable debugging. When enabled (set to true), HTTP request/response details will be logged with ‘logger.debug` (see the `logger` attribute). Default to false.

Returns:

  • (true, false) 


56
57
58
 
# File 'lib/vsphere-automation-appliance/configuration.rb', line 56

def debugging
  @debugging
end

#force_ending_format ⇒ Object

Returns the value of attribute force_ending_format.



124
125
126
 
# File 'lib/vsphere-automation-appliance/configuration.rb', line 124

def force_ending_format
  @force_ending_format
end

#host ⇒ Object

Defines url host



17
18
19
 
# File 'lib/vsphere-automation-appliance/configuration.rb', line 17

def host
  @host
end

#inject_format ⇒ Object

Returns the value of attribute inject_format.



122
123
124
 
# File 'lib/vsphere-automation-appliance/configuration.rb', line 122

def inject_format
  @inject_format
end

#key_file ⇒ Object

TLS/SSL setting Client private key file (for client certificate)



113
114
115
 
# File 'lib/vsphere-automation-appliance/configuration.rb', line 113

def key_file
  @key_file
end

#logger ⇒ #debug

Defines the logger used for debugging. Default to ‘Rails.logger` (when in Rails) or logging to STDOUT.

Returns:

  • (#debug) 


62
63
64
 
# File 'lib/vsphere-automation-appliance/configuration.rb', line 62

def logger
  @logger
end

#params_encoding ⇒ Object

Set this to customize parameters encoding of array parameter with multi collectionFormat. Default to nil.

github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96

See Also:

  • params_encoding option of Ethon. Related source code:


120
121
122
 
# File 'lib/vsphere-automation-appliance/configuration.rb', line 120

def params_encoding
  @params_encoding
end

#password ⇒ String

Defines the password used with HTTP basic authentication.

Returns:

  • (String) 


46
47
48
 
# File 'lib/vsphere-automation-appliance/configuration.rb', line 46

def password
  @password
end

#scheme ⇒ Object

Defines url scheme



14
15
16
 
# File 'lib/vsphere-automation-appliance/configuration.rb', line 14

def scheme
  @scheme
end

#ssl_ca_cert ⇒ String

TLS/SSL setting Set this to customize the certificate file to verify the peer.

github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145

Returns:

  • (String) —

    the path to the certificate file

See Also:

  • `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:


105
106
107
 
# File 'lib/vsphere-automation-appliance/configuration.rb', line 105

def ssl_ca_cert
  @ssl_ca_cert
end

#temp_folder_path ⇒ String

Defines the temporary folder to store downloaded files (for API endpoints that have file response). Default to use ‘Tempfile`.

Returns:

  • (String) 


69
70
71
 
# File 'lib/vsphere-automation-appliance/configuration.rb', line 69

def temp_folder_path
  @temp_folder_path
end

#timeout ⇒ Object

The time limit for HTTP request in seconds. Default to 0 (never times out).



73
74
75
 
# File 'lib/vsphere-automation-appliance/configuration.rb', line 73

def timeout
  @timeout
end

#username ⇒ String

Defines the username used with HTTP basic authentication.

Returns:

  • (String) 


41
42
43
 
# File 'lib/vsphere-automation-appliance/configuration.rb', line 41

def username
  @username
end

#verify_ssl ⇒ true, false

Note:

Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.

TLS/SSL setting Set this to false to skip verifying SSL certificate when calling API from https server. Default to true.

Returns:

  • (true, false) 


87
88
89
 
# File 'lib/vsphere-automation-appliance/configuration.rb', line 87

def verify_ssl
  @verify_ssl
end

#verify_ssl_host ⇒ true, false

Note:

Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.

TLS/SSL setting Set this to false to skip verifying SSL host name Default to true.

Returns:

  • (true, false) 


96
97
98
 
# File 'lib/vsphere-automation-appliance/configuration.rb', line 96

def verify_ssl_host
  @verify_ssl_host
end

Class Method Details

.default ⇒ Object

The default Configuration object.



148
149
150
 
# File 'lib/vsphere-automation-appliance/configuration.rb', line 148

def self.default
  @@default ||= Configuration.new
end

Instance Method Details

#api_key_with_prefix(param_name) ⇒ Object

Gets API key (with prefix if set).

Parameters:

  • param_name (String) —

    the parameter name of API key auth



179
180
181
182
183
184
185
 
# File 'lib/vsphere-automation-appliance/configuration.rb', line 179

def api_key_with_prefix(param_name)
  if @api_key_prefix[param_name]
    "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
  else
    @api_key[param_name]
  end
end

#auth_settings ⇒ Object

Returns Auth Settings hash for api client.



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/vsphere-automation-appliance/configuration.rb', line 193

def auth_settings
  {
    'api_key' =>
      {
        type: 'api_key',
        in: 'header',
        key: 'vmware-api-session-id',
        value: api_key_with_prefix('vmware-api-session-id')
      },
    'basic_auth' =>
      {
        type: 'basic',
        in: 'header',
        key: 'Authorization',
        value: basic_auth_token
      },
  }
end

#base_url ⇒ Object 



172
173
174
175
 
# File 'lib/vsphere-automation-appliance/configuration.rb', line 172

def base_url
  url = "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
  URI.encode(url)
end

#basic_auth_token ⇒ Object

Gets Basic Auth token string



188
189
190
 
# File 'lib/vsphere-automation-appliance/configuration.rb', line 188

def basic_auth_token
  'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
end

#configure {|_self| ... } ⇒ Object

Yields:

  • (_self)

Yield Parameters:



152
153
154
 
# File 'lib/vsphere-automation-appliance/configuration.rb', line 152

def configure
  yield(self) if block_given?
end