class OCI::ComputeInstanceAgent::ComputeInstanceAgentClient
API for the Oracle Cloud Agent software running on compute instances. Oracle Cloud Agent is a lightweight process that monitors and manages compute instances.
Attributes
Client used to make HTTP requests. @return [OCI::ApiClient]
Fully qualified endpoint URL @return [String]
The region, which will usually correspond to a value in {OCI::Regions::REGION_ENUM}. @return [String]
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 @return [OCI::Retry::RetryConfig]
Public Class Methods
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.
@param [Config] config A Config
object. @param [String] region A region used to determine the service endpoint. This will usually
correspond to a value in {OCI::Regions::REGION_ENUM}, but may be an arbitrary string.
@param [String] endpoint The fully qualified endpoint URL @param [OCI::BaseSigner] signer A signer implementation which can be used by this client. If this is not provided then
a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication, so that the instance principals signer can be provided to the client
@param [OCI::ApiClientProxySettings] proxy_settings If your environment requires you to use a proxy server for outgoing HTTP requests
the details for the proxy can be provided in this parameter
@param [OCI::Retry::RetryConfig] retry_config
The retry configuration for this service client. This represents the default retry configuration to
apply across all operations. This can be overridden on a per-operation basis. The default retry configuration value is `nil`, which means that an operation will not perform any retries
# File lib/oci/compute_instance_agent/compute_instance_agent_client.rb, line 54 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
Public Instance Methods
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.
@param [String] instance_agent_command_id The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the command. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :opc_request_id Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,
please provide the request ID.
@option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
@return [Response] A Response
object with data of type nil @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/computeinstanceagent/cancel_instance_agent_command.rb.html) to see an example of how to use cancel_instance_agent_command
API.
# File lib/oci/compute_instance_agent/compute_instance_agent_client.rb, line 121 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.make_retrying_call(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
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.
@param [OCI::ComputeInstanceAgent::Models::CreateInstanceAgentCommandDetails] create_instance_agent_command_details Create Instance agent command details @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :opc_request_id Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,
please provide the request ID.
@option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
@return [Response] A Response
object with data of type {OCI::ComputeInstanceAgent::Models::InstanceAgentCommand InstanceAgentCommand} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/computeinstanceagent/create_instance_agent_command.rb.html) to see an example of how to use create_instance_agent_command
API.
# File lib/oci/compute_instance_agent/compute_instance_agent_client.rb, line 190 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.make_retrying_call(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
Gets information about an Oracle Cloud Agent command. @param [String] instance_agent_command_id The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the command. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :opc_request_id Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,
please provide the request ID.
@return [Response] A Response
object with data of type {OCI::ComputeInstanceAgent::Models::InstanceAgentCommand InstanceAgentCommand} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/computeinstanceagent/get_instance_agent_command.rb.html) to see an example of how to use get_instance_agent_command
API.
# File lib/oci/compute_instance_agent/compute_instance_agent_client.rb, line 247 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.make_retrying_call(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
Gets information about the status of specified instance agent commandId for the given instanceId. @param [String] instance_agent_command_id The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the command. @param [String] instance_id The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the instance. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :opc_request_id Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,
please provide the request ID.
@return [Response] A Response
object with data of type {OCI::ComputeInstanceAgent::Models::InstanceAgentCommandExecution InstanceAgentCommandExecution} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/computeinstanceagent/get_instance_agent_command_execution.rb.html) to see an example of how to use get_instance_agent_command_execution
API.
# File lib/oci/compute_instance_agent/compute_instance_agent_client.rb, line 304 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.make_retrying_call(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
Lists the execution details for Oracle Cloud Agent commands that run on the specified compute instance.
@param [String] compartment_id The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment. @param [String] instance_id The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the instance. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :opc_request_id Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,
please provide the request ID.
@option opts [String] :page For list pagination. The value of the `opc-next-page` response header from the previous "List"
call. For important details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
@option opts [Integer] :limit For list pagination. The maximum number of results per page, or items to return in a paginated
\"List\" call. For important details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 1)
@option opts [String] :sort_by The field to sort by. You can provide one sort order (`sortOrder`). Default order for
`TIMECREATED` is descending. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these \"List\" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: TIMECREATED, DISPLAYNAME
@option opts [String] :sort_order The sort order to use, either ascending (`ASC`) or descending (`DESC`). The `DISPLAYNAME` sort order
is case sensitive. Allowed values are: ASC, DESC
@option opts [String] :lifecycle_state A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. @return [Response] A Response
object with data of type Array<{OCI::ComputeInstanceAgent::Models::InstanceAgentCommandExecutionSummary InstanceAgentCommandExecutionSummary}> @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/computeinstanceagent/list_instance_agent_command_executions.rb.html) to see an example of how to use list_instance_agent_command_executions
API.
# File lib/oci/compute_instance_agent/compute_instance_agent_client.rb, line 387 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.make_retrying_call(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
Lists the Oracle Cloud Agent commands issued in a compartment.
@param [String] compartment_id The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :opc_request_id Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,
please provide the request ID.
@option opts [String] :page For list pagination. The value of the `opc-next-page` response header from the previous "List"
call. For important details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
@option opts [Integer] :limit For list pagination. The maximum number of results per page, or items to return in a paginated
\"List\" call. For important details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 1)
@option opts [String] :sort_by The field to sort by. You can provide one sort order (`sortOrder`). Default order for
`TIMECREATED` is descending. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these \"List\" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: TIMECREATED, DISPLAYNAME
@option opts [String] :sort_order The sort order to use, either ascending (`ASC`) or descending (`DESC`). The `DISPLAYNAME` sort order
is case sensitive. Allowed values are: ASC, DESC
@return [Response] A Response
object with data of type Array<{OCI::ComputeInstanceAgent::Models::InstanceAgentCommandSummary InstanceAgentCommandSummary}> @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/computeinstanceagent/list_instance_agent_commands.rb.html) to see an example of how to use list_instance_agent_commands
API.
# File lib/oci/compute_instance_agent/compute_instance_agent_client.rb, line 484 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.make_retrying_call(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
@return [Logger] The logger for this client. May be nil.
# File lib/oci/compute_instance_agent/compute_instance_agent_client.rb, line 93 def logger @api_client.config.logger end
Set the region that will be used to determine the service endpoint. This will usually correspond to a value in {OCI::Regions::REGION_ENUM}, but may be an arbitrary string.
# File lib/oci/compute_instance_agent/compute_instance_agent_client.rb, line 83 def region=(new_region) @region = new_region raise 'A region must be specified.' unless @region @endpoint = OCI::Regions.get_service_endpoint_for_template(@region, 'https://iaas.{region}.{secondLevelDomain}') + '/20180530' logger.info "ComputeInstanceAgentClient endpoint set to '#{@endpoint} from region #{@region}'." if logger end
Private Instance Methods
rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity rubocop:enable Style/IfUnlessModifier, Metrics/ParameterLists rubocop:enable Metrics/MethodLength, Layout/EmptyLines
# File lib/oci/compute_instance_agent/compute_instance_agent_client.rb, line 539 def applicable_retry_config(opts = {}) return @retry_config unless opts.key?(:retry_config) opts[:retry_config] end