Class: OCI::ComputeInstanceAgent::ComputeInstanceAgentClient
- Inherits:
-
Object
- Object
- OCI::ComputeInstanceAgent::ComputeInstanceAgentClient
- Defined in:
- lib/oci/compute_instance_agent/compute_instance_agent_client.rb
Overview
API for the Oracle Cloud Agent software running on compute instances. Oracle Cloud Agent is a lightweight process that monitors and manages compute instances.
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
-
#cancel_instance_agent_command(instance_agent_command_id, opts = {}) ⇒ Response
Cancels a command that is scheduled to run on a compute instance that is managed by Oracle Cloud Agent.
-
#create_instance_agent_command(create_instance_agent_command_details, opts = {}) ⇒ Response
Creates a command or script to run on a compute instance that is managed by Oracle Cloud Agent.
-
#get_instance_agent_command(instance_agent_command_id, opts = {}) ⇒ Response
Gets information about an Oracle Cloud Agent command.
-
#get_instance_agent_command_execution(instance_agent_command_id, instance_id, opts = {}) ⇒ Response
Gets information about the status of specified instance agent commandId for the given instanceId.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ComputeInstanceAgentClient
constructor
Creates a new ComputeInstanceAgentClient.
-
#list_instance_agent_command_executions(compartment_id, instance_id, opts = {}) ⇒ Response
Lists the execution details for Oracle Cloud Agent commands that run on the specified compute instance.
-
#list_instance_agent_commands(compartment_id, opts = {}) ⇒ Response
Lists the Oracle Cloud Agent commands issued in a compartment.
-
#logger ⇒ Logger
The logger for this client.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ComputeInstanceAgentClient
Creates a new ComputeInstanceAgentClient. 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/compute_instance_agent/compute_instance_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 + '/20180530' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "ComputeInstanceAgentClient 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/compute_instance_agent/compute_instance_agent_client.rb', line 16 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
20 21 22 |
# File 'lib/oci/compute_instance_agent/compute_instance_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/compute_instance_agent/compute_instance_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/compute_instance_agent/compute_instance_agent_client.rb', line 26 def retry_config @retry_config end |
Instance Method Details
#cancel_instance_agent_command(instance_agent_command_id, opts = {}) ⇒ Response
Click here to see an example of how to use cancel_instance_agent_command API.
Cancels a command that is scheduled to run on a compute instance that is managed by Oracle Cloud Agent.
Canceling a command is a best-effort attempt. If the command has already completed, it will not be canceled.
123 124 125 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 |
# File 'lib/oci/compute_instance_agent/compute_instance_agent_client.rb', line 123 def cancel_instance_agent_command(instance_agent_command_id, opts = {}) logger.debug 'Calling operation ComputeInstanceAgentClient#cancel_instance_agent_command.' if logger raise "Missing the required parameter 'instance_agent_command_id' when calling cancel_instance_agent_command." if instance_agent_command_id.nil? raise "Parameter value for 'instance_agent_command_id' must not be blank" if OCI::Internal::Util.blank_string?(instance_agent_command_id) path = '/instanceAgentCommands/{instanceAgentCommandId}'.sub('{instanceAgentCommandId}', instance_agent_command_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: 'ComputeInstanceAgentClient#cancel_instance_agent_command') 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 |
#create_instance_agent_command(create_instance_agent_command_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_instance_agent_command API.
Creates a command or script to run on a compute instance that is managed by Oracle Cloud Agent.
On Linux instances, the script runs in a bash shell. On Windows instances, the script runs in a batch shell.
Commands that require administrator privileges will run only if Oracle Cloud Agent is running with administrator privileges.
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 |
# File 'lib/oci/compute_instance_agent/compute_instance_agent_client.rb', line 192 def create_instance_agent_command(create_instance_agent_command_details, opts = {}) logger.debug 'Calling operation ComputeInstanceAgentClient#create_instance_agent_command.' if logger raise "Missing the required parameter 'create_instance_agent_command_details' when calling create_instance_agent_command." if create_instance_agent_command_details.nil? path = '/instanceAgentCommands' 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] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_instance_agent_command_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeInstanceAgentClient#create_instance_agent_command') 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::ComputeInstanceAgent::Models::InstanceAgentCommand' ) end # rubocop:enable Metrics/BlockLength end |
#get_instance_agent_command(instance_agent_command_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_instance_agent_command API.
Gets information about an Oracle Cloud Agent command.
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 |
# File 'lib/oci/compute_instance_agent/compute_instance_agent_client.rb', line 249 def get_instance_agent_command(instance_agent_command_id, opts = {}) logger.debug 'Calling operation ComputeInstanceAgentClient#get_instance_agent_command.' if logger raise "Missing the required parameter 'instance_agent_command_id' when calling get_instance_agent_command." if instance_agent_command_id.nil? raise "Parameter value for 'instance_agent_command_id' must not be blank" if OCI::Internal::Util.blank_string?(instance_agent_command_id) path = '/instanceAgentCommands/{instanceAgentCommandId}'.sub('{instanceAgentCommandId}', instance_agent_command_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: 'ComputeInstanceAgentClient#get_instance_agent_command') 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::ComputeInstanceAgent::Models::InstanceAgentCommand' ) end # rubocop:enable Metrics/BlockLength end |
#get_instance_agent_command_execution(instance_agent_command_id, instance_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_instance_agent_command_execution API.
Gets information about the status of specified instance agent commandId for the given instanceId.
306 307 308 309 310 311 312 313 314 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 |
# File 'lib/oci/compute_instance_agent/compute_instance_agent_client.rb', line 306 def get_instance_agent_command_execution(instance_agent_command_id, instance_id, opts = {}) logger.debug 'Calling operation ComputeInstanceAgentClient#get_instance_agent_command_execution.' if logger raise "Missing the required parameter 'instance_agent_command_id' when calling get_instance_agent_command_execution." if instance_agent_command_id.nil? raise "Missing the required parameter 'instance_id' when calling get_instance_agent_command_execution." if instance_id.nil? raise "Parameter value for 'instance_agent_command_id' must not be blank" if OCI::Internal::Util.blank_string?(instance_agent_command_id) path = '/instanceAgentCommands/{instanceAgentCommandId}/status'.sub('{instanceAgentCommandId}', instance_agent_command_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:instanceId] = instance_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: 'ComputeInstanceAgentClient#get_instance_agent_command_execution') 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::ComputeInstanceAgent::Models::InstanceAgentCommandExecution' ) end # rubocop:enable Metrics/BlockLength end |
#list_instance_agent_command_executions(compartment_id, instance_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_instance_agent_command_executions API.
Lists the execution details for Oracle Cloud Agent commands that run on the specified compute instance.
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 |
# File 'lib/oci/compute_instance_agent/compute_instance_agent_client.rb', line 389 def list_instance_agent_command_executions(compartment_id, instance_id, opts = {}) logger.debug 'Calling operation ComputeInstanceAgentClient#list_instance_agent_command_executions.' if logger raise "Missing the required parameter 'compartment_id' when calling list_instance_agent_command_executions." if compartment_id.nil? raise "Missing the required parameter 'instance_id' when calling list_instance_agent_command_executions." if instance_id.nil? if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' 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[:lifecycle_state] && !OCI::ComputeInstanceAgent::Models::InstanceAgentCommandExecutionSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::ComputeInstanceAgent::Models::InstanceAgentCommandExecutionSummary::LIFECYCLE_STATE_ENUM.' end path = '/instanceAgentCommandExecutions' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:instanceId] = instance_id query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] # 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: 'ComputeInstanceAgentClient#list_instance_agent_command_executions') 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::ComputeInstanceAgent::Models::InstanceAgentCommandExecutionSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_instance_agent_commands(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_instance_agent_commands API.
Lists the Oracle Cloud Agent commands issued in a compartment.
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 |
# File 'lib/oci/compute_instance_agent/compute_instance_agent_client.rb', line 486 def list_instance_agent_commands(compartment_id, opts = {}) logger.debug 'Calling operation ComputeInstanceAgentClient#list_instance_agent_commands.' if logger raise "Missing the required parameter 'compartment_id' when calling list_instance_agent_commands." if compartment_id.nil? if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' 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 path = '/instanceAgentCommands' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeInstanceAgentClient#list_instance_agent_commands') 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::ComputeInstanceAgent::Models::InstanceAgentCommandSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
95 96 97 |
# File 'lib/oci/compute_instance_agent/compute_instance_agent_client.rb', line 95 def logger @api_client.config.logger end |