Class: OCI::ManagementAgent::ManagementAgentClient
- Inherits:
-
Object
- Object
- OCI::ManagementAgent::ManagementAgentClient
- Defined in:
- lib/oci/management_agent/management_agent_client.rb
Overview
Use the Management Agent API to manage your infrastructure's management agents, including their plugins and install keys. For more information, see Management Agent.
Instance Attribute Summary collapse
-
#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
-
#create_data_source(management_agent_id, create_data_source_details, opts = {}) ⇒ Response
Datasource creation request to given Management Agent.
-
#create_management_agent_install_key(create_management_agent_install_key_details, opts = {}) ⇒ Response
User creates a new install key as part of this API.
-
#delete_data_source(management_agent_id, data_source_key, opts = {}) ⇒ Response
Datasource delete request to given Management Agent.
-
#delete_management_agent(management_agent_id, opts = {}) ⇒ Response
Deletes a Management Agent resource by identifier.
-
#delete_management_agent_install_key(management_agent_install_key_id, opts = {}) ⇒ Response
Deletes a Management Agent install Key resource by identifier.
-
#delete_work_request(work_request_id, opts = {}) ⇒ Response
Cancel the work request with the given ID.
-
#deploy_plugins(deploy_plugins_details, opts = {}) ⇒ Response
Deploys Plugins to a given list of agentIds.
-
#get_auto_upgradable_config(compartment_id, opts = {}) ⇒ Response
Get the AutoUpgradable configuration for all agents in a tenancy.
-
#get_data_source(management_agent_id, data_source_key, opts = {}) ⇒ Response
Get Datasource details for given Id and given Management Agent.
-
#get_management_agent(management_agent_id, opts = {}) ⇒ Response
Gets complete details of the inventory of a given agent id.
-
#get_management_agent_install_key(management_agent_install_key_id, opts = {}) ⇒ Response
Gets complete details of the Agent install Key for a given key id.
-
#get_management_agent_install_key_content(management_agent_install_key_id, opts = {}, &block) ⇒ Response
Returns a file with Management Agent install Key in it.
-
#get_work_request(work_request_id, opts = {}) ⇒ Response
Gets the status of the work request with the given ID.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ManagementAgentClient
constructor
Creates a new ManagementAgentClient.
-
#list_availability_histories(management_agent_id, opts = {}) ⇒ Response
Lists the availability history records of Management Agent Allowed values are: timeAvailabilityStatusStarted.
-
#list_data_sources(management_agent_id, opts = {}) ⇒ Response
A list of Management Agent Data Sources for the given Management Agent Id.
-
#list_management_agent_images(compartment_id, opts = {}) ⇒ Response
Get supported agent image information.
-
#list_management_agent_install_keys(compartment_id, opts = {}) ⇒ Response
Returns a list of Management Agent installed Keys.
-
#list_management_agent_plugins(compartment_id, opts = {}) ⇒ Response
Returns a list of managementAgentPlugins.
-
#list_management_agents(compartment_id, opts = {}) ⇒ Response
Returns a list of Management Agents.
-
#list_work_request_errors(work_request_id, opts = {}) ⇒ Response
Return a (paginated) list of errors for a given work request.
-
#list_work_request_logs(work_request_id, opts = {}) ⇒ Response
Return a (paginated) list of logs for a given work request.
-
#list_work_requests(compartment_id, opts = {}) ⇒ Response
Lists the work requests in a compartment.
-
#logger ⇒ Logger
The logger for this client.
-
#set_auto_upgradable_config(set_auto_upgradable_config_details, opts = {}) ⇒ Response
Sets the AutoUpgradable configuration for all agents in a tenancy.
-
#summarize_management_agent_counts(compartment_id, group_by, opts = {}) ⇒ Response
Gets count of the inventory of agents for a given compartment id, group by, and isPluginDeployed parameters.
-
#summarize_management_agent_plugin_counts(compartment_id, group_by, opts = {}) ⇒ Response
Gets count of the inventory of management agent plugins for a given compartment id and group by parameter.
-
#update_data_source(management_agent_id, data_source_key, update_data_source_details, opts = {}) ⇒ Response
Datasource update request to given Management Agent.
-
#update_management_agent(management_agent_id, update_management_agent_details, opts = {}) ⇒ Response
API to update the console managed properties of the Management Agent.
-
#update_management_agent_install_key(management_agent_install_key_id, update_management_agent_install_key_details, opts = {}) ⇒ Response
API to update the modifiable properties of the Management Agent install key.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ManagementAgentClient
Creates a new ManagementAgentClient. Notes: If a config is not specified, then the global OCI.config will be used.
This client is not thread-safe
Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 56 def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers) # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then # pass it to this constructor. # # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid # so try and load the config from the default file. config = OCI::Config.validate_and_build_config_with_signer(config, signer) signer = OCI::Signer.config_file_auth_builder(config) if signer.nil? @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings) @retry_config = retry_config if endpoint @endpoint = endpoint + '/20200202' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "ManagementAgentClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
16 17 18 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 16 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
20 21 22 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 20 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
30 31 32 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 30 def region @region end |
#retry_config ⇒ OCI::Retry::RetryConfig (readonly)
The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is nil
, which means that an operation will not perform any retries
26 27 28 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 26 def retry_config @retry_config end |
Instance Method Details
#create_data_source(management_agent_id, create_data_source_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_data_source API.
Datasource creation request to given Management Agent.
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 126 def create_data_source(management_agent_id, create_data_source_details, opts = {}) logger.debug 'Calling operation ManagementAgentClient#create_data_source.' if logger raise "Missing the required parameter 'management_agent_id' when calling create_data_source." if management_agent_id.nil? raise "Missing the required parameter 'create_data_source_details' when calling create_data_source." if create_data_source_details.nil? raise "Parameter value for 'management_agent_id' must not be blank" if OCI::Internal::Util.blank_string?(management_agent_id) path = '/managementAgents/{managementAgentId}/dataSources'.sub('{managementAgentId}', management_agent_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_data_source_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagementAgentClient#create_data_source') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#create_management_agent_install_key(create_management_agent_install_key_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_management_agent_install_key API.
User creates a new install key as part of this API.
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 190 def create_management_agent_install_key(create_management_agent_install_key_details, opts = {}) logger.debug 'Calling operation ManagementAgentClient#create_management_agent_install_key.' if logger raise "Missing the required parameter 'create_management_agent_install_key_details' when calling create_management_agent_install_key." if create_management_agent_install_key_details.nil? path = '/managementAgentInstallKeys' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_management_agent_install_key_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagementAgentClient#create_management_agent_install_key') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ManagementAgent::Models::ManagementAgentInstallKey' ) end # rubocop:enable Metrics/BlockLength end |
#delete_data_source(management_agent_id, data_source_key, opts = {}) ⇒ Response
Click here to see an example of how to use delete_data_source API.
Datasource delete request to given Management Agent.
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 284 285 286 287 288 289 290 291 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 253 def delete_data_source(management_agent_id, data_source_key, opts = {}) logger.debug 'Calling operation ManagementAgentClient#delete_data_source.' if logger raise "Missing the required parameter 'management_agent_id' when calling delete_data_source." if management_agent_id.nil? raise "Missing the required parameter 'data_source_key' when calling delete_data_source." if data_source_key.nil? raise "Parameter value for 'management_agent_id' must not be blank" if OCI::Internal::Util.blank_string?(management_agent_id) raise "Parameter value for 'data_source_key' must not be blank" if OCI::Internal::Util.blank_string?(data_source_key) path = '/managementAgents/{managementAgentId}/dataSources/{dataSourceKey}'.sub('{managementAgentId}', management_agent_id.to_s).sub('{dataSourceKey}', data_source_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagementAgentClient#delete_data_source') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_management_agent(management_agent_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_management_agent API.
Deletes a Management Agent resource by identifier
315 316 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 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 315 def delete_management_agent(management_agent_id, opts = {}) logger.debug 'Calling operation ManagementAgentClient#delete_management_agent.' if logger raise "Missing the required parameter 'management_agent_id' when calling delete_management_agent." if management_agent_id.nil? raise "Parameter value for 'management_agent_id' must not be blank" if OCI::Internal::Util.blank_string?(management_agent_id) path = '/managementAgents/{managementAgentId}'.sub('{managementAgentId}', management_agent_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagementAgentClient#delete_management_agent') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_management_agent_install_key(management_agent_install_key_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_management_agent_install_key API.
Deletes a Management Agent install Key resource by identifier
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 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 375 def delete_management_agent_install_key(management_agent_install_key_id, opts = {}) logger.debug 'Calling operation ManagementAgentClient#delete_management_agent_install_key.' if logger raise "Missing the required parameter 'management_agent_install_key_id' when calling delete_management_agent_install_key." if management_agent_install_key_id.nil? raise "Parameter value for 'management_agent_install_key_id' must not be blank" if OCI::Internal::Util.blank_string?(management_agent_install_key_id) path = '/managementAgentInstallKeys/{managementAgentInstallKeyId}'.sub('{managementAgentInstallKeyId}', management_agent_install_key_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagementAgentClient#delete_management_agent_install_key') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_work_request(work_request_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_work_request API.
Cancel the work request with the given ID.
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 435 def delete_work_request(work_request_id, opts = {}) logger.debug 'Calling operation ManagementAgentClient#delete_work_request.' if logger raise "Missing the required parameter 'work_request_id' when calling delete_work_request." if work_request_id.nil? raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id) path = '/workRequests/{workRequestId}'.sub('{workRequestId}', work_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagementAgentClient#delete_work_request') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#deploy_plugins(deploy_plugins_details, opts = {}) ⇒ Response
Click here to see an example of how to use deploy_plugins API.
Deploys Plugins to a given list of agentIds.
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 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 496 def deploy_plugins(deploy_plugins_details, opts = {}) logger.debug 'Calling operation ManagementAgentClient#deploy_plugins.' if logger raise "Missing the required parameter 'deploy_plugins_details' when calling deploy_plugins." if deploy_plugins_details.nil? path = '/managementAgents/actions/deployPlugins' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(deploy_plugins_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagementAgentClient#deploy_plugins') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#get_auto_upgradable_config(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_auto_upgradable_config API.
Get the AutoUpgradable configuration for all agents in a tenancy. The supplied compartmentId must be a tenancy root.
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 586 587 588 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 552 def get_auto_upgradable_config(compartment_id, opts = {}) logger.debug 'Calling operation ManagementAgentClient#get_auto_upgradable_config.' if logger raise "Missing the required parameter 'compartment_id' when calling get_auto_upgradable_config." if compartment_id.nil? path = '/managementAgents/actions/getAutoUpgradableConfig' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagementAgentClient#get_auto_upgradable_config') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ManagementAgent::Models::AutoUpgradableConfig' ) end # rubocop:enable Metrics/BlockLength end |
#get_data_source(management_agent_id, data_source_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_data_source API.
Get Datasource details for given Id and given Management Agent.
614 615 616 617 618 619 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 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 614 def get_data_source(management_agent_id, data_source_key, opts = {}) logger.debug 'Calling operation ManagementAgentClient#get_data_source.' if logger raise "Missing the required parameter 'management_agent_id' when calling get_data_source." if management_agent_id.nil? raise "Missing the required parameter 'data_source_key' when calling get_data_source." if data_source_key.nil? raise "Parameter value for 'management_agent_id' must not be blank" if OCI::Internal::Util.blank_string?(management_agent_id) raise "Parameter value for 'data_source_key' must not be blank" if OCI::Internal::Util.blank_string?(data_source_key) path = '/managementAgents/{managementAgentId}/dataSources/{dataSourceKey}'.sub('{managementAgentId}', management_agent_id.to_s).sub('{dataSourceKey}', data_source_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagementAgentClient#get_data_source') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ManagementAgent::Models::DataSource' ) end # rubocop:enable Metrics/BlockLength end |
#get_management_agent(management_agent_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_management_agent API.
Gets complete details of the inventory of a given agent id
672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 672 def get_management_agent(management_agent_id, opts = {}) logger.debug 'Calling operation ManagementAgentClient#get_management_agent.' if logger raise "Missing the required parameter 'management_agent_id' when calling get_management_agent." if management_agent_id.nil? raise "Parameter value for 'management_agent_id' must not be blank" if OCI::Internal::Util.blank_string?(management_agent_id) path = '/managementAgents/{managementAgentId}'.sub('{managementAgentId}', management_agent_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagementAgentClient#get_management_agent') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ManagementAgent::Models::ManagementAgent' ) end # rubocop:enable Metrics/BlockLength end |
#get_management_agent_install_key(management_agent_install_key_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_management_agent_install_key API.
Gets complete details of the Agent install Key for a given key id
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 759 760 761 762 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 726 def get_management_agent_install_key(management_agent_install_key_id, opts = {}) logger.debug 'Calling operation ManagementAgentClient#get_management_agent_install_key.' if logger raise "Missing the required parameter 'management_agent_install_key_id' when calling get_management_agent_install_key." if management_agent_install_key_id.nil? raise "Parameter value for 'management_agent_install_key_id' must not be blank" if OCI::Internal::Util.blank_string?(management_agent_install_key_id) path = '/managementAgentInstallKeys/{managementAgentInstallKeyId}'.sub('{managementAgentInstallKeyId}', management_agent_install_key_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagementAgentClient#get_management_agent_install_key') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ManagementAgent::Models::ManagementAgentInstallKey' ) end # rubocop:enable Metrics/BlockLength end |
#get_management_agent_install_key_content(management_agent_install_key_id, opts = {}, &block) ⇒ Response
Click here to see an example of how to use get_management_agent_install_key_content API.
Returns a file with Management Agent install Key in it
784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 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 862 863 864 865 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 784 def get_management_agent_install_key_content(management_agent_install_key_id, opts = {}, &block) logger.debug 'Calling operation ManagementAgentClient#get_management_agent_install_key_content.' if logger raise "Missing the required parameter 'management_agent_install_key_id' when calling get_management_agent_install_key_content." if management_agent_install_key_id.nil? raise "Parameter value for 'management_agent_install_key_id' must not be blank" if OCI::Internal::Util.blank_string?(management_agent_install_key_id) path = '/managementAgentInstallKeys/{managementAgentInstallKeyId}/content'.sub('{managementAgentInstallKeyId}', management_agent_install_key_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:pluginName] = OCI::ApiClient.build_collection_params(opts[:plugin_name], :multi) if opts[:plugin_name] && !opts[:plugin_name].empty? # Header Params header_params = {} header_params[:accept] = opts[:accept] if opts[:accept] header_params[:accept] ||= 'application/octet-stream' header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding] header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagementAgentClient#get_management_agent_install_key_content') do if !block.nil? @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Stream', &block ) elsif opts[:response_target] if opts[:response_target].respond_to? :write @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Stream', &proc { |chunk, _response| opts[:response_target].write(chunk) } ) elsif opts[:response_target].is_a?(String) File.open(opts[:response_target], 'wb') do |output| return @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Stream', &proc { |chunk, _response| output.write(chunk) } ) end end else @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'String' ) end end # rubocop:enable Metrics/BlockLength end |
#get_work_request(work_request_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_work_request API.
Gets the status of the work request with the given ID.
883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 883 def get_work_request(work_request_id, opts = {}) logger.debug 'Calling operation ManagementAgentClient#get_work_request.' if logger raise "Missing the required parameter 'work_request_id' when calling get_work_request." if work_request_id.nil? raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id) path = '/workRequests/{workRequestId}'.sub('{workRequestId}', work_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagementAgentClient#get_work_request') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ManagementAgent::Models::WorkRequest' ) end # rubocop:enable Metrics/BlockLength end |
#list_availability_histories(management_agent_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_availability_histories API.
Lists the availability history records of Management Agent Allowed values are: timeAvailabilityStatusStarted
952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 952 def list_availability_histories(management_agent_id, opts = {}) logger.debug 'Calling operation ManagementAgentClient#list_availability_histories.' if logger raise "Missing the required parameter 'management_agent_id' when calling list_availability_histories." if management_agent_id.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[timeAvailabilityStatusStarted].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeAvailabilityStatusStarted.' end raise "Parameter value for 'management_agent_id' must not be blank" if OCI::Internal::Util.blank_string?(management_agent_id) path = '/managementAgents/{managementAgentId}/availabilityHistories'.sub('{managementAgentId}', management_agent_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:timeAvailabilityStatusEndedGreaterThan] = opts[:time_availability_status_ended_greater_than] if opts[:time_availability_status_ended_greater_than] query_params[:timeAvailabilityStatusStartedLessThan] = opts[:time_availability_status_started_less_than] if opts[:time_availability_status_started_less_than] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagementAgentClient#list_availability_histories') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::ManagementAgent::Models::AvailabilityHistorySummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_data_sources(management_agent_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_data_sources API.
A list of Management Agent Data Sources for the given Management Agent Id.
Allowed values are: dataSourceName, dataSourceType
1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 1029 def list_data_sources(management_agent_id, opts = {}) logger.debug 'Calling operation ManagementAgentClient#list_data_sources.' if logger raise "Missing the required parameter 'management_agent_id' when calling list_data_sources." if management_agent_id.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[dataSourceName dataSourceType].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of dataSourceName, dataSourceType.' end raise "Parameter value for 'management_agent_id' must not be blank" if OCI::Internal::Util.blank_string?(management_agent_id) path = '/managementAgents/{managementAgentId}/dataSources'.sub('{managementAgentId}', management_agent_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:name] = OCI::ApiClient.build_collection_params(opts[:name], :multi) if opts[:name] && !opts[:name].empty? # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagementAgentClient#list_data_sources') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::ManagementAgent::Models::DataSourceSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_management_agent_images(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_management_agent_images API.
Get supported agent image information
Allowed values are: platformType, version
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 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 1113 def list_management_agent_images(compartment_id, opts = {}) logger.debug 'Calling operation ManagementAgentClient#list_management_agent_images.' if logger raise "Missing the required parameter 'compartment_id' when calling list_management_agent_images." if compartment_id.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[platformType version].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of platformType, version.' end if opts[:lifecycle_state] && !OCI::ManagementAgent::Models::LIFECYCLE_STATES_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::ManagementAgent::Models::LIFECYCLE_STATES_ENUM.' end if opts[:install_type] && !OCI::ManagementAgent::Models::INSTALL_TYPES_ENUM.include?(opts[:install_type]) raise 'Invalid value for "install_type", must be one of the values in OCI::ManagementAgent::Models::INSTALL_TYPES_ENUM.' end path = '/managementAgentImages' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:name] = opts[:name] if opts[:name] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:installType] = opts[:install_type] if opts[:install_type] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagementAgentClient#list_management_agent_images') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::ManagementAgent::Models::ManagementAgentImageSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_management_agent_install_keys(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_management_agent_install_keys API.
Returns a list of Management Agent installed Keys.
Allowed values are: timeCreated, displayName
1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 1203 def list_management_agent_install_keys(compartment_id, opts = {}) logger.debug 'Calling operation ManagementAgentClient#list_management_agent_install_keys.' if logger raise "Missing the required parameter 'compartment_id' when calling list_management_agent_install_keys." if compartment_id.nil? if opts[:lifecycle_state] && !OCI::ManagementAgent::Models::LIFECYCLE_STATES_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::ManagementAgent::Models::LIFECYCLE_STATES_ENUM.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.' end path = '/managementAgentInstallKeys' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil? query_params[:accessLevel] = opts[:access_level] if opts[:access_level] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:page] = opts[:page] if opts[:page] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagementAgentClient#list_management_agent_install_keys') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::ManagementAgent::Models::ManagementAgentInstallKeySummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_management_agent_plugins(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_management_agent_plugins API.
Returns a list of managementAgentPlugins.
Allowed values are: displayName
1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 1289 def list_management_agent_plugins(compartment_id, opts = {}) logger.debug 'Calling operation ManagementAgentClient#list_management_agent_plugins.' if logger raise "Missing the required parameter 'compartment_id' when calling list_management_agent_plugins." if compartment_id.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[displayName].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of displayName.' end if opts[:lifecycle_state] && !OCI::ManagementAgent::Models::LIFECYCLE_STATES_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::ManagementAgent::Models::LIFECYCLE_STATES_ENUM.' end platform_type_allowable_values = %w[LINUX WINDOWS SOLARIS MACOSX] if opts[:platform_type] && !opts[:platform_type].empty? opts[:platform_type].each do |val_to_check| unless platform_type_allowable_values.include?(val_to_check) raise 'Invalid value for "platform_type", must be one of LINUX, WINDOWS, SOLARIS, MACOSX.' end end end path = '/managementAgentPlugins' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:platformType] = OCI::ApiClient.build_collection_params(opts[:platform_type], :multi) if opts[:platform_type] && !opts[:platform_type].empty? query_params[:agentId] = opts[:agent_id] if opts[:agent_id] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagementAgentClient#list_management_agent_plugins') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::ManagementAgent::Models::ManagementAgentPluginSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_management_agents(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_management_agents API.
Returns a list of Management Agents. If no explicit page size limit is specified, it will default to 1000 when compartmentIdInSubtree is true and 5000 otherwise. The response is limited to maximum 1000 records when compartmentIdInSubtree is true.
Allowed values are: timeCreated, displayName, host, availabilityStatus, platformType, pluginDisplayNames, version
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 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 1399 def list_management_agents(compartment_id, opts = {}) logger.debug 'Calling operation ManagementAgentClient#list_management_agents.' if logger raise "Missing the required parameter 'compartment_id' when calling list_management_agents." if compartment_id.nil? if opts[:lifecycle_state] && !OCI::ManagementAgent::Models::LIFECYCLE_STATES_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::ManagementAgent::Models::LIFECYCLE_STATES_ENUM.' end if opts[:availability_status] && !OCI::ManagementAgent::Models::AVAILABILITY_STATUS_ENUM.include?(opts[:availability_status]) raise 'Invalid value for "availability_status", must be one of the values in OCI::ManagementAgent::Models::AVAILABILITY_STATUS_ENUM.' end platform_type_allowable_values = %w[LINUX WINDOWS SOLARIS MACOSX] if opts[:platform_type] && !opts[:platform_type].empty? opts[:platform_type].each do |val_to_check| unless platform_type_allowable_values.include?(val_to_check) raise 'Invalid value for "platform_type", must be one of LINUX, WINDOWS, SOLARIS, MACOSX.' end end end if opts[:install_type] && !OCI::ManagementAgent::Models::INSTALL_TYPES_ENUM.include?(opts[:install_type]) raise 'Invalid value for "install_type", must be one of the values in OCI::ManagementAgent::Models::INSTALL_TYPES_ENUM.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[timeCreated displayName host availabilityStatus platformType pluginDisplayNames version].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeCreated, displayName, host, availabilityStatus, platformType, pluginDisplayNames, version.' end if opts[:data_source_type] && !OCI::ManagementAgent::Models::DATA_SOURCE_TYPES_ENUM.include?(opts[:data_source_type]) raise 'Invalid value for "data_source_type", must be one of the values in OCI::ManagementAgent::Models::DATA_SOURCE_TYPES_ENUM.' end path = '/managementAgents' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:pluginName] = OCI::ApiClient.build_collection_params(opts[:plugin_name], :multi) if opts[:plugin_name] && !opts[:plugin_name].empty? query_params[:version] = OCI::ApiClient.build_collection_params(opts[:version], :multi) if opts[:version] && !opts[:version].empty? query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:availabilityStatus] = opts[:availability_status] if opts[:availability_status] query_params[:hostId] = opts[:host_id] if opts[:host_id] query_params[:platformType] = OCI::ApiClient.build_collection_params(opts[:platform_type], :multi) if opts[:platform_type] && !opts[:platform_type].empty? query_params[:isCustomerDeployed] = opts[:is_customer_deployed] if !opts[:is_customer_deployed].nil? query_params[:installType] = opts[:install_type] if opts[:install_type] query_params[:gatewayId] = OCI::ApiClient.build_collection_params(opts[:gateway_id], :multi) if opts[:gateway_id] && !opts[:gateway_id].empty? query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil? query_params[:accessLevel] = opts[:access_level] if opts[:access_level] query_params[:dataSourceType] = opts[:data_source_type] if opts[:data_source_type] query_params[:dataSourceName] = OCI::ApiClient.build_collection_params(opts[:data_source_name], :multi) if opts[:data_source_name] && !opts[:data_source_name].empty? # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagementAgentClient#list_management_agents') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::ManagementAgent::Models::ManagementAgentSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_work_request_errors(work_request_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_work_request_errors API.
Return a (paginated) list of errors for a given work request.
Allowed values are: timestamp
1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 1513 def list_work_request_errors(work_request_id, opts = {}) logger.debug 'Calling operation ManagementAgentClient#list_work_request_errors.' if logger raise "Missing the required parameter 'work_request_id' when calling list_work_request_errors." if work_request_id.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[timestamp].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timestamp.' end raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id) path = '/workRequests/{workRequestId}/errors'.sub('{workRequestId}', work_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagementAgentClient#list_work_request_errors') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::ManagementAgent::Models::WorkRequestError>' ) end # rubocop:enable Metrics/BlockLength end |
#list_work_request_logs(work_request_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_work_request_logs API.
Return a (paginated) list of logs for a given work request.
Allowed values are: timestamp
1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 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 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 1587 def list_work_request_logs(work_request_id, opts = {}) logger.debug 'Calling operation ManagementAgentClient#list_work_request_logs.' if logger raise "Missing the required parameter 'work_request_id' when calling list_work_request_logs." if work_request_id.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[timestamp].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timestamp.' end raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id) path = '/workRequests/{workRequestId}/logs'.sub('{workRequestId}', work_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagementAgentClient#list_work_request_logs') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::ManagementAgent::Models::WorkRequestLogEntry>' ) end # rubocop:enable Metrics/BlockLength end |
#list_work_requests(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_work_requests API.
Lists the work requests in a compartment.
Allowed values are: timeAccepted
1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 1669 def list_work_requests(compartment_id, opts = {}) logger.debug 'Calling operation ManagementAgentClient#list_work_requests.' if logger raise "Missing the required parameter 'compartment_id' when calling list_work_requests." if compartment_id.nil? if opts[:status] && !OCI::ManagementAgent::Models::OPERATION_STATUS_ENUM.include?(opts[:status]) raise 'Invalid value for "status", must be one of the values in OCI::ManagementAgent::Models::OPERATION_STATUS_ENUM.' end type_allowable_values = %w[DEPLOY_PLUGIN UPGRADE_PLUGIN CREATE_UPGRADE_PLUGINS AGENTIMAGE_UPGRADE CREATE_DATA_SOURCE UPDATE_DATA_SOURCE DELETE_DATA_SOURCE] if opts[:type] && !opts[:type].empty? opts[:type].each do |val_to_check| unless type_allowable_values.include?(val_to_check) raise 'Invalid value for "type", must be one of DEPLOY_PLUGIN, UPGRADE_PLUGIN, CREATE_UPGRADE_PLUGINS, AGENTIMAGE_UPGRADE, CREATE_DATA_SOURCE, UPDATE_DATA_SOURCE, DELETE_DATA_SOURCE.' end end end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[timeAccepted].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeAccepted.' end path = '/workRequests' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:agentId] = opts[:agent_id] if opts[:agent_id] query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:status] = opts[:status] if opts[:status] query_params[:type] = OCI::ApiClient.build_collection_params(opts[:type], :multi) if opts[:type] && !opts[:type].empty? query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagementAgentClient#list_work_requests') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::ManagementAgent::Models::WorkRequestSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
95 96 97 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 95 def logger @api_client.config.logger end |
#set_auto_upgradable_config(set_auto_upgradable_config_details, opts = {}) ⇒ Response
Click here to see an example of how to use set_auto_upgradable_config API.
Sets the AutoUpgradable configuration for all agents in a tenancy. The supplied compartmentId must be a tenancy root.
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 1791 1792 1793 1794 1795 1796 1797 1798 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 1761 def set_auto_upgradable_config(set_auto_upgradable_config_details, opts = {}) logger.debug 'Calling operation ManagementAgentClient#set_auto_upgradable_config.' if logger raise "Missing the required parameter 'set_auto_upgradable_config_details' when calling set_auto_upgradable_config." if set_auto_upgradable_config_details.nil? path = '/managementAgents/actions/setAutoUpgradableConfig' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(set_auto_upgradable_config_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagementAgentClient#set_auto_upgradable_config') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ManagementAgent::Models::AutoUpgradableConfig' ) end # rubocop:enable Metrics/BlockLength end |
#summarize_management_agent_counts(compartment_id, group_by, opts = {}) ⇒ Response
Click here to see an example of how to use summarize_management_agent_counts API.
Gets count of the inventory of agents for a given compartment id, group by, and isPluginDeployed parameters. Supported groupBy parameters: availabilityStatus, platformType, version
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 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 1824 def summarize_management_agent_counts(compartment_id, group_by, opts = {}) logger.debug 'Calling operation ManagementAgentClient#summarize_management_agent_counts.' if logger raise "Missing the required parameter 'compartment_id' when calling summarize_management_agent_counts." if compartment_id.nil? raise "Missing the required parameter 'group_by' when calling summarize_management_agent_counts." if group_by.nil? group_by_allowable_values = %w[availabilityStatus platformType version] group_by.each do |val_to_check| unless group_by_allowable_values.include?(val_to_check) raise "Invalid value for 'group_by', must be one of availabilityStatus, platformType, version." end end if opts[:install_type] && !OCI::ManagementAgent::Models::INSTALL_TYPES_ENUM.include?(opts[:install_type]) raise 'Invalid value for "install_type", must be one of the values in OCI::ManagementAgent::Models::INSTALL_TYPES_ENUM.' end path = '/managementAgentCounts' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:groupBy] = OCI::ApiClient.build_collection_params(group_by, :multi) query_params[:hasPlugins] = opts[:has_plugins] if !opts[:has_plugins].nil? query_params[:installType] = opts[:install_type] if opts[:install_type] query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil? query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagementAgentClient#summarize_management_agent_counts') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ManagementAgent::Models::ManagementAgentAggregationCollection' ) end # rubocop:enable Metrics/BlockLength end |
#summarize_management_agent_plugin_counts(compartment_id, group_by, opts = {}) ⇒ Response
Click here to see an example of how to use summarize_management_agent_plugin_counts API.
Gets count of the inventory of management agent plugins for a given compartment id and group by parameter. Supported groupBy parameter: pluginName
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 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 1900 def summarize_management_agent_plugin_counts(compartment_id, group_by, opts = {}) logger.debug 'Calling operation ManagementAgentClient#summarize_management_agent_plugin_counts.' if logger raise "Missing the required parameter 'compartment_id' when calling summarize_management_agent_plugin_counts." if compartment_id.nil? raise "Missing the required parameter 'group_by' when calling summarize_management_agent_plugin_counts." if group_by.nil? unless OCI::ManagementAgent::Models::MANAGEMENT_AGENT_PLUGIN_GROUP_BY_ENUM.include?(group_by) raise 'Invalid value for "group_by", must be one of the values in OCI::ManagementAgent::Models::MANAGEMENT_AGENT_PLUGIN_GROUP_BY_ENUM.' end path = '/managementAgentPluginCounts' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:groupBy] = group_by query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil? query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagementAgentClient#summarize_management_agent_plugin_counts') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ManagementAgent::Models::ManagementAgentPluginAggregationCollection' ) end # rubocop:enable Metrics/BlockLength end |
#update_data_source(management_agent_id, data_source_key, update_data_source_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_data_source API.
Datasource update request to given Management Agent.
1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 1977 def update_data_source(management_agent_id, data_source_key, update_data_source_details, opts = {}) logger.debug 'Calling operation ManagementAgentClient#update_data_source.' if logger raise "Missing the required parameter 'management_agent_id' when calling update_data_source." if management_agent_id.nil? raise "Missing the required parameter 'data_source_key' when calling update_data_source." if data_source_key.nil? raise "Missing the required parameter 'update_data_source_details' when calling update_data_source." if update_data_source_details.nil? raise "Parameter value for 'management_agent_id' must not be blank" if OCI::Internal::Util.blank_string?(management_agent_id) raise "Parameter value for 'data_source_key' must not be blank" if OCI::Internal::Util.blank_string?(data_source_key) path = '/managementAgents/{managementAgentId}/dataSources/{dataSourceKey}'.sub('{managementAgentId}', management_agent_id.to_s).sub('{dataSourceKey}', data_source_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(update_data_source_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagementAgentClient#update_data_source') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#update_management_agent(management_agent_id, update_management_agent_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_management_agent API.
API to update the console managed properties of the Management Agent.
2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 2050 def update_management_agent(management_agent_id, update_management_agent_details, opts = {}) logger.debug 'Calling operation ManagementAgentClient#update_management_agent.' if logger raise "Missing the required parameter 'management_agent_id' when calling update_management_agent." if management_agent_id.nil? raise "Missing the required parameter 'update_management_agent_details' when calling update_management_agent." if update_management_agent_details.nil? raise "Parameter value for 'management_agent_id' must not be blank" if OCI::Internal::Util.blank_string?(management_agent_id) path = '/managementAgents/{managementAgentId}'.sub('{managementAgentId}', management_agent_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(update_management_agent_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagementAgentClient#update_management_agent') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ManagementAgent::Models::ManagementAgent' ) end # rubocop:enable Metrics/BlockLength end |
#update_management_agent_install_key(management_agent_install_key_id, update_management_agent_install_key_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_management_agent_install_key API.
API to update the modifiable properties of the Management Agent install key.
2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 |
# File 'lib/oci/management_agent/management_agent_client.rb', line 2122 def update_management_agent_install_key(management_agent_install_key_id, update_management_agent_install_key_details, opts = {}) logger.debug 'Calling operation ManagementAgentClient#update_management_agent_install_key.' if logger raise "Missing the required parameter 'management_agent_install_key_id' when calling update_management_agent_install_key." if management_agent_install_key_id.nil? raise "Missing the required parameter 'update_management_agent_install_key_details' when calling update_management_agent_install_key." if update_management_agent_install_key_details.nil? raise "Parameter value for 'management_agent_install_key_id' must not be blank" if OCI::Internal::Util.blank_string?(management_agent_install_key_id) path = '/managementAgentInstallKeys/{managementAgentInstallKeyId}'.sub('{managementAgentInstallKeyId}', management_agent_install_key_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(update_management_agent_install_key_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ManagementAgentClient#update_management_agent_install_key') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ManagementAgent::Models::ManagementAgentInstallKey' ) end # rubocop:enable Metrics/BlockLength end |