Class ComputeInstanceAgentClient

Service client instance for ComputeInstanceAgent.

Inheritance

object

ClientBase

RegionalClientBase

ComputeInstanceAgentClient

Implements

IDisposable

Inherited Members

RegionalClientBase.logger

RegionalClientBase.SetRegion(Region)

RegionalClientBase.SetRegion(string)

RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)

RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)

RegionalClientBase.parseEndpointForParameters(string)

ClientBase.restClient

ClientBase.service

ClientBase.userAgent

ClientBase.Dispose()

ClientBase.Dispose(bool)

ClientBase.SetEndpoint(string)

ClientBase.GetEndpoint()

ClientBase.GetUserAgent()

ClientBase.SetRealmSpecificEndpointTemplate(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.ComputeinstanceagentService

Assembly: OCI.DotNetSDK.Computeinstanceagent.dll

Syntax

public class ComputeInstanceAgentClient : RegionalClientBase, IDisposable

Constructors

ComputeInstanceAgentClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)

Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.

Declaration

public ComputeInstanceAgentClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)

Parameters

Type	Name	Description
IBasicAuthenticationDetailsProvider	authenticationDetailsProvider	The authentication details provider. Required.
ClientConfiguration	clientConfiguration	The client configuration that contains settings to adjust REST client behaviors. Optional.
string	endpoint	The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional.

Properties

Paginators

Declaration

public ComputeInstanceAgentPaginators Paginators { get; }

Property Value

Type	Description
ComputeInstanceAgentPaginators

Waiters

Declaration

public ComputeInstanceAgentWaiters Waiters { get; }

Property Value

Type	Description
ComputeInstanceAgentWaiters

Methods

CancelInstanceAgentCommand(CancelInstanceAgentCommandRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancels a command that is scheduled to run on a compute instance that is managed by Oracle Cloud Agent. <br/> Canceling a command is a best-effort attempt. If the command has already completed, it will not be canceled.

Declaration

public Task<CancelInstanceAgentCommandResponse> CancelInstanceAgentCommand(CancelInstanceAgentCommandRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CancelInstanceAgentCommandRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CancelInstanceAgentCommandResponse>	A response object containing details about the completed operation

Examples

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

CreateInstanceAgentCommand(CreateInstanceAgentCommandRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a command or script to run on a compute instance that is managed by Oracle Cloud Agent. <br/> On Linux instances, the script runs in a bash shell. On Windows instances, the script runs in a batch shell. <br/> Commands that require administrator privileges will run only if Oracle Cloud Agent is running with administrator privileges.

Declaration

public Task<CreateInstanceAgentCommandResponse> CreateInstanceAgentCommand(CreateInstanceAgentCommandRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateInstanceAgentCommandRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateInstanceAgentCommandResponse>	A response object containing details about the completed operation

Examples

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

GetInstanceAgentCommand(GetInstanceAgentCommandRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about an Oracle Cloud Agent command.

Declaration

public Task<GetInstanceAgentCommandResponse> GetInstanceAgentCommand(GetInstanceAgentCommandRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetInstanceAgentCommandRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetInstanceAgentCommandResponse>	A response object containing details about the completed operation

Examples

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

GetInstanceAgentCommandExecution(GetInstanceAgentCommandExecutionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<GetInstanceAgentCommandExecutionResponse> GetInstanceAgentCommandExecution(GetInstanceAgentCommandExecutionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetInstanceAgentCommandExecutionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetInstanceAgentCommandExecutionResponse>	A response object containing details about the completed operation

Examples

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

ListInstanceAgentCommandExecutions(ListInstanceAgentCommandExecutionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<ListInstanceAgentCommandExecutionsResponse> ListInstanceAgentCommandExecutions(ListInstanceAgentCommandExecutionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListInstanceAgentCommandExecutionsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListInstanceAgentCommandExecutionsResponse>	A response object containing details about the completed operation

Examples

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

ListInstanceAgentCommands(ListInstanceAgentCommandsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the Oracle Cloud Agent commands issued in a compartment.

Declaration

public Task<ListInstanceAgentCommandsResponse> ListInstanceAgentCommands(ListInstanceAgentCommandsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListInstanceAgentCommandsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListInstanceAgentCommandsResponse>	A response object containing details about the completed operation

Examples

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

Implements

IDisposable