ComputeInstanceAgentClient

class oci.compute_instance_agent.ComputeInstanceAgentClient(config, **kwargs)

API for the Oracle Cloud Agent software running on compute instances. Oracle Cloud Agent is a lightweight process that monitors and manages compute instances.

Methods

__init__(config, **kwargs) Creates a new service client
cancel_instance_agent_command(…) Cancels a command that is scheduled to run on a compute instance that is managed by Oracle Cloud Agent.
create_instance_agent_command(…) Creates a command or script to run on a compute instance that is managed by Oracle Cloud Agent.
get_instance_agent_command(…) Gets information about an Oracle Cloud Agent command.
get_instance_agent_command_execution(…) Gets information about the status of specified instance agent commandId for the given instanceId.
list_instance_agent_command_executions(…) Lists the execution details for Oracle Cloud Agent commands that run on the specified compute instance.
list_instance_agent_commands(compartment_id, …) Lists the Oracle Cloud Agent commands issued in a compartment.
__init__(config, **kwargs)

Creates a new service client

Parameters:
  • config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
  • service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
  • timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
  • signer (AbstractBaseSigner) –

    (optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

    One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

cancel_instance_agent_command(instance_agent_command_id, **kwargs)

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.

Parameters:
  • instance_agent_command_id (str) –

    (required) The OCID of the command.

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • if_match (str) – (optional) 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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

create_instance_agent_command(create_instance_agent_command_details, **kwargs)

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.

Parameters:
  • create_instance_agent_command_details (oci.compute_instance_agent.models.CreateInstanceAgentCommandDetails) – (required) Create Instance agent command details
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) 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).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type InstanceAgentCommand

Return type:

Response

Example:

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

get_instance_agent_command(instance_agent_command_id, **kwargs)

Gets information about an Oracle Cloud Agent command.

Parameters:
  • instance_agent_command_id (str) –

    (required) The OCID of the command.

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type InstanceAgentCommand

Return type:

Response

Example:

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

get_instance_agent_command_execution(instance_agent_command_id, instance_id, **kwargs)

Gets information about the status of specified instance agent commandId for the given instanceId.

Parameters:
  • instance_agent_command_id (str) –

    (required) The OCID of the command.

  • instance_id (str) –

    (required) The OCID of the instance.

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type InstanceAgentCommandExecution

Return type:

Response

Example:

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

list_instance_agent_command_executions(compartment_id, instance_id, **kwargs)

Lists the execution details for Oracle Cloud Agent commands that run on the specified compute instance.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • instance_id (str) –

    (required) The OCID of the instance.

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • page (str) –

    (optional) 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.

  • limit (int) –

    (optional) 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.

  • sort_by (str) –

    (optional) 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”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

    Allowed values are: “ACCEPTED”, “IN_PROGRESS”, “SUCCEEDED”, “FAILED”, “TIMED_OUT”, “CANCELED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of InstanceAgentCommandExecutionSummary

Return type:

Response

Example:

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

list_instance_agent_commands(compartment_id, **kwargs)

Lists the Oracle Cloud Agent commands issued in a compartment.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • page (str) –

    (optional) 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.

  • limit (int) –

    (optional) 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.

  • sort_by (str) –

    (optional) 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”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of InstanceAgentCommandSummary

Return type:

Response

Example:

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