Class: OCI::ManagementAgent::ManagementAgentClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/management_agent/management_agent_client.rb

Overview

Use the Management Agent API to manage your infrastructure's management agents, including their plugins and install keys. For more information, see Management Agent.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ManagementAgentClient

Creates a new ManagementAgentClient. Notes: If a config is not specified, then the global OCI.config will be used.

This client is not thread-safe

Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.

Parameters:

  • config (Config) (defaults to: nil) —

    A Config object.

  • region (String) (defaults to: nil) —

    A region used to determine the service endpoint. This will usually correspond to a value in Regions::REGION_ENUM, but may be an arbitrary string.

  • endpoint (String) (defaults to: nil) —

    The fully qualified endpoint URL

  • signer (OCI::BaseSigner) (defaults to: nil) —

    A signer implementation which can be used by this client. If this is not provided then a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication, so that the instance principals signer can be provided to the client

  • proxy_settings (OCI::ApiClientProxySettings) (defaults to: nil) —

    If your environment requires you to use a proxy server for outgoing HTTP requests the details for the proxy can be provided in this parameter

  • retry_config (OCI::Retry::RetryConfig) (defaults to: nil) —

    The retry configuration for this service client. This represents the default retry configuration to apply across all operations. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 56

def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil)
  # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers)
  # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals
  # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then
  # pass it to this constructor.
  #
  # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid
  # so try and load the config from the default file.
  config = OCI::Config.validate_and_build_config_with_signer(config, signer)

  signer = OCI::Signer.config_file_auth_builder(config) if signer.nil?

  @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings)
  @retry_config = retry_config

  if endpoint
    @endpoint = endpoint + '/20200202'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "ManagementAgentClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



16
17
18
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 16

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 20

def endpoint
  @endpoint
end

#region ⇒ String

The region, which will usually correspond to a value in Regions::REGION_ENUM.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 30

def region
  @region
end

#retry_config ⇒ OCI::Retry::RetryConfig (readonly)

The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries

Returns:



26
27
28
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 26

def retry_config
  @retry_config
end

Instance Method Details

#create_data_source(management_agent_id, create_data_source_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_data_source API.

Datasource creation request to given Management Agent.

Parameters:

  • management_agent_id (String) —

    Unique Management Agent identifier

  • create_data_source_details (OCI::ManagementAgent::Models::CreateDataSourceDetails) —

    Details of DataSource to be created for the given Management Agent.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 126

