Class: OCI::OsManagementHub::ReportingManagedInstanceClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/os_management_hub/reporting_managed_instance_client.rb

Overview

Use the OS Management Hub API to manage and monitor updates and patches for instances in OCI, your private data center, or 3rd-party clouds. For more information, see Overview of OS Management Hub.

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) ⇒ ReportingManagedInstanceClient

Creates a new ReportingManagedInstanceClient. 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/os_management_hub/reporting_managed_instance_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 + '/20220901'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "ReportingManagedInstanceClient 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/os_management_hub/reporting_managed_instance_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/os_management_hub/reporting_managed_instance_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/os_management_hub/reporting_managed_instance_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/os_management_hub/reporting_managed_instance_client.rb', line 26

def retry_config
  @retry_config
end

Instance Method Details

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

Note:

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

Returns a report of managed instances matching the given filters. You can select CSV, XML, or JSON format.

Parameters:

  • 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

  • :compartment_id (String) —

    The OCID of the compartment. This filter returns only resources contained within the specified compartment.

  • :managed_instance_group_id (String) —

    The OCID of the managed instance group. This filter returns resources associated with this group.

  • :lifecycle_environment_id (String) —

    The OCID of the lifecycle environment. This filter returns only resource contained with the specified lifecycle environment.

  • :lifecycle_stage_id (String) —

    The OCID of the lifecycle stage. This resource returns resources associated with this lifecycle stage.

  • :status (Array<String>) —

    A filter to return only managed instances whose status matches the status provided. Allowed values are: NORMAL, UNREACHABLE, ERROR, WARNING, REGISTRATION_ERROR, DELETING, ONBOARDING

  • :display_name (Array<String>) —

    A filter to return resources that match the given display names.

  • :display_name_contains (String) —

    A filter to return resources that may partially match the given display name.

  • :security_updates_available_equals_to (Integer) —

    A filter to return instances that have the specified number of available security updates.

  • :bug_updates_available_equals_to (Integer) —

    A filter to return instances that have the specified number of available bug updates.

  • :security_updates_available_greater_than (Integer) —

    A filter to return instances that have more available security updates than the number specified.

  • :bug_updates_available_greater_than (Integer) —

    A filter to return instances that have more available bug updates than the number specified.

  • :location (Array<String>) —

    A filter to return only resources whose location matches the given value. Allowed values are: ON_PREMISE, OCI_COMPUTE, AZURE, EC2, GCP

  • :location_not_equal_to (Array<String>) —

    A filter to return only resources whose location does not match the given value. Allowed values are: ON_PREMISE, OCI_COMPUTE, AZURE, EC2, GCP

  • :os_family (Array<String>) —

    A filter to return only resources that match the given operating system family. Allowed values are: ORACLE_LINUX_9, ORACLE_LINUX_8, ORACLE_LINUX_7, ORACLE_LINUX_6, WINDOWS_SERVER_2016, WINDOWS_SERVER_2019, WINDOWS_SERVER_2022, ALL

  • :is_managed_by_autonomous_linux (BOOLEAN) —

    Indicates whether to list only resources managed by the Autonomous Linux service.

  • :report_format (String) —

    The format of the report to download. Default is CSV. (default to csv) Allowed values are: csv, json, xml

  • :report_type (String) —

    The type of the report the user wants to download. Default is ALL. (default to ALL) Allowed values are: SECURITY, BUGFIX, ACTIVITY, ALL

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :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



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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
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
 
# File 'lib/oci/os_management_hub/reporting_managed_instance_client.rb', line 140

