Class: OCI::OsManagementHub::ManagedInstanceClient
- Inherits:
-
Object
- Object
- OCI::OsManagementHub::ManagedInstanceClient
- Defined in:
- lib/oci/os_management_hub/managed_instance_client.rb
Overview
Use the OS Management Hub API to manage and monitor updates and patches for the operating system environments in your private data centers through a single management console. For more information, see Overview of OS Management Hub.
Instance Attribute Summary collapse
-
#api_client ⇒ OCI::ApiClient
readonly
Client used to make HTTP requests.
-
#endpoint ⇒ String
readonly
Fully qualified endpoint URL.
-
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
-
#retry_config ⇒ OCI::Retry::RetryConfig
readonly
The default retry configuration to apply to all operations in this service client.
Instance Method Summary collapse
-
#attach_software_sources_to_managed_instance(managed_instance_id, attach_software_sources_to_managed_instance_details, opts = {}) ⇒ Response
Adds software sources to a managed instance.
-
#detach_software_sources_from_managed_instance(managed_instance_id, detach_software_sources_from_managed_instance_details, opts = {}) ⇒ Response
Removes software sources from a managed instance.
-
#disable_module_stream_on_managed_instance(managed_instance_id, disable_module_stream_on_managed_instance_details, opts = {}) ⇒ Response
Disables a module stream on a managed instance.
-
#enable_module_stream_on_managed_instance(managed_instance_id, enable_module_stream_on_managed_instance_details, opts = {}) ⇒ Response
Enables a module stream on a managed instance.
-
#get_managed_instance(managed_instance_id, opts = {}) ⇒ Response
Gets information about the specified managed instance.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ManagedInstanceClient
constructor
Creates a new ManagedInstanceClient.
-
#install_module_stream_profile_on_managed_instance(managed_instance_id, install_module_stream_profile_on_managed_instance_details, opts = {}) ⇒ Response
Installs a profile for an module stream.
-
#install_packages_on_managed_instance(managed_instance_id, install_packages_on_managed_instance_details, opts = {}) ⇒ Response
Installs packages on a managed instance.
-
#list_managed_instance_available_packages(managed_instance_id, opts = {}) ⇒ Response
Returns a list of available packages for a managed instance.
-
#list_managed_instance_available_software_sources(managed_instance_id, opts = {}) ⇒ Response
Returns a list of available software sources for a managed instance.
-
#list_managed_instance_errata(managed_instance_id, opts = {}) ⇒ Response
Returns a list of applicable errata on the managed instance.
-
#list_managed_instance_installed_packages(managed_instance_id, opts = {}) ⇒ Response
Lists the packages that are installed on the managed instance.
-
#list_managed_instance_modules(managed_instance_id, opts = {}) ⇒ Response
Retrieve a list of modules, along with streams of the modules, from a managed instance.
-
#list_managed_instance_updatable_packages(managed_instance_id, opts = {}) ⇒ Response
Returns a list of updatable packages for a managed instance.
-
#list_managed_instances(opts = {}) ⇒ Response
Lists managed instances that match the specified compartment or managed instance OCID.
-
#logger ⇒ Logger
The logger for this client.
-
#manage_module_streams_on_managed_instance(managed_instance_id, manage_module_streams_on_managed_instance_details, opts = {}) ⇒ Response
Perform an operation involving modules, streams, and profiles on a managed instance.
-
#refresh_software_on_managed_instance(managed_instance_id, opts = {}) ⇒ Response
Refresh all installed and updatable software information on a managed instance.
-
#remove_module_stream_profile_from_managed_instance(managed_instance_id, remove_module_stream_profile_from_managed_instance_details, opts = {}) ⇒ Response
Removes a profile for a module stream that is installed on a managed instance.
-
#remove_packages_from_managed_instance(managed_instance_id, remove_packages_from_managed_instance_details, opts = {}) ⇒ Response
Removes an installed package from a managed instance.
-
#switch_module_stream_on_managed_instance(managed_instance_id, switch_module_stream_on_managed_instance_details, opts = {}) ⇒ Response
Enables a new stream for a module that already has a stream enabled.
-
#update_all_packages_on_managed_instances_in_compartment(update_all_packages_on_managed_instances_in_compartment_details, opts = {}) ⇒ Response
Install all of the available package updates for all of the managed instances in a compartment.
-
#update_managed_instance(managed_instance_id, update_managed_instance_details, opts = {}) ⇒ Response
Updates the managed instance.
-
#update_packages_on_managed_instance(managed_instance_id, update_packages_on_managed_instance_details, opts = {}) ⇒ Response
Updates a package on a managed instance.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ManagedInstanceClient
Creates a new ManagedInstanceClient. 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.
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/oci/os_management_hub/managed_instance_client.rb', line 55 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 "ManagedInstanceClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
15 16 17 |
# File 'lib/oci/os_management_hub/managed_instance_client.rb', line 15 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
19 20 21 |
# File 'lib/oci/os_management_hub/managed_instance_client.rb', line 19 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
29 30 31 |
# File 'lib/oci/os_management_hub/managed_instance_client.rb', line 29 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
25 26 27 |
# File 'lib/oci/os_management_hub/managed_instance_client.rb', line 25 def retry_config @retry_config end |
Instance Method Details
#attach_software_sources_to_managed_instance(managed_instance_id, attach_software_sources_to_managed_instance_details, opts = {}) ⇒ Response
Click here to see an example of how to use attach_software_sources_to_managed_instance API.
Adds software sources to a managed instance. After the software source has been added, then packages from that software source can be installed on the managed instance.
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/os_management_hub/managed_instance_client.rb', line 126 def attach_software_sources_to_managed_instance(managed_instance_id, attach_software_sources_to_managed_instance_details, opts = {}) logger.debug 'Calling operation ManagedInstanceClient#attach_software_sources_to_managed_instance.' if logger raise "Missing the required parameter 'managed_instance_id' when calling attach_software_sources_to_managed_instance." if managed_instance_id.nil? raise "Missing the required parameter 'attach_software_sources_to_managed_instance_details' when calling attach_software_sources_to_managed_instance." if attach_software_sources_to_managed_instance_details.nil? raise "Parameter value for 'managed_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_instance_id) path = '/managedInstances/{managedInstanceId}/actions/attachSoftwareSources'.sub('{managedInstanceId}', managed_instance_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] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(attach_software_sources_to_managed_instance_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagedInstanceClient#attach_software_sources_to_managed_instance') 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 |
#detach_software_sources_from_managed_instance(managed_instance_id, detach_software_sources_from_managed_instance_details, opts = {}) ⇒ Response
Click here to see an example of how to use detach_software_sources_from_managed_instance API.
Removes software sources from a managed instance. Packages will no longer be able to be installed from these software sources.
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 |
# File 'lib/oci/os_management_hub/managed_instance_client.rb', line 198 def detach_software_sources_from_managed_instance(managed_instance_id, detach_software_sources_from_managed_instance_details, opts = {}) logger.debug 'Calling operation ManagedInstanceClient#detach_software_sources_from_managed_instance.' if logger raise "Missing the required parameter 'managed_instance_id' when calling detach_software_sources_from_managed_instance." if managed_instance_id.nil? raise "Missing the required parameter 'detach_software_sources_from_managed_instance_details' when calling detach_software_sources_from_managed_instance." if detach_software_sources_from_managed_instance_details.nil? raise "Parameter value for 'managed_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_instance_id) path = '/managedInstances/{managedInstanceId}/actions/detachSoftwareSources'.sub('{managedInstanceId}', managed_instance_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] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(detach_software_sources_from_managed_instance_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagedInstanceClient#detach_software_sources_from_managed_instance') 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 |
#disable_module_stream_on_managed_instance(managed_instance_id, disable_module_stream_on_managed_instance_details, opts = {}) ⇒ Response
Click here to see an example of how to use disable_module_stream_on_managed_instance API.
Disables a module stream on a managed instance. After the stream is disabled, it is no longer possible to install the profiles that are contained by the stream. All installed profiles must be removed prior to disabling a module stream.
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 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 |
# File 'lib/oci/os_management_hub/managed_instance_client.rb', line 272 def disable_module_stream_on_managed_instance(managed_instance_id, disable_module_stream_on_managed_instance_details, opts = {}) logger.debug 'Calling operation ManagedInstanceClient#disable_module_stream_on_managed_instance.' if logger raise "Missing the required parameter 'managed_instance_id' when calling disable_module_stream_on_managed_instance." if managed_instance_id.nil? raise "Missing the required parameter 'disable_module_stream_on_managed_instance_details' when calling disable_module_stream_on_managed_instance." if disable_module_stream_on_managed_instance_details.nil? raise "Parameter value for 'managed_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_instance_id) path = '/managedInstances/{managedInstanceId}/actions/disableModuleStreams'.sub('{managedInstanceId}', managed_instance_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] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(disable_module_stream_on_managed_instance_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagedInstanceClient#disable_module_stream_on_managed_instance') 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 |
#enable_module_stream_on_managed_instance(managed_instance_id, enable_module_stream_on_managed_instance_details, opts = {}) ⇒ Response
Click here to see an example of how to use enable_module_stream_on_managed_instance API.
Enables a module stream on a managed instance. After the stream is enabled, it is possible to install the profiles that are contained by the stream. Enabling a stream that is already enabled will succeed. Attempting to enable a different stream for a module that already has a stream enabled results in an error.
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 |
# File 'lib/oci/os_management_hub/managed_instance_client.rb', line 347 def enable_module_stream_on_managed_instance(managed_instance_id, enable_module_stream_on_managed_instance_details, opts = {}) logger.debug 'Calling operation ManagedInstanceClient#enable_module_stream_on_managed_instance.' if logger raise "Missing the required parameter 'managed_instance_id' when calling enable_module_stream_on_managed_instance." if managed_instance_id.nil? raise "Missing the required parameter 'enable_module_stream_on_managed_instance_details' when calling enable_module_stream_on_managed_instance." if enable_module_stream_on_managed_instance_details.nil? raise "Parameter value for 'managed_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_instance_id) path = '/managedInstances/{managedInstanceId}/actions/enableModuleStreams'.sub('{managedInstanceId}', managed_instance_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] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(enable_module_stream_on_managed_instance_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagedInstanceClient#enable_module_stream_on_managed_instance') 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_managed_instance(managed_instance_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_managed_instance API.
Gets information about the specified managed instance.
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 |
# File 'lib/oci/os_management_hub/managed_instance_client.rb', line 404 def get_managed_instance(managed_instance_id, opts = {}) logger.debug 'Calling operation ManagedInstanceClient#get_managed_instance.' if logger raise "Missing the required parameter 'managed_instance_id' when calling get_managed_instance." if managed_instance_id.nil? raise "Parameter value for 'managed_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_instance_id) path = '/managedInstances/{managedInstanceId}'.sub('{managedInstanceId}', managed_instance_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.(applicable_retry_config(opts), call_name: 'ManagedInstanceClient#get_managed_instance') 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::ManagedInstance' ) end # rubocop:enable Metrics/BlockLength end |
#install_module_stream_profile_on_managed_instance(managed_instance_id, install_module_stream_profile_on_managed_instance_details, opts = {}) ⇒ Response
Click here to see an example of how to use install_module_stream_profile_on_managed_instance API.
Installs a profile for an module stream. The stream must be enabled before a profile can be installed. If a module stream defines multiple profiles, each one can be installed independently.
474 475 476 477 478 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 |
# File 'lib/oci/os_management_hub/managed_instance_client.rb', line 474 def install_module_stream_profile_on_managed_instance(managed_instance_id, install_module_stream_profile_on_managed_instance_details, opts = {}) logger.debug 'Calling operation ManagedInstanceClient#install_module_stream_profile_on_managed_instance.' if logger raise "Missing the required parameter 'managed_instance_id' when calling install_module_stream_profile_on_managed_instance." if managed_instance_id.nil? raise "Missing the required parameter 'install_module_stream_profile_on_managed_instance_details' when calling install_module_stream_profile_on_managed_instance." if install_module_stream_profile_on_managed_instance_details.nil? raise "Parameter value for 'managed_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_instance_id) path = '/managedInstances/{managedInstanceId}/actions/installStreamProfiles'.sub('{managedInstanceId}', managed_instance_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] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(install_module_stream_profile_on_managed_instance_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagedInstanceClient#install_module_stream_profile_on_managed_instance') 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 |
#install_packages_on_managed_instance(managed_instance_id, install_packages_on_managed_instance_details, opts = {}) ⇒ Response
Click here to see an example of how to use install_packages_on_managed_instance API.
Installs packages on a managed instance.
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 |
# File 'lib/oci/os_management_hub/managed_instance_client.rb', line 545 def install_packages_on_managed_instance(managed_instance_id, install_packages_on_managed_instance_details, opts = {}) logger.debug 'Calling operation ManagedInstanceClient#install_packages_on_managed_instance.' if logger raise "Missing the required parameter 'managed_instance_id' when calling install_packages_on_managed_instance." if managed_instance_id.nil? raise "Missing the required parameter 'install_packages_on_managed_instance_details' when calling install_packages_on_managed_instance." if install_packages_on_managed_instance_details.nil? raise "Parameter value for 'managed_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_instance_id) path = '/managedInstances/{managedInstanceId}/actions/installPackages'.sub('{managedInstanceId}', managed_instance_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] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(install_packages_on_managed_instance_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagedInstanceClient#install_packages_on_managed_instance') 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 |
#list_managed_instance_available_packages(managed_instance_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_managed_instance_available_packages API.
Returns a list of available packages for a managed instance.
Allowed values are: timeCreated, displayName
620 621 622 623 624 625 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 663 664 665 666 667 668 669 670 671 |
# File 'lib/oci/os_management_hub/managed_instance_client.rb', line 620 def list_managed_instance_available_packages(managed_instance_id, opts = {}) logger.debug 'Calling operation ManagedInstanceClient#list_managed_instance_available_packages.' if logger raise "Missing the required parameter 'managed_instance_id' when calling list_managed_instance_available_packages." if managed_instance_id.nil? 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 if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.' end raise "Parameter value for 'managed_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_instance_id) path = '/managedInstances/{managedInstanceId}/availablePackages'.sub('{managedInstanceId}', managed_instance_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} 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[:compartmentId] = opts[:compartment_id] if opts[: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] # 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.(applicable_retry_config(opts), call_name: 'ManagedInstanceClient#list_managed_instance_available_packages') 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::AvailablePackageCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_managed_instance_available_software_sources(managed_instance_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_managed_instance_available_software_sources API.
Returns a list of available software sources for a managed instance.
Allowed values are: timeCreated, displayName
707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 |
# File 'lib/oci/os_management_hub/managed_instance_client.rb', line 707 def list_managed_instance_available_software_sources(managed_instance_id, opts = {}) logger.debug 'Calling operation ManagedInstanceClient#list_managed_instance_available_software_sources.' if logger raise "Missing the required parameter 'managed_instance_id' when calling list_managed_instance_available_software_sources." if managed_instance_id.nil? 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 if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.' end raise "Parameter value for 'managed_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_instance_id) path = '/managedInstances/{managedInstanceId}/availableSoftwareSources'.sub('{managedInstanceId}', managed_instance_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} 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[:compartmentId] = opts[:compartment_id] if opts[: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] # 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.(applicable_retry_config(opts), call_name: 'ManagedInstanceClient#list_managed_instance_available_software_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: 'OCI::OsManagementHub::Models::AvailableSoftwareSourceCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_managed_instance_errata(managed_instance_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_managed_instance_errata API.
Returns a list of applicable errata on the managed instance.
Allowed values are: timeIssued, name
799 800 801 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 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 |
# File 'lib/oci/os_management_hub/managed_instance_client.rb', line 799 def list_managed_instance_errata(managed_instance_id, opts = {}) logger.debug 'Calling operation ManagedInstanceClient#list_managed_instance_errata.' if logger raise "Missing the required parameter 'managed_instance_id' when calling list_managed_instance_errata." if managed_instance_id.nil? 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[: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 if opts[:sort_by] && !%w[timeIssued name].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeIssued, name.' end raise "Parameter value for 'managed_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_instance_id) path = '/managedInstances/{managedInstanceId}/errata'.sub('{managedInstanceId}', managed_instance_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:advisoryType] = OCI::ApiClient.build_collection_params(opts[:advisory_type], :multi) if opts[:advisory_type] && !opts[:advisory_type].empty? query_params[:name] = OCI::ApiClient.build_collection_params(opts[:name], :multi) if opts[:name] && !opts[:name].empty? query_params[:nameContains] = opts[:name_contains] if opts[:name_contains] query_params[:compartmentId] = opts[:compartment_id] if opts[: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] # 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.(applicable_retry_config(opts), call_name: 'ManagedInstanceClient#list_managed_instance_errata') 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::ManagedInstanceErratumSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_managed_instance_installed_packages(managed_instance_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_managed_instance_installed_packages API.
Lists the packages that are installed on the managed instance.
Allowed values are: timeInstalled, timeCreated, displayName
905 906 907 908 909 910 911 912 913 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 |
# File 'lib/oci/os_management_hub/managed_instance_client.rb', line 905 def list_managed_instance_installed_packages(managed_instance_id, opts = {}) logger.debug 'Calling operation ManagedInstanceClient#list_managed_instance_installed_packages.' if logger raise "Missing the required parameter 'managed_instance_id' when calling list_managed_instance_installed_packages." if managed_instance_id.nil? 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 if opts[:sort_by] && !%w[timeInstalled timeCreated displayName].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeInstalled, timeCreated, displayName.' end raise "Parameter value for 'managed_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_instance_id) path = '/managedInstances/{managedInstanceId}/installedPackages'.sub('{managedInstanceId}', managed_instance_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} 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[:timeInstallDateStart] = opts[:time_install_date_start] if opts[:time_install_date_start] query_params[:timeInstallDateEnd] = opts[:time_install_date_end] if opts[:time_install_date_end] query_params[:compartmentId] = opts[:compartment_id] if opts[: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] # 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.(applicable_retry_config(opts), call_name: 'ManagedInstanceClient#list_managed_instance_installed_packages') 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::InstalledPackageCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_managed_instance_modules(managed_instance_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_managed_instance_modules API.
Retrieve a list of modules, along with streams of the modules, from a managed instance. Filters may be applied to select a subset of modules based on the filter criteria.
The 'name' attribute filters against the name of a module. It accepts strings of the format "<string>".
The 'nameContains' attribute filters against the name of a module based on partial match. It accepts strings of the format "<string>". If this attribute is defined, only matching modules are included in the result set. If it is not defined, the request is not subject to this filter.
Allowed values are: name
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 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 |
# File 'lib/oci/os_management_hub/managed_instance_client.rb', line 1006 def list_managed_instance_modules(managed_instance_id, opts = {}) logger.debug 'Calling operation ManagedInstanceClient#list_managed_instance_modules.' if logger raise "Missing the required parameter 'managed_instance_id' when calling list_managed_instance_modules." if managed_instance_id.nil? 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 if opts[:sort_by] && !%w[name].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of name.' end raise "Parameter value for 'managed_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_instance_id) path = '/managedInstances/{managedInstanceId}/modules'.sub('{managedInstanceId}', managed_instance_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id] query_params[:name] = opts[:name] if opts[:name] query_params[:nameContains] = opts[:name_contains] if opts[:name_contains] 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.(applicable_retry_config(opts), call_name: 'ManagedInstanceClient#list_managed_instance_modules') 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::ManagedInstanceModuleCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_managed_instance_updatable_packages(managed_instance_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_managed_instance_updatable_packages API.
Returns a list of updatable packages for a managed instance.
Allowed values are: timeCreated, displayName
1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 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 |
# File 'lib/oci/os_management_hub/managed_instance_client.rb', line 1099 def list_managed_instance_updatable_packages(managed_instance_id, opts = {}) logger.debug 'Calling operation ManagedInstanceClient#list_managed_instance_updatable_packages.' if logger raise "Missing the required parameter 'managed_instance_id' when calling list_managed_instance_updatable_packages." if managed_instance_id.nil? classification_type_allowable_values = %w[SECURITY BUGFIX ENHANCEMENT OTHER] if opts[:classification_type] && !opts[:classification_type].empty? opts[:classification_type].each do |val_to_check| unless classification_type_allowable_values.include?(val_to_check) raise 'Invalid value for "classification_type", must be one of SECURITY, BUGFIX, ENHANCEMENT, OTHER.' end end 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 if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.' end raise "Parameter value for 'managed_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_instance_id) path = '/managedInstances/{managedInstanceId}/updatablePackages'.sub('{managedInstanceId}', managed_instance_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:classificationType] = OCI::ApiClient.build_collection_params(opts[:classification_type], :multi) if opts[:classification_type] && !opts[:classification_type].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[:advisoryName] = OCI::ApiClient.build_collection_params(opts[:advisory_name], :multi) if opts[:advisory_name] && !opts[:advisory_name].empty? query_params[:compartmentId] = opts[:compartment_id] if opts[: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] # 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.(applicable_retry_config(opts), call_name: 'ManagedInstanceClient#list_managed_instance_updatable_packages') 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::UpdatablePackageCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_managed_instances(opts = {}) ⇒ Response
Click here to see an example of how to use list_managed_instances API.
Lists managed instances that match the specified compartment or managed instance OCID. Filter the list against a variety of criteria including but not limited to its name, status, architecture, and OS version. Allowed values are: timeCreated, displayName
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 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 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 |
# File 'lib/oci/os_management_hub/managed_instance_client.rb', line 1214 def list_managed_instances(opts = {}) logger.debug 'Calling operation ManagedInstanceClient#list_managed_instances.' if logger status_allowable_values = %w[NORMAL UNREACHABLE ERROR WARNING REGISTRATION_ERROR] 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.' end end end arch_type_allowable_values = %w[X86_64 AARCH64 I686 NOARCH SRC] if opts[:arch_type] && !opts[:arch_type].empty? opts[:arch_type].each do |val_to_check| unless arch_type_allowable_values.include?(val_to_check) raise 'Invalid value for "arch_type", must be one of X86_64, AARCH64, I686, NOARCH, SRC.' end end end os_family_allowable_values = %w[ORACLE_LINUX_9 ORACLE_LINUX_8 ORACLE_LINUX_7] 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.' end end 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 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 = '/managedInstances' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id] 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[:managedInstanceId] = opts[:managed_instance_id] if opts[:managed_instance_id] query_params[:status] = OCI::ApiClient.build_collection_params(opts[:status], :multi) if opts[:status] && !opts[:status].empty? query_params[:archType] = OCI::ApiClient.build_collection_params(opts[:arch_type], :multi) if opts[:arch_type] && !opts[:arch_type].empty? query_params[:osFamily] = OCI::ApiClient.build_collection_params(opts[:os_family], :multi) if opts[:os_family] && !opts[:os_family].empty? query_params[:isManagementStation] = opts[:is_management_station] if !opts[:is_management_station].nil? query_params[:group] = opts[:group] if opts[:group] query_params[:groupNotEqualTo] = opts[:group_not_equal_to] if opts[:group_not_equal_to] query_params[:lifecycleStage] = opts[:lifecycle_stage] if opts[:lifecycle_stage] query_params[:lifecycleStageNotEqualTo] = opts[:lifecycle_stage_not_equal_to] if opts[:lifecycle_stage_not_equal_to] query_params[:isAttachedToGroupOrLifecycleStage] = opts[:is_attached_to_group_or_lifecycle_stage] if !opts[:is_attached_to_group_or_lifecycle_stage].nil? query_params[:softwareSourceId] = opts[:software_source_id] if opts[:software_source_id] query_params[:advisoryName] = OCI::ApiClient.build_collection_params(opts[:advisory_name], :multi) if opts[:advisory_name] && !opts[:advisory_name].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] # 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.(applicable_retry_config(opts), call_name: 'ManagedInstanceClient#list_managed_instances') 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::ManagedInstanceCollection' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
94 95 96 |
# File 'lib/oci/os_management_hub/managed_instance_client.rb', line 94 def logger @api_client.config.logger end |
#manage_module_streams_on_managed_instance(managed_instance_id, manage_module_streams_on_managed_instance_details, opts = {}) ⇒ Response
Click here to see an example of how to use manage_module_streams_on_managed_instance API.
Perform an operation involving modules, streams, and profiles on a managed instance. Each operation may enable or disable an arbitrary amount of module streams, and install or remove an arbitrary number of module stream profiles. When the operation is complete, the state of the modules, streams, and profiles on the managed instance will match the state indicated in the operation.
Each module stream specified in the list of module streams to enable will be in the "ENABLED" state upon completion of the operation. If there was already a stream of that module enabled, any work required to switch from the current stream to the new stream is performed implicitly.
Each module stream specified in the list of module streams to disable will be in the "DISABLED" state upon completion of the operation. Any profiles that are installed for the module stream will be removed as part of the operation.
Each module stream profile specified in the list of profiles to install will be in the "INSTALLED" state upon completion of the operation, indicating that any packages that are part of the profile are installed on the managed instance. If the module stream containing the profile is not enabled, it will be enabled as part of the operation. There is an exception when attempting to install a stream of a profile when another stream of the same module is enabled. It is an error to attempt to install a profile of another module stream, unless enabling the new module stream is explicitly included in this operation.
Each module stream profile specified in the list of profiles to remove will be in the "AVAILABLE" state upon completion of the operation. The status of packages within the profile after the operation is complete is defined by the package manager on the managed instance.
Operations that contain one or more elements that are not allowed are rejected.
The result of this request is a work request object. The returned work request is the parent of a structure of other WorkRequests. Taken as a whole, this structure indicates the entire set of work to be performed to complete the operation.
This interface can also be used to perform a dry run of the operation rather than committing it to a managed instance. If a dry run is requested, the OS Management Hub service will evaluate the operation against the current module, stream, and profile state on the managed instance. It will calculate the impact of the operation on all modules, streams, and profiles on the managed instance, including those that are implicitly impacted by the operation.
The WorkRequest resulting from a dry run behaves differently than a WorkRequest resulting from a committable operation. Dry run WorkRequests are always singletons and never have children. The impact of the operation is returned using the log and error facilities of work requests. The impact of operations that are allowed by the OS Management Hub service are communicated as one or more work request log entries. Operations that are not allowed by the OS Management Hub service are communicated as one or more work request error entries. Each entry, for either logs or errors, contains a structured message containing the results of one or more operations.
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 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 |
# File 'lib/oci/os_management_hub/managed_instance_client.rb', line 1396 def manage_module_streams_on_managed_instance(managed_instance_id, manage_module_streams_on_managed_instance_details, opts = {}) logger.debug 'Calling operation ManagedInstanceClient#manage_module_streams_on_managed_instance.' if logger raise "Missing the required parameter 'managed_instance_id' when calling manage_module_streams_on_managed_instance." if managed_instance_id.nil? raise "Missing the required parameter 'manage_module_streams_on_managed_instance_details' when calling manage_module_streams_on_managed_instance." if manage_module_streams_on_managed_instance_details.nil? raise "Parameter value for 'managed_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_instance_id) path = '/managedInstances/{managedInstanceId}/actions/manageModuleStreams'.sub('{managedInstanceId}', managed_instance_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] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(manage_module_streams_on_managed_instance_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagedInstanceClient#manage_module_streams_on_managed_instance') 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 |
#refresh_software_on_managed_instance(managed_instance_id, opts = {}) ⇒ Response
Click here to see an example of how to use refresh_software_on_managed_instance API.
Refresh all installed and updatable software information on a managed instance.
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 |
# File 'lib/oci/os_management_hub/managed_instance_client.rb', line 1466 def refresh_software_on_managed_instance(managed_instance_id, opts = {}) logger.debug 'Calling operation ManagedInstanceClient#refresh_software_on_managed_instance.' if logger raise "Missing the required parameter 'managed_instance_id' when calling refresh_software_on_managed_instance." if managed_instance_id.nil? raise "Parameter value for 'managed_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_instance_id) path = '/managedInstances/{managedInstanceId}/actions/refreshSoftware'.sub('{managedInstanceId}', managed_instance_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] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagedInstanceClient#refresh_software_on_managed_instance') 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 |
#remove_module_stream_profile_from_managed_instance(managed_instance_id, remove_module_stream_profile_from_managed_instance_details, opts = {}) ⇒ Response
Click here to see an example of how to use remove_module_stream_profile_from_managed_instance API.
Removes a profile for a module stream that is installed on a managed instance. If a module stream is provided, rather than a fully qualified profile, all profiles that have been installed for the module stream will be removed.
1538 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 |
# File 'lib/oci/os_management_hub/managed_instance_client.rb', line 1538 def remove_module_stream_profile_from_managed_instance(managed_instance_id, remove_module_stream_profile_from_managed_instance_details, opts = {}) logger.debug 'Calling operation ManagedInstanceClient#remove_module_stream_profile_from_managed_instance.' if logger raise "Missing the required parameter 'managed_instance_id' when calling remove_module_stream_profile_from_managed_instance." if managed_instance_id.nil? raise "Missing the required parameter 'remove_module_stream_profile_from_managed_instance_details' when calling remove_module_stream_profile_from_managed_instance." if remove_module_stream_profile_from_managed_instance_details.nil? raise "Parameter value for 'managed_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_instance_id) path = '/managedInstances/{managedInstanceId}/actions/removeStreamProfiles'.sub('{managedInstanceId}', managed_instance_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] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(remove_module_stream_profile_from_managed_instance_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagedInstanceClient#remove_module_stream_profile_from_managed_instance') 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 |
#remove_packages_from_managed_instance(managed_instance_id, remove_packages_from_managed_instance_details, opts = {}) ⇒ Response
Click here to see an example of how to use remove_packages_from_managed_instance API.
Removes an installed package from a managed instance.
1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 |
# File 'lib/oci/os_management_hub/managed_instance_client.rb', line 1609 def remove_packages_from_managed_instance(managed_instance_id, remove_packages_from_managed_instance_details, opts = {}) logger.debug 'Calling operation ManagedInstanceClient#remove_packages_from_managed_instance.' if logger raise "Missing the required parameter 'managed_instance_id' when calling remove_packages_from_managed_instance." if managed_instance_id.nil? raise "Missing the required parameter 'remove_packages_from_managed_instance_details' when calling remove_packages_from_managed_instance." if remove_packages_from_managed_instance_details.nil? raise "Parameter value for 'managed_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_instance_id) path = '/managedInstances/{managedInstanceId}/actions/removePackages'.sub('{managedInstanceId}', managed_instance_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] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(remove_packages_from_managed_instance_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagedInstanceClient#remove_packages_from_managed_instance') 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 |
#switch_module_stream_on_managed_instance(managed_instance_id, switch_module_stream_on_managed_instance_details, opts = {}) ⇒ Response
Click here to see an example of how to use switch_module_stream_on_managed_instance API.
Enables a new stream for a module that already has a stream enabled. If any profiles or packages from the original module are installed, switching to a new stream will remove the existing packages and install their counterparts in the new stream.
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 |
# File 'lib/oci/os_management_hub/managed_instance_client.rb', line 1683 def switch_module_stream_on_managed_instance(managed_instance_id, switch_module_stream_on_managed_instance_details, opts = {}) logger.debug 'Calling operation ManagedInstanceClient#switch_module_stream_on_managed_instance.' if logger raise "Missing the required parameter 'managed_instance_id' when calling switch_module_stream_on_managed_instance." if managed_instance_id.nil? raise "Missing the required parameter 'switch_module_stream_on_managed_instance_details' when calling switch_module_stream_on_managed_instance." if switch_module_stream_on_managed_instance_details.nil? raise "Parameter value for 'managed_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_instance_id) path = '/managedInstances/{managedInstanceId}/actions/switchModuleStreams'.sub('{managedInstanceId}', managed_instance_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] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(switch_module_stream_on_managed_instance_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagedInstanceClient#switch_module_stream_on_managed_instance') 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 |
#update_all_packages_on_managed_instances_in_compartment(update_all_packages_on_managed_instances_in_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_all_packages_on_managed_instances_in_compartment API.
Install all of the available package updates for all of the managed instances in a compartment.
1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 |
# File 'lib/oci/os_management_hub/managed_instance_client.rb', line 1753 def update_all_packages_on_managed_instances_in_compartment(update_all_packages_on_managed_instances_in_compartment_details, opts = {}) logger.debug 'Calling operation ManagedInstanceClient#update_all_packages_on_managed_instances_in_compartment.' if logger raise "Missing the required parameter 'update_all_packages_on_managed_instances_in_compartment_details' when calling update_all_packages_on_managed_instances_in_compartment." if update_all_packages_on_managed_instances_in_compartment_details.nil? path = '/managedInstances/actions/updatePackages' 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[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] 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_all_packages_on_managed_instances_in_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagedInstanceClient#update_all_packages_on_managed_instances_in_compartment') 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 |
#update_managed_instance(managed_instance_id, update_managed_instance_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_managed_instance API.
Updates the managed instance.
1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 |
# File 'lib/oci/os_management_hub/managed_instance_client.rb', line 1815 def update_managed_instance(managed_instance_id, update_managed_instance_details, opts = {}) logger.debug 'Calling operation ManagedInstanceClient#update_managed_instance.' if logger raise "Missing the required parameter 'managed_instance_id' when calling update_managed_instance." if managed_instance_id.nil? raise "Missing the required parameter 'update_managed_instance_details' when calling update_managed_instance." if update_managed_instance_details.nil? raise "Parameter value for 'managed_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_instance_id) path = '/managedInstances/{managedInstanceId}'.sub('{managedInstanceId}', managed_instance_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 = @api_client.object_to_http_body(update_managed_instance_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagedInstanceClient#update_managed_instance') 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::OsManagementHub::Models::ManagedInstance' ) end # rubocop:enable Metrics/BlockLength end |
#update_packages_on_managed_instance(managed_instance_id, update_packages_on_managed_instance_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_packages_on_managed_instance API.
Updates a package on a managed instance.
1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 |
# File 'lib/oci/os_management_hub/managed_instance_client.rb', line 1885 def update_packages_on_managed_instance(managed_instance_id, update_packages_on_managed_instance_details, opts = {}) logger.debug 'Calling operation ManagedInstanceClient#update_packages_on_managed_instance.' if logger raise "Missing the required parameter 'managed_instance_id' when calling update_packages_on_managed_instance." if managed_instance_id.nil? raise "Missing the required parameter 'update_packages_on_managed_instance_details' when calling update_packages_on_managed_instance." if update_packages_on_managed_instance_details.nil? raise "Parameter value for 'managed_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_instance_id) path = '/managedInstances/{managedInstanceId}/actions/updatePackages'.sub('{managedInstanceId}', managed_instance_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] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(update_packages_on_managed_instance_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagedInstanceClient#update_packages_on_managed_instance') 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 |