def create_data_source(management_agent_id, create_data_source_details, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#create_data_source.' if logger

  raise "Missing the required parameter 'management_agent_id' when calling create_data_source." if management_agent_id.nil?
  raise "Missing the required parameter 'create_data_source_details' when calling create_data_source." if create_data_source_details.nil?
  raise "Parameter value for 'management_agent_id' must not be blank" if OCI::Internal::Util.blank_string?(management_agent_id)

  path = '/managementAgents/{managementAgentId}/dataSources'.sub('{managementAgentId}', management_agent_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_data_source_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#create_data_source') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_management_agent_install_key(create_management_agent_install_key_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_management_agent_install_key API.

User creates a new install key as part of this API.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 190

def create_management_agent_install_key(create_management_agent_install_key_details, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#create_management_agent_install_key.' if logger

  raise "Missing the required parameter 'create_management_agent_install_key_details' when calling create_management_agent_install_key." if create_management_agent_install_key_details.nil?

  path = '/managementAgentInstallKeys'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_management_agent_install_key_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#create_management_agent_install_key') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::ManagementAgent::Models::ManagementAgentInstallKey'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_named_credential(create_named_credential_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_named_credential API.

Named credential creation request to given Management Agent.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 258

def create_named_credential(create_named_credential_details, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#create_named_credential.' if logger

  raise "Missing the required parameter 'create_named_credential_details' when calling create_named_credential." if create_named_credential_details.nil?

  path = '/namedCredentials'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_named_credential_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#create_named_credential') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::ManagementAgent::Models::NamedCredential'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_data_source(management_agent_id, data_source_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_data_source API.

Datasource delete request to given Management Agent.

Parameters:

  • management_agent_id (String) —

    Unique Management Agent identifier

  • data_source_key (String) —

    Data source type and name identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 322

def delete_data_source(management_agent_id, data_source_key, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#delete_data_source.' if logger

  raise "Missing the required parameter 'management_agent_id' when calling delete_data_source." if management_agent_id.nil?
  raise "Missing the required parameter 'data_source_key' when calling delete_data_source." if data_source_key.nil?
  raise "Parameter value for 'management_agent_id' must not be blank" if OCI::Internal::Util.blank_string?(management_agent_id)
  raise "Parameter value for 'data_source_key' must not be blank" if OCI::Internal::Util.blank_string?(data_source_key)

  path = '/managementAgents/{managementAgentId}/dataSources/{dataSourceKey}'.sub('{managementAgentId}', management_agent_id.to_s).sub('{dataSourceKey}', data_source_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#delete_data_source') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_management_agent(management_agent_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_management_agent API.

Deletes a Management Agent resource by identifier

Parameters:

  • management_agent_id (String) —

    Unique Management Agent identifier

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 384

def delete_management_agent(management_agent_id, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#delete_management_agent.' if logger

  raise "Missing the required parameter 'management_agent_id' when calling delete_management_agent." if management_agent_id.nil?
  raise "Parameter value for 'management_agent_id' must not be blank" if OCI::Internal::Util.blank_string?(management_agent_id)

  path = '/managementAgents/{managementAgentId}'.sub('{managementAgentId}', management_agent_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#delete_management_agent') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_management_agent_install_key(management_agent_install_key_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_management_agent_install_key API.

Deletes a Management Agent install Key resource by identifier

Parameters:

  • management_agent_install_key_id (String) —

    Unique Management Agent Install Key identifier

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 444

def delete_management_agent_install_key(management_agent_install_key_id, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#delete_management_agent_install_key.' if logger

  raise "Missing the required parameter 'management_agent_install_key_id' when calling delete_management_agent_install_key." if management_agent_install_key_id.nil?
  raise "Parameter value for 'management_agent_install_key_id' must not be blank" if OCI::Internal::Util.blank_string?(management_agent_install_key_id)

  path = '/managementAgentInstallKeys/{managementAgentInstallKeyId}'.sub('{managementAgentInstallKeyId}', management_agent_install_key_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#delete_management_agent_install_key') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_named_credential(named_credential_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_named_credential API.

Named credential delete request to sent to associated Management Agent.

Parameters:

  • named_credential_id (String) —

    Named credential ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 505

def delete_named_credential(named_credential_id, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#delete_named_credential.' if logger

  raise "Missing the required parameter 'named_credential_id' when calling delete_named_credential." if named_credential_id.nil?
  raise "Parameter value for 'named_credential_id' must not be blank" if OCI::Internal::Util.blank_string?(named_credential_id)

  path = '/namedCredentials/{namedCredentialId}'.sub('{namedCredentialId}', named_credential_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#delete_named_credential') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_work_request(work_request_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_work_request API.

Cancel the work request with the given ID.

Parameters:

  • work_request_id (String) —

    The ID of the asynchronous request.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 565

def delete_work_request(work_request_id, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#delete_work_request.' if logger

  raise "Missing the required parameter 'work_request_id' when calling delete_work_request." if work_request_id.nil?
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

  path = '/workRequests/{workRequestId}'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#delete_work_request') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#deploy_plugins(deploy_plugins_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use deploy_plugins API.

Deploys Plugins to a given list of agentIds.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 626

def deploy_plugins(deploy_plugins_details, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#deploy_plugins.' if logger

  raise "Missing the required parameter 'deploy_plugins_details' when calling deploy_plugins." if deploy_plugins_details.nil?

  path = '/managementAgents/actions/deployPlugins'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(deploy_plugins_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#deploy_plugins') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_auto_upgradable_config(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_auto_upgradable_config API.

Get the AutoUpgradable configuration for all agents in a tenancy. The supplied compartmentId must be a tenancy root.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment to which a request will be scoped.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 682

def get_auto_upgradable_config(compartment_id, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#get_auto_upgradable_config.' if logger

  raise "Missing the required parameter 'compartment_id' when calling get_auto_upgradable_config." if compartment_id.nil?

  path = '/managementAgents/actions/getAutoUpgradableConfig'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#get_auto_upgradable_config') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::ManagementAgent::Models::AutoUpgradableConfig'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_data_source(management_agent_id, data_source_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_data_source API.

Get Datasource details for given Id and given Management Agent.

Parameters:

  • management_agent_id (String) —

    Unique Management Agent identifier

  • data_source_key (String) —

    Data source type and name identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 744

def get_data_source(management_agent_id, data_source_key, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#get_data_source.' if logger

  raise "Missing the required parameter 'management_agent_id' when calling get_data_source." if management_agent_id.nil?
  raise "Missing the required parameter 'data_source_key' when calling get_data_source." if data_source_key.nil?
  raise "Parameter value for 'management_agent_id' must not be blank" if OCI::Internal::Util.blank_string?(management_agent_id)
  raise "Parameter value for 'data_source_key' must not be blank" if OCI::Internal::Util.blank_string?(data_source_key)

  path = '/managementAgents/{managementAgentId}/dataSources/{dataSourceKey}'.sub('{managementAgentId}', management_agent_id.to_s).sub('{dataSourceKey}', data_source_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#get_data_source') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::ManagementAgent::Models::DataSource'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_management_agent(management_agent_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_management_agent API.

Gets complete details of the inventory of a given agent id

Parameters:

  • management_agent_id (String) —

    Unique Management Agent identifier

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 802

def get_management_agent(management_agent_id, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#get_management_agent.' if logger

  raise "Missing the required parameter 'management_agent_id' when calling get_management_agent." if management_agent_id.nil?
  raise "Parameter value for 'management_agent_id' must not be blank" if OCI::Internal::Util.blank_string?(management_agent_id)

  path = '/managementAgents/{managementAgentId}'.sub('{managementAgentId}', management_agent_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#get_management_agent') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::ManagementAgent::Models::ManagementAgent'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_management_agent_install_key(management_agent_install_key_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_management_agent_install_key API.

Gets complete details of the Agent install Key for a given key id

Parameters:

  • management_agent_install_key_id (String) —

    Unique Management Agent Install Key identifier

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 856

def get_management_agent_install_key(management_agent_install_key_id, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#get_management_agent_install_key.' if logger

  raise "Missing the required parameter 'management_agent_install_key_id' when calling get_management_agent_install_key." if management_agent_install_key_id.nil?
  raise "Parameter value for 'management_agent_install_key_id' must not be blank" if OCI::Internal::Util.blank_string?(management_agent_install_key_id)

  path = '/managementAgentInstallKeys/{managementAgentInstallKeyId}'.sub('{managementAgentInstallKeyId}', management_agent_install_key_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#get_management_agent_install_key') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::ManagementAgent::Models::ManagementAgentInstallKey'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_management_agent_install_key_content(management_agent_install_key_id, opts = {}, &block) ⇒ Response

Note:

Click here to see an example of how to use get_management_agent_install_key_content API.

Returns a file with Management Agent install Key in it

Parameters:

  • management_agent_install_key_id (String) —

    Unique Management Agent Install Key identifier

  • opts (Hash) (defaults to: {}) —

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :plugin_name (Array<String>) —

    Filter to return input plugin names uncommented in the output. (default to [])

  • :response_target (String, IO) —

    Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

  • (Response) —

    A Response object with data of type String if response_target and block are not given, otherwise with nil data



914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 914

def get_management_agent_install_key_content(management_agent_install_key_id, opts = {}, &block)
  logger.debug 'Calling operation ManagementAgentClient#get_management_agent_install_key_content.' if logger

  raise "Missing the required parameter 'management_agent_install_key_id' when calling get_management_agent_install_key_content." if management_agent_install_key_id.nil?
  raise "Parameter value for 'management_agent_install_key_id' must not be blank" if OCI::Internal::Util.blank_string?(management_agent_install_key_id)

  path = '/managementAgentInstallKeys/{managementAgentInstallKeyId}/content'.sub('{managementAgentInstallKeyId}', management_agent_install_key_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:pluginName] = OCI::ApiClient.build_collection_params(opts[:plugin_name], :multi) if opts[:plugin_name] && !opts[:plugin_name].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/octet-stream'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#get_management_agent_install_key_content') do
    if !block.nil?
      @api_client.call_api(
        :GET,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @api_client.call_api(
          :GET,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :GET,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :GET,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#get_named_credential(named_credential_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_named_credential API.

Get Named credential details for given Id and given Management Agent.

Parameters:

  • named_credential_id (String) —

    Named credential ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 1020

def get_named_credential(named_credential_id, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#get_named_credential.' if logger

  raise "Missing the required parameter 'named_credential_id' when calling get_named_credential." if named_credential_id.nil?
  raise "Parameter value for 'named_credential_id' must not be blank" if OCI::Internal::Util.blank_string?(named_credential_id)

  path = '/namedCredentials/{namedCredentialId}'.sub('{namedCredentialId}', named_credential_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#get_named_credential') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::ManagementAgent::Models::NamedCredential'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_named_credentials_metadatum(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_named_credentials_metadatum API.

Return the Metadata definition for Named Credentials supported by Management Agent.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment to which a request will be scoped.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :management_agent_id (String) —

    Filter the named credential metadata which is compatible with the given Management Agent identifier.

Returns:



1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 1078

def get_named_credentials_metadatum(compartment_id, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#get_named_credentials_metadatum.' if logger

  raise "Missing the required parameter 'compartment_id' when calling get_named_credentials_metadatum." if compartment_id.nil?

  path = '/managementAgents/namedCredentialsMetadata'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:managementAgentId] = opts[:management_agent_id] if opts[:management_agent_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#get_named_credentials_metadatum') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::ManagementAgent::Models::NamedCredentialsMetadatum'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_work_request(work_request_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_work_request API.

Gets the status of the work request with the given ID.

Parameters:

  • work_request_id (String) —

    The ID of the asynchronous request.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 1133

def get_work_request(work_request_id, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#get_work_request.' if logger

  raise "Missing the required parameter 'work_request_id' when calling get_work_request." if work_request_id.nil?
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

  path = '/workRequests/{workRequestId}'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#get_work_request') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::ManagementAgent::Models::WorkRequest'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_availability_histories(management_agent_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_availability_histories API.

Lists the availability history records of Management Agent Allowed values are: timeAvailabilityStatusStarted

Parameters:

  • management_agent_id (String) —

    Unique Management Agent identifier

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :time_availability_status_ended_greater_than (DateTime) —

    Filter to limit the availability history results to that of time after the input time including the boundary record. Defaulted to current date minus one year. The date and time to be given as described in RFC 3339, section 5.6.

  • :time_availability_status_started_less_than (DateTime) —

    Filter to limit the availability history results to that of time before the input time including the boundary record Defaulted to current date. The date and time to be given as described in RFC 3339, section 5.6.

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'. Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. Default order for timeAvailabilityStatusStarted is descending. (default to timeAvailabilityStatusStarted)

Returns:



1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 1202

def list_availability_histories(management_agent_id, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#list_availability_histories.' if logger

  raise "Missing the required parameter 'management_agent_id' when calling list_availability_histories." if management_agent_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[timeAvailabilityStatusStarted].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeAvailabilityStatusStarted.'
  end
  raise "Parameter value for 'management_agent_id' must not be blank" if OCI::Internal::Util.blank_string?(management_agent_id)

  path = '/managementAgents/{managementAgentId}/availabilityHistories'.sub('{managementAgentId}', management_agent_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:timeAvailabilityStatusEndedGreaterThan] = opts[:time_availability_status_ended_greater_than] if opts[:time_availability_status_ended_greater_than]
  query_params[:timeAvailabilityStatusStartedLessThan] = opts[:time_availability_status_started_less_than] if opts[:time_availability_status_started_less_than]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#list_availability_histories') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::ManagementAgent::Models::AvailabilityHistorySummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_data_sources(management_agent_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_data_sources API.

A list of Management Agent Data Sources for the given Management Agent Id.

Allowed values are: dataSourceName, dataSourceType

Parameters:

  • management_agent_id (String) —

    Unique Management Agent identifier

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of items to return.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. If no value is specified dataSourceName is default. (default to dataSourceName)

  • :name (Array<String>) —

    Unique name of the dataSource.

Returns:



1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 1279

def list_data_sources(management_agent_id, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#list_data_sources.' if logger

  raise "Missing the required parameter 'management_agent_id' when calling list_data_sources." if management_agent_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[dataSourceName dataSourceType].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of dataSourceName, dataSourceType.'
  end
  raise "Parameter value for 'management_agent_id' must not be blank" if OCI::Internal::Util.blank_string?(management_agent_id)

  path = '/managementAgents/{managementAgentId}/dataSources'.sub('{managementAgentId}', management_agent_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:name] = OCI::ApiClient.build_collection_params(opts[:name], :multi) if opts[:name] && !opts[:name].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#list_data_sources') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::ManagementAgent::Models::DataSourceSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_management_agent_images(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_management_agent_images API.

Get supported agent image information

Allowed values are: platformType, version

Parameters:

  • compartment_id (String) —

    The OCID of the compartment to which a request will be scoped.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for platformType is descending. Default order for version is descending. If no value is specified platformType is default. (default to platformType)

  • :name (String) —

    A filter to return only resources that match the entire platform name given.

  • :lifecycle_state (String) —

    Filter to return only Management Agents in the particular lifecycle state.

  • :install_type (String) —

    A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned.

Returns:



1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 1363

def list_management_agent_images(compartment_id, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#list_management_agent_images.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_management_agent_images." if compartment_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[platformType version].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of platformType, version.'
  end

  if opts[:lifecycle_state] && !OCI::ManagementAgent::Models::LIFECYCLE_STATES_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::ManagementAgent::Models::LIFECYCLE_STATES_ENUM.'
  end

  if opts[:install_type] && !OCI::ManagementAgent::Models::INSTALL_TYPES_ENUM.include?(opts[:install_type])
    raise 'Invalid value for "install_type", must be one of the values in OCI::ManagementAgent::Models::INSTALL_TYPES_ENUM.'
  end

  path = '/managementAgentImages'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:installType] = opts[:install_type] if opts[:install_type]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#list_management_agent_images') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::ManagementAgent::Models::ManagementAgentImageSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_management_agent_install_keys(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_management_agent_install_keys API.

Returns a list of Management Agent installed Keys.

Allowed values are: timeCreated, displayName

Parameters:

  • compartment_id (String) —

    The OCID of the compartment to which a request will be scoped.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified. (default to false)

  • :access_level (String) —

    Value of this is always "ACCESSIBLE" and any other value is not supported. (default to ACCESSIBLE)

  • :lifecycle_state (String) —

    Filter to return only Management Agents in the particular lifecycle state.

  • :display_name (String) —

    The display name for which the Key needs to be listed.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 1453

def list_management_agent_install_keys(compartment_id, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#list_management_agent_install_keys.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_management_agent_install_keys." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::ManagementAgent::Models::LIFECYCLE_STATES_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::ManagementAgent::Models::LIFECYCLE_STATES_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.'
  end

  path = '/managementAgentInstallKeys'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#list_management_agent_install_keys') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::ManagementAgent::Models::ManagementAgentInstallKeySummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_management_agent_plugins(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_management_agent_plugins API.

Returns a list of managementAgentPlugins.

Allowed values are: displayName

Parameters:

  • compartment_id (String) —

    The OCID of the compartment to which a request will be scoped.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :display_name (String) —

    Filter to return only Management Agent Plugins having the particular display name.

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. Default order for displayName is ascending. If no value is specified displayName is default. (default to displayName)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :lifecycle_state (String) —

    Filter to return only Management Agents in the particular lifecycle state.

  • :platform_type (Array<String>) —

    Filter to return only results having the particular platform type. Allowed values are: LINUX, WINDOWS, SOLARIS, MACOSX, AIX

  • :agent_id (String) —

    The ManagementAgentID of the agent from which the Management Agents to be filtered.

Returns:



1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 1539

def list_management_agent_plugins(compartment_id, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#list_management_agent_plugins.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_management_agent_plugins." if compartment_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName.'
  end

  if opts[:lifecycle_state] && !OCI::ManagementAgent::Models::LIFECYCLE_STATES_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::ManagementAgent::Models::LIFECYCLE_STATES_ENUM.'
  end


  platform_type_allowable_values = %w[LINUX WINDOWS SOLARIS MACOSX AIX]
  if opts[:platform_type] && !opts[:platform_type].empty?
    opts[:platform_type].each do |val_to_check|
      unless platform_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "platform_type", must be one of LINUX, WINDOWS, SOLARIS, MACOSX, AIX.'
      end
    end
  end

  path = '/managementAgentPlugins'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:platformType] = OCI::ApiClient.build_collection_params(opts[:platform_type], :multi) if opts[:platform_type] && !opts[:platform_type].empty?
  query_params[:agentId] = opts[:agent_id] if opts[:agent_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#list_management_agent_plugins') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::ManagementAgent::Models::ManagementAgentPluginSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_management_agents(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_management_agents API.

Returns a list of Management Agents. If no explicit page size limit is specified, it will default to 1000. The response is limited to maximum 1000 records when compartmentIdInSubtree is true.

Allowed values are: timeCreated, displayName, host, availabilityStatus, platformType, pluginDisplayNames, version

Parameters:

  • compartment_id (String) —

    The OCID of the compartment to which a request will be scoped.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :plugin_name (Array<String>) —

    Filter to return only Management Agents having the particular Plugin installed. A special pluginName of 'None' can be provided and this will return only Management Agents having no plugin installed.

  • :version (Array<String>) —

    Filter to return only Management Agents having the particular agent version.

  • :display_name (String) —

    Filter to return only Management Agents having the particular display name.

  • :lifecycle_state (String) —

    Filter to return only Management Agents in the particular lifecycle state.

  • :availability_status (String) —

    Filter to return only Management Agents in the particular availability status.

  • :host_id (String) —

    Filter to return only Management Agents having the particular agent host id.

  • :platform_type (Array<String>) —

    Filter to return only results having the particular platform type. Allowed values are: LINUX, WINDOWS, SOLARIS, MACOSX, AIX

  • :is_customer_deployed (BOOLEAN) —

    true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.

  • :install_type (String) —

    A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned.

  • :gateway_id (Array<String>) —

    Filter to return only results having the particular gatewayId.

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :compartment_id_in_subtree (BOOLEAN) —

    if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified. (default to false)

  • :access_level (String) —

    When the value is "ACCESSIBLE", insufficient permissions for a compartment will filter out resources in that compartment without rejecting the request.

  • :data_source_type (String) —

    The type of the dataSource.

  • :data_source_name (Array<String>) —

    Unique name of the dataSource.

Returns:



1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 1649

def list_management_agents(compartment_id, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#list_management_agents.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_management_agents." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::ManagementAgent::Models::LIFECYCLE_STATES_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::ManagementAgent::Models::LIFECYCLE_STATES_ENUM.'
  end

  if opts[:availability_status] && !OCI::ManagementAgent::Models::AVAILABILITY_STATUS_ENUM.include?(opts[:availability_status])
    raise 'Invalid value for "availability_status", must be one of the values in OCI::ManagementAgent::Models::AVAILABILITY_STATUS_ENUM.'
  end


  platform_type_allowable_values = %w[LINUX WINDOWS SOLARIS MACOSX AIX]
  if opts[:platform_type] && !opts[:platform_type].empty?
    opts[:platform_type].each do |val_to_check|
      unless platform_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "platform_type", must be one of LINUX, WINDOWS, SOLARIS, MACOSX, AIX.'
      end
    end
  end

  if opts[:install_type] && !OCI::ManagementAgent::Models::INSTALL_TYPES_ENUM.include?(opts[:install_type])
    raise 'Invalid value for "install_type", must be one of the values in OCI::ManagementAgent::Models::INSTALL_TYPES_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[timeCreated displayName host availabilityStatus platformType pluginDisplayNames version].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName, host, availabilityStatus, platformType, pluginDisplayNames, version.'
  end

  if opts[:data_source_type] && !OCI::ManagementAgent::Models::DATA_SOURCE_TYPES_ENUM.include?(opts[:data_source_type])
    raise 'Invalid value for "data_source_type", must be one of the values in OCI::ManagementAgent::Models::DATA_SOURCE_TYPES_ENUM.'
  end

  path = '/managementAgents'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:pluginName] = OCI::ApiClient.build_collection_params(opts[:plugin_name], :multi) if opts[:plugin_name] && !opts[:plugin_name].empty?
  query_params[:version] = OCI::ApiClient.build_collection_params(opts[:version], :multi) if opts[:version] && !opts[:version].empty?
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:availabilityStatus] = opts[:availability_status] if opts[:availability_status]
  query_params[:hostId] = opts[:host_id] if opts[:host_id]
  query_params[:platformType] = OCI::ApiClient.build_collection_params(opts[:platform_type], :multi) if opts[:platform_type] && !opts[:platform_type].empty?
  query_params[:isCustomerDeployed] = opts[:is_customer_deployed] if !opts[:is_customer_deployed].nil?
  query_params[:installType] = opts[:install_type] if opts[:install_type]
  query_params[:gatewayId] = OCI::ApiClient.build_collection_params(opts[:gateway_id], :multi) if opts[:gateway_id] && !opts[:gateway_id].empty?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:dataSourceType] = opts[:data_source_type] if opts[:data_source_type]
  query_params[:dataSourceName] = OCI::ApiClient.build_collection_params(opts[:data_source_name], :multi) if opts[:data_source_name] && !opts[:data_source_name].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#list_management_agents') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::ManagementAgent::Models::ManagementAgentSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_named_credentials(management_agent_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_named_credentials API.

A list of Management Agent Data Sources for the given Management Agent Id.

Allowed values are: name, type, timeCreated, lifecycleState

Parameters:

  • management_agent_id (String) —

    The ManagementAgentID of the agent from which the named credentials are associated.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of items to return.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. If no value is specified timeCreated is default. (default to timeCreated)

  • :lifecycle_state (Array<OCI::ManagementAgent::Models::OCI::ManagementAgent::Models::NamedCredentialLifecycleState>) —

    Filter to return only Management Agents in the particular lifecycle state.

  • :name (Array<String>) —

    Filter list for these name items.

  • :type (Array<String>) —

    Filter list for these type values.

  • :id (Array<String>) —

    Filter list for these Named credentials identifiers (ocid) values.

Returns:



1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 1767

def list_named_credentials(management_agent_id, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#list_named_credentials.' if logger

  raise "Missing the required parameter 'management_agent_id' when calling list_named_credentials." if management_agent_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[name type timeCreated lifecycleState].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of name, type, timeCreated, lifecycleState.'
  end

  path = '/namedCredentials'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:managementAgentId] = management_agent_id
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:lifecycleState] = OCI::ApiClient.build_collection_params(opts[:lifecycle_state], :multi) if opts[:lifecycle_state] && !opts[:lifecycle_state].empty?
  query_params[:name] = OCI::ApiClient.build_collection_params(opts[:name], :multi) if opts[:name] && !opts[:name].empty?
  query_params[:type] = OCI::ApiClient.build_collection_params(opts[:type], :multi) if opts[:type] && !opts[:type].empty?
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#list_named_credentials') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::ManagementAgent::Models::NamedCredentialCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_request_errors(work_request_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_work_request_errors API.

Return a (paginated) list of errors for a given work request.

Allowed values are: timestamp

Parameters:

  • work_request_id (String) —

    The ID of the asynchronous request.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of items to return.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. Only one sort order may (default to timestamp)

Returns:



1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 1845

def list_work_request_errors(work_request_id, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#list_work_request_errors.' if logger

  raise "Missing the required parameter 'work_request_id' when calling list_work_request_errors." if work_request_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[timestamp].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timestamp.'
  end
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

  path = '/workRequests/{workRequestId}/errors'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#list_work_request_errors') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::ManagementAgent::Models::WorkRequestError>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_request_logs(work_request_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_work_request_logs API.

Return a (paginated) list of logs for a given work request.

Allowed values are: timestamp

Parameters:

  • work_request_id (String) —

    The ID of the asynchronous request.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of items to return.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. Only one sort order may (default to timestamp)

Returns:



1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 1919

def list_work_request_logs(work_request_id, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#list_work_request_logs.' if logger

  raise "Missing the required parameter 'work_request_id' when calling list_work_request_logs." if work_request_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[timestamp].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timestamp.'
  end
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

  path = '/workRequests/{workRequestId}/logs'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#list_work_request_logs') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::ManagementAgent::Models::WorkRequestLogEntry>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_requests(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_work_requests API.

Lists the work requests in a compartment.

Allowed values are: timeAccepted

Parameters:

  • compartment_id (String) —

    The OCID of the compartment to which a request will be scoped.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :agent_id (String) —

    The ManagementAgentID of the agent from which the Management Agents to be filtered.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of items to return.

  • :status (String) —

    The OperationStatus of the workRequest

  • :type (Array<String>) —

    The OperationType of the workRequest Allowed values are: DEPLOY_PLUGIN, UPGRADE_PLUGIN, CREATE_PLUGIN, CREATE_UPGRADE_PLUGINS, AGENTIMAGE_UPGRADE, CREATE_DATA_SOURCE, UPDATE_DATA_SOURCE, DELETE_DATA_SOURCE, CREATE_NAMEDCREDENTIALS, UPDATE_NAMEDCREDENTIALS, DELETE_NAMEDCREDENTIALS, AGENT_UPGRADE

  • :time_created_greater_than_or_equal_to (DateTime) —

    Filter for items with timeCreated greater or equal to provided value. given timeCreatedGreaterThanOrEqualTo to the current time, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. If no value is specified timeAccepted is default. (default to timeAccepted)

Returns:



2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 2001

def list_work_requests(compartment_id, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#list_work_requests.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_work_requests." if compartment_id.nil?

  if opts[:status] && !OCI::ManagementAgent::Models::OPERATION_STATUS_ENUM.include?(opts[:status])
    raise 'Invalid value for "status", must be one of the values in OCI::ManagementAgent::Models::OPERATION_STATUS_ENUM.'
  end


  type_allowable_values = %w[DEPLOY_PLUGIN UPGRADE_PLUGIN CREATE_PLUGIN CREATE_UPGRADE_PLUGINS AGENTIMAGE_UPGRADE CREATE_DATA_SOURCE UPDATE_DATA_SOURCE DELETE_DATA_SOURCE CREATE_NAMEDCREDENTIALS UPDATE_NAMEDCREDENTIALS DELETE_NAMEDCREDENTIALS AGENT_UPGRADE]
  if opts[:type] && !opts[:type].empty?
    opts[:type].each do |val_to_check|
      unless type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "type", must be one of DEPLOY_PLUGIN, UPGRADE_PLUGIN, CREATE_PLUGIN, CREATE_UPGRADE_PLUGINS, AGENTIMAGE_UPGRADE, CREATE_DATA_SOURCE, UPDATE_DATA_SOURCE, DELETE_DATA_SOURCE, CREATE_NAMEDCREDENTIALS, UPDATE_NAMEDCREDENTIALS, DELETE_NAMEDCREDENTIALS, AGENT_UPGRADE.'
      end
    end
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[timeAccepted].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeAccepted.'
  end

  path = '/workRequests'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:agentId] = opts[:agent_id] if opts[:agent_id]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:status] = opts[:status] if opts[:status]
  query_params[:type] = OCI::ApiClient.build_collection_params(opts[:type], :multi) if opts[:type] && !opts[:type].empty?
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#list_work_requests') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::ManagementAgent::Models::WorkRequestSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



95
96
97
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 95

def logger
  @api_client.config.logger
end

#set_auto_upgradable_config(set_auto_upgradable_config_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use set_auto_upgradable_config API.

Sets the AutoUpgradable configuration for all agents in a tenancy. The supplied compartmentId must be a tenancy root.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 2093

def set_auto_upgradable_config(set_auto_upgradable_config_details, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#set_auto_upgradable_config.' if logger

  raise "Missing the required parameter 'set_auto_upgradable_config_details' when calling set_auto_upgradable_config." if set_auto_upgradable_config_details.nil?

  path = '/managementAgents/actions/setAutoUpgradableConfig'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(set_auto_upgradable_config_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#set_auto_upgradable_config') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::ManagementAgent::Models::AutoUpgradableConfig'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_management_agent_counts(compartment_id, group_by, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use summarize_management_agent_counts API.

Gets count of the inventory of agents for a given compartment id, group by, and isPluginDeployed parameters. Supported groupBy parameters: availabilityStatus, platformType, version

Parameters:

  • compartment_id (String) —

    The OCID of the compartment to which a request will be scoped.

  • group_by (Array<String>) —

    The field by which to group Management Agents. Currently, only one groupBy dimension is supported at a time. Allowed values are: availabilityStatus, platformType, version

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :has_plugins (BOOLEAN) —

    When set to true then agents that have at least one plugin deployed will be returned. When set to false only agents that have no plugins deployed will be returned.

  • :install_type (String) —

    A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned.

  • :compartment_id_in_subtree (BOOLEAN) —

    if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified. (default to false)

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 2156

def summarize_management_agent_counts(compartment_id, group_by, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#summarize_management_agent_counts.' if logger

  raise "Missing the required parameter 'compartment_id' when calling summarize_management_agent_counts." if compartment_id.nil?
  raise "Missing the required parameter 'group_by' when calling summarize_management_agent_counts." if group_by.nil?

  group_by_allowable_values = %w[availabilityStatus platformType version]
  group_by.each do |val_to_check|
    unless group_by_allowable_values.include?(val_to_check)
      raise "Invalid value for 'group_by', must be one of availabilityStatus, platformType, version."
    end
  end

  if opts[:install_type] && !OCI::ManagementAgent::Models::INSTALL_TYPES_ENUM.include?(opts[:install_type])
    raise 'Invalid value for "install_type", must be one of the values in OCI::ManagementAgent::Models::INSTALL_TYPES_ENUM.'
  end

  path = '/managementAgentCounts'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:groupBy] = OCI::ApiClient.build_collection_params(group_by, :multi)
  query_params[:hasPlugins] = opts[:has_plugins] if !opts[:has_plugins].nil?
  query_params[:installType] = opts[:install_type] if opts[:install_type]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#summarize_management_agent_counts') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::ManagementAgent::Models::ManagementAgentAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_management_agent_plugin_counts(compartment_id, group_by, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use summarize_management_agent_plugin_counts API.

Gets count of the inventory of management agent plugins for a given compartment id and group by parameter. Supported groupBy parameter: pluginName

Parameters:

  • compartment_id (String) —

    The OCID of the compartment to which a request will be scoped.

  • group_by (String) —

    The field by which to group Management Agent Plugins

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified. (default to false)

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 2232

def summarize_management_agent_plugin_counts(compartment_id, group_by, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#summarize_management_agent_plugin_counts.' if logger

  raise "Missing the required parameter 'compartment_id' when calling summarize_management_agent_plugin_counts." if compartment_id.nil?
  raise "Missing the required parameter 'group_by' when calling summarize_management_agent_plugin_counts." if group_by.nil?
  unless OCI::ManagementAgent::Models::MANAGEMENT_AGENT_PLUGIN_GROUP_BY_ENUM.include?(group_by)
    raise 'Invalid value for "group_by", must be one of the values in OCI::ManagementAgent::Models::MANAGEMENT_AGENT_PLUGIN_GROUP_BY_ENUM.'
  end


  path = '/managementAgentPluginCounts'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:groupBy] = group_by
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#summarize_management_agent_plugin_counts') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::ManagementAgent::Models::ManagementAgentPluginAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_data_source(management_agent_id, data_source_key, update_data_source_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_data_source API.

Datasource update request to given Management Agent.

Parameters:

  • management_agent_id (String) —

    Unique Management Agent identifier

  • data_source_key (String) —

    Data source type and name identifier.

  • update_data_source_details (OCI::ManagementAgent::Models::UpdateDataSourceDetails) —

    Details of DataSource to be update for the given Management Agent.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 2309

def update_data_source(management_agent_id, data_source_key, update_data_source_details, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#update_data_source.' if logger

  raise "Missing the required parameter 'management_agent_id' when calling update_data_source." if management_agent_id.nil?
  raise "Missing the required parameter 'data_source_key' when calling update_data_source." if data_source_key.nil?
  raise "Missing the required parameter 'update_data_source_details' when calling update_data_source." if update_data_source_details.nil?
  raise "Parameter value for 'management_agent_id' must not be blank" if OCI::Internal::Util.blank_string?(management_agent_id)
  raise "Parameter value for 'data_source_key' must not be blank" if OCI::Internal::Util.blank_string?(data_source_key)

  path = '/managementAgents/{managementAgentId}/dataSources/{dataSourceKey}'.sub('{managementAgentId}', management_agent_id.to_s).sub('{dataSourceKey}', data_source_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(update_data_source_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#update_data_source') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_management_agent(management_agent_id, update_management_agent_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_management_agent API.

API to update the console managed properties of the Management Agent.

Parameters:

  • management_agent_id (String) —

    Unique Management Agent identifier

  • update_management_agent_details (OCI::ManagementAgent::Models::UpdateManagementAgentDetails) —

    Details required for changing the console managed properties of the Management Agent.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 2382

def update_management_agent(management_agent_id, update_management_agent_details, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#update_management_agent.' if logger

  raise "Missing the required parameter 'management_agent_id' when calling update_management_agent." if management_agent_id.nil?
  raise "Missing the required parameter 'update_management_agent_details' when calling update_management_agent." if update_management_agent_details.nil?
  raise "Parameter value for 'management_agent_id' must not be blank" if OCI::Internal::Util.blank_string?(management_agent_id)

  path = '/managementAgents/{managementAgentId}'.sub('{managementAgentId}', management_agent_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(update_management_agent_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#update_management_agent') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::ManagementAgent::Models::ManagementAgent'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_management_agent_install_key(management_agent_install_key_id, update_management_agent_install_key_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_management_agent_install_key API.

API to update the modifiable properties of the Management Agent install key.

Parameters:

  • management_agent_install_key_id (String) —

    Unique Management Agent Install Key identifier

  • update_management_agent_install_key_details (OCI::ManagementAgent::Models::UpdateManagementAgentInstallKeyDetails) —

    Details required for changing the modifiable properties of the Management Agent install key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 2454

def update_management_agent_install_key(management_agent_install_key_id, update_management_agent_install_key_details, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#update_management_agent_install_key.' if logger

  raise "Missing the required parameter 'management_agent_install_key_id' when calling update_management_agent_install_key." if management_agent_install_key_id.nil?
  raise "Missing the required parameter 'update_management_agent_install_key_details' when calling update_management_agent_install_key." if update_management_agent_install_key_details.nil?
  raise "Parameter value for 'management_agent_install_key_id' must not be blank" if OCI::Internal::Util.blank_string?(management_agent_install_key_id)

  path = '/managementAgentInstallKeys/{managementAgentInstallKeyId}'.sub('{managementAgentInstallKeyId}', management_agent_install_key_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(update_management_agent_install_key_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#update_management_agent_install_key') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::ManagementAgent::Models::ManagementAgentInstallKey'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_named_credential(named_credential_id, update_named_credential_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_named_credential API.

Named credential update request to given Management Agent.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
 
# File 'lib/oci/management_agent/management_agent_client.rb', line 2526

def update_named_credential(named_credential_id, update_named_credential_details, opts = {})
  logger.debug 'Calling operation ManagementAgentClient#update_named_credential.' if logger

  raise "Missing the required parameter 'named_credential_id' when calling update_named_credential." if named_credential_id.nil?
  raise "Missing the required parameter 'update_named_credential_details' when calling update_named_credential." if update_named_credential_details.nil?
  raise "Parameter value for 'named_credential_id' must not be blank" if OCI::Internal::Util.blank_string?(named_credential_id)

  path = '/namedCredentials/{namedCredentialId}'.sub('{namedCredentialId}', named_credential_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(update_named_credential_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementAgentClient#update_named_credential') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::ManagementAgent::Models::NamedCredential'
    )
  end
  # rubocop:enable Metrics/BlockLength
end