def get_managed_instance_analytic_content(opts = {}, &block)
  logger.debug 'Calling operation ReportingManagedInstanceClient#get_managed_instance_analytic_content.' if logger



  status_allowable_values = %w[NORMAL UNREACHABLE ERROR WARNING REGISTRATION_ERROR DELETING ONBOARDING]
  if opts[:status] && !opts[:status].empty?
    opts[:status].each do |val_to_check|
      unless status_allowable_values.include?(val_to_check)
        raise 'Invalid value for "status", must be one of NORMAL, UNREACHABLE, ERROR, WARNING, REGISTRATION_ERROR, DELETING, ONBOARDING.'
      end
    end
  end


  location_allowable_values = %w[ON_PREMISE OCI_COMPUTE AZURE EC2 GCP]
  if opts[:location] && !opts[:location].empty?
    opts[:location].each do |val_to_check|
      unless location_allowable_values.include?(val_to_check)
        raise 'Invalid value for "location", must be one of ON_PREMISE, OCI_COMPUTE, AZURE, EC2, GCP.'
      end
    end
  end


  location_not_equal_to_allowable_values = %w[ON_PREMISE OCI_COMPUTE AZURE EC2 GCP]
  if opts[:location_not_equal_to] && !opts[:location_not_equal_to].empty?
    opts[:location_not_equal_to].each do |val_to_check|
      unless location_not_equal_to_allowable_values.include?(val_to_check)
        raise 'Invalid value for "location_not_equal_to", must be one of ON_PREMISE, OCI_COMPUTE, AZURE, EC2, GCP.'
      end
    end
  end


  os_family_allowable_values = %w[ORACLE_LINUX_9 ORACLE_LINUX_8 ORACLE_LINUX_7 ORACLE_LINUX_6 WINDOWS_SERVER_2016 WINDOWS_SERVER_2019 WINDOWS_SERVER_2022 ALL]
  if opts[:os_family] && !opts[:os_family].empty?
    opts[:os_family].each do |val_to_check|
      unless os_family_allowable_values.include?(val_to_check)
        raise 'Invalid value for "os_family", must be one of ORACLE_LINUX_9, ORACLE_LINUX_8, ORACLE_LINUX_7, ORACLE_LINUX_6, WINDOWS_SERVER_2016, WINDOWS_SERVER_2019, WINDOWS_SERVER_2022, ALL.'
      end
    end
  end

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

  if opts[:report_type] && !%w[SECURITY BUGFIX ACTIVITY ALL].include?(opts[:report_type])
    raise 'Invalid value for "report_type", must be one of SECURITY, BUGFIX, ACTIVITY, ALL.'
  end

  path = '/managedInstanceAnalytics/content'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:managedInstanceGroupId] = opts[:managed_instance_group_id] if opts[:managed_instance_group_id]
  query_params[:lifecycleEnvironmentId] = opts[:lifecycle_environment_id] if opts[:lifecycle_environment_id]
  query_params[:lifecycleStageId] = opts[:lifecycle_stage_id] if opts[:lifecycle_stage_id]
  query_params[:status] = OCI::ApiClient.build_collection_params(opts[:status], :multi) if opts[:status] && !opts[:status].empty?
  query_params[:displayName] = OCI::ApiClient.build_collection_params(opts[:display_name], :multi) if opts[:display_name] && !opts[:display_name].empty?
  query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains]
  query_params[:securityUpdatesAvailableEqualsTo] = opts[:security_updates_available_equals_to] if opts[:security_updates_available_equals_to]
  query_params[:bugUpdatesAvailableEqualsTo] = opts[:bug_updates_available_equals_to] if opts[:bug_updates_available_equals_to]
  query_params[:securityUpdatesAvailableGreaterThan] = opts[:security_updates_available_greater_than] if opts[:security_updates_available_greater_than]
  query_params[:bugUpdatesAvailableGreaterThan] = opts[:bug_updates_available_greater_than] if opts[:bug_updates_available_greater_than]
  query_params[:location] = OCI::ApiClient.build_collection_params(opts[:location], :multi) if opts[:location] && !opts[:location].empty?
  query_params[:locationNotEqualTo] = OCI::ApiClient.build_collection_params(opts[:location_not_equal_to], :multi) if opts[:location_not_equal_to] && !opts[:location_not_equal_to].empty?
  query_params[:osFamily] = OCI::ApiClient.build_collection_params(opts[:os_family], :multi) if opts[:os_family] && !opts[:os_family].empty?
  query_params[:isManagedByAutonomousLinux] = opts[:is_managed_by_autonomous_linux] if !opts[:is_managed_by_autonomous_linux].nil?
  query_params[:reportFormat] = opts[:report_format] if opts[:report_format]
  query_params[:reportType] = opts[:report_type] if opts[:report_type]

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/x-yaml'
  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: 'ReportingManagedInstanceClient#get_managed_instance_analytic_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_managed_instance_content(managed_instance_id, vulnerability_type, opts = {}, &block) ⇒ Response

Note:

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

Returns a report for a single managed instance whose associated erratas match the given filters. You can select CSV, XML, or JSON format.

Parameters:

  • managed_instance_id (String) —

    The OCID of the managed instance.

  • vulnerability_type (Array<String>) —

    A filter to return only vulnerabilities matching the given types. Allowed values are: SECURITY, BUGFIX, ENHANCEMENT, OTHER, ALL

  • 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

  • :advisory_name (Array<String>) —

    The assigned erratum name. It's unique and not changeable.

    Example: ELSA-2020-5804

  • :advisory_name_contains (String) —

    A filter to return resources that may partially match the erratum advisory name given.

  • :advisory_type (Array<String>) —

    A filter to return only errata that match the given advisory types. Allowed values are: SECURITY, BUGFIX, ENHANCEMENT

  • :vulnerability_name (Array<String>) —

    A filter to return vulnerabilities that match the given name. For Linux instances, this refers to the advisory name. For Windows instances, this refers to the Windows update display name.

  • :vulnerability_name_contains (String) —

    A filter to return vulnerabilities that partially match the given name. For Linux instances, this refers to the advisory name. For Windows instances, this refers to the Windows update display name.

  • :report_format (String) —

    The format of the report to download. Default is CSV. (default to csv) Allowed values are: csv, json, xml

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :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



317
318
319
320
321
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
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
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
421
422
423
424
425
426
 
# File 'lib/oci/os_management_hub/reporting_managed_instance_client.rb', line 317

def get_managed_instance_content(managed_instance_id, vulnerability_type, opts = {}, &block)
  logger.debug 'Calling operation ReportingManagedInstanceClient#get_managed_instance_content.' if logger

  raise "Missing the required parameter 'managed_instance_id' when calling get_managed_instance_content." if managed_instance_id.nil?
  raise "Missing the required parameter 'vulnerability_type' when calling get_managed_instance_content." if vulnerability_type.nil?

  vulnerability_type_allowable_values = %w[SECURITY BUGFIX ENHANCEMENT OTHER ALL]
  vulnerability_type.each do |val_to_check|
    unless vulnerability_type_allowable_values.include?(val_to_check)
      raise "Invalid value for 'vulnerability_type', must be one of SECURITY, BUGFIX, ENHANCEMENT, OTHER, ALL."
    end
  end


  advisory_type_allowable_values = %w[SECURITY BUGFIX ENHANCEMENT]
  if opts[:advisory_type] && !opts[:advisory_type].empty?
    opts[:advisory_type].each do |val_to_check|
      unless advisory_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "advisory_type", must be one of SECURITY, BUGFIX, ENHANCEMENT.'
      end
    end
  end

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

  path = '/managedInstances/{managedInstanceId}/content'.sub('{managedInstanceId}', managed_instance_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:vulnerabilityType] = OCI::ApiClient.build_collection_params(vulnerability_type, :multi)
  query_params[:advisoryName] = OCI::ApiClient.build_collection_params(opts[:advisory_name], :multi) if opts[:advisory_name] && !opts[:advisory_name].empty?
  query_params[:advisoryNameContains] = opts[:advisory_name_contains] if opts[:advisory_name_contains]
  query_params[:advisoryType] = OCI::ApiClient.build_collection_params(opts[:advisory_type], :multi) if opts[:advisory_type] && !opts[:advisory_type].empty?
  query_params[:vulnerabilityName] = OCI::ApiClient.build_collection_params(opts[:vulnerability_name], :multi) if opts[:vulnerability_name] && !opts[:vulnerability_name].empty?
  query_params[:vulnerabilityNameContains] = opts[:vulnerability_name_contains] if opts[:vulnerability_name_contains]
  query_params[:reportFormat] = opts[:report_format] if opts[:report_format]

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/x-yaml'
  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: 'ReportingManagedInstanceClient#get_managed_instance_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

#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/os_management_hub/reporting_managed_instance_client.rb', line 95

def logger
  @api_client.config.logger
end

#summarize_managed_instance_analytics(metric_names, opts = {}) ⇒ Response

Note:

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

Returns a list of user specified metrics for a collection of managed instances.

Parameters:

  • metric_names (Array<String>) —

    A filter to return only metrics whose name matches the given metric names. Allowed values are: TOTAL_INSTANCE_COUNT, INSTANCE_WITH_AVAILABLE_SECURITY_UPDATES_COUNT, INSTANCE_WITH_AVAILABLE_BUGFIX_UPDATES_COUNT, NORMAL_INSTANCE_COUNT, ERROR_INSTANCE_COUNT, WARNING_INSTANCE_COUNT, UNREACHABLE_INSTANCE_COUNT, REGISTRATION_FAILED_INSTANCE_COUNT, DELETING_INSTANCE_COUNT, ONBOARDING_INSTANCE_COUNT, INSTANCE_SECURITY_UPDATES_COUNT, INSTANCE_BUGFIX_UPDATES_COUNT, INSTANCE_SECURITY_ADVISORY_COUNT, INSTANCE_BUGFIX_ADVISORY_COUNT

  • 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 (String) —

    The OCID of the compartment. This filter returns only resources contained within the specified compartment.

  • :managed_instance_group_id (String) —

    The OCID of the managed instance group. This filter returns resources associated with this group.

  • :lifecycle_environment_id (String) —

    The OCID of the lifecycle environment. This filter returns only resource contained with the specified lifecycle environment.

  • :lifecycle_stage_id (String) —

    The OCID of the lifecycle stage. This resource returns resources associated with this lifecycle stage.

  • :status (Array<String>) —

    A filter to return only managed instances whose status matches the status provided. Allowed values are: NORMAL, UNREACHABLE, ERROR, WARNING, REGISTRATION_ERROR, DELETING, ONBOARDING

  • :location (Array<String>) —

    A filter to return only resources whose location matches the given value. Allowed values are: ON_PREMISE, OCI_COMPUTE, AZURE, EC2, GCP

  • :location_not_equal_to (Array<String>) —

    A filter to return only resources whose location does not match the given value. Allowed values are: ON_PREMISE, OCI_COMPUTE, AZURE, EC2, GCP

  • :os_family (Array<String>) —

    A filter to return only resources that match the given operating system family. Allowed values are: ORACLE_LINUX_9, ORACLE_LINUX_8, ORACLE_LINUX_7, ORACLE_LINUX_6, WINDOWS_SERVER_2016, WINDOWS_SERVER_2019, WINDOWS_SERVER_2022, ALL

  • :is_managed_by_autonomous_linux (BOOLEAN) —

    Indicates whether to list only resources managed by the Autonomous Linux service.

  • :display_name (Array<String>) —

    A filter to return resources that match the given display names.

  • :display_name_contains (String) —

    A filter to return resources that may partially match the given display name.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50 (default to 10)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

    Example: 3

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. The default is to sort in ascending order by metricName (previously name, which is now depricated). You can also sort by displayName (default is ascending order). (default to name) Allowed values are: name, metricName, displayName

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
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
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
 
# File 'lib/oci/os_management_hub/reporting_managed_instance_client.rb', line 479

def summarize_managed_instance_analytics(metric_names, opts = {})
  logger.debug 'Calling operation ReportingManagedInstanceClient#summarize_managed_instance_analytics.' if logger

  raise "Missing the required parameter 'metric_names' when calling summarize_managed_instance_analytics." if metric_names.nil?

  metric_names_allowable_values = %w[TOTAL_INSTANCE_COUNT INSTANCE_WITH_AVAILABLE_SECURITY_UPDATES_COUNT INSTANCE_WITH_AVAILABLE_BUGFIX_UPDATES_COUNT NORMAL_INSTANCE_COUNT ERROR_INSTANCE_COUNT WARNING_INSTANCE_COUNT UNREACHABLE_INSTANCE_COUNT REGISTRATION_FAILED_INSTANCE_COUNT DELETING_INSTANCE_COUNT ONBOARDING_INSTANCE_COUNT INSTANCE_SECURITY_UPDATES_COUNT INSTANCE_BUGFIX_UPDATES_COUNT INSTANCE_SECURITY_ADVISORY_COUNT INSTANCE_BUGFIX_ADVISORY_COUNT]
  metric_names.each do |val_to_check|
    unless metric_names_allowable_values.include?(val_to_check)
      raise "Invalid value for 'metric_names', must be one of TOTAL_INSTANCE_COUNT, INSTANCE_WITH_AVAILABLE_SECURITY_UPDATES_COUNT, INSTANCE_WITH_AVAILABLE_BUGFIX_UPDATES_COUNT, NORMAL_INSTANCE_COUNT, ERROR_INSTANCE_COUNT, WARNING_INSTANCE_COUNT, UNREACHABLE_INSTANCE_COUNT, REGISTRATION_FAILED_INSTANCE_COUNT, DELETING_INSTANCE_COUNT, ONBOARDING_INSTANCE_COUNT, INSTANCE_SECURITY_UPDATES_COUNT, INSTANCE_BUGFIX_UPDATES_COUNT, INSTANCE_SECURITY_ADVISORY_COUNT, INSTANCE_BUGFIX_ADVISORY_COUNT."
    end
  end


  status_allowable_values = %w[NORMAL UNREACHABLE ERROR WARNING REGISTRATION_ERROR DELETING ONBOARDING]
  if opts[:status] && !opts[:status].empty?
    opts[:status].each do |val_to_check|
      unless status_allowable_values.include?(val_to_check)
        raise 'Invalid value for "status", must be one of NORMAL, UNREACHABLE, ERROR, WARNING, REGISTRATION_ERROR, DELETING, ONBOARDING.'
      end
    end
  end


  location_allowable_values = %w[ON_PREMISE OCI_COMPUTE AZURE EC2 GCP]
  if opts[:location] && !opts[:location].empty?
    opts[:location].each do |val_to_check|
      unless location_allowable_values.include?(val_to_check)
        raise 'Invalid value for "location", must be one of ON_PREMISE, OCI_COMPUTE, AZURE, EC2, GCP.'
      end
    end
  end


  location_not_equal_to_allowable_values = %w[ON_PREMISE OCI_COMPUTE AZURE EC2 GCP]
  if opts[:location_not_equal_to] && !opts[:location_not_equal_to].empty?
    opts[:location_not_equal_to].each do |val_to_check|
      unless location_not_equal_to_allowable_values.include?(val_to_check)
        raise 'Invalid value for "location_not_equal_to", must be one of ON_PREMISE, OCI_COMPUTE, AZURE, EC2, GCP.'
      end
    end
  end


  os_family_allowable_values = %w[ORACLE_LINUX_9 ORACLE_LINUX_8 ORACLE_LINUX_7 ORACLE_LINUX_6 WINDOWS_SERVER_2016 WINDOWS_SERVER_2019 WINDOWS_SERVER_2022 ALL]
  if opts[:os_family] && !opts[:os_family].empty?
    opts[:os_family].each do |val_to_check|
      unless os_family_allowable_values.include?(val_to_check)
        raise 'Invalid value for "os_family", must be one of ORACLE_LINUX_9, ORACLE_LINUX_8, ORACLE_LINUX_7, ORACLE_LINUX_6, WINDOWS_SERVER_2016, WINDOWS_SERVER_2019, WINDOWS_SERVER_2022, ALL.'
      end
    end
  end

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

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

  path = '/managedInstanceAnalytics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:metricNames] = OCI::ApiClient.build_collection_params(metric_names, :multi)
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:managedInstanceGroupId] = opts[:managed_instance_group_id] if opts[:managed_instance_group_id]
  query_params[:lifecycleEnvironmentId] = opts[:lifecycle_environment_id] if opts[:lifecycle_environment_id]
  query_params[:lifecycleStageId] = opts[:lifecycle_stage_id] if opts[:lifecycle_stage_id]
  query_params[:status] = OCI::ApiClient.build_collection_params(opts[:status], :multi) if opts[:status] && !opts[:status].empty?
  query_params[:location] = OCI::ApiClient.build_collection_params(opts[:location], :multi) if opts[:location] && !opts[:location].empty?
  query_params[:locationNotEqualTo] = OCI::ApiClient.build_collection_params(opts[:location_not_equal_to], :multi) if opts[:location_not_equal_to] && !opts[:location_not_equal_to].empty?
  query_params[:osFamily] = OCI::ApiClient.build_collection_params(opts[:os_family], :multi) if opts[:os_family] && !opts[:os_family].empty?
  query_params[:isManagedByAutonomousLinux] = opts[:is_managed_by_autonomous_linux] if !opts[:is_managed_by_autonomous_linux].nil?
  query_params[:displayName] = OCI::ApiClient.build_collection_params(opts[:display_name], :multi) if opts[:display_name] && !opts[:display_name].empty?
  query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # 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: 'ReportingManagedInstanceClient#summarize_managed_instance_analytics') 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::OsManagementHub::Models::ManagedInstanceAnalyticCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end