Oracle Cloud Infrastructure Documentation
Try Free Tier

Compute Instance Agent Common Types

DBMS_CLOUD_OCI_COMPUTE_INSTANCE_AGENT_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_compute_instance_agent_varchar2_tbl FORCE IS TABLE OF (varchar2(32767)) NOT PERSISTABLE;

DBMS_CLOUD_OCI_COMPUTE_INSTANCE_AGENT_AVAILABLE_PLUGIN_SUMMARY_T Type

Describes where the plugin is supported

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_compute_instance_agent_available_plugin_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  summary varchar2(32767),
  is_supported number,
  is_enabled_by_default number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_available_plugin_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_available_plugin_summary_t (
    name varchar2,
    summary varchar2,
    is_supported number,
    is_enabled_by_default number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) The plugin name

summary

(optional) A brief description of the plugin functionality

is_supported

(required) Is the plugin supported or not

is_enabled_by_default

(required) Is the plugin enabled or disabled by default

DBMS_CLOUD_OCI_COMPUTE_INSTANCE_AGENT_INSTANCE_AGENT_COMMAND_TARGET_T Type

The target instance that the command runs on.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_compute_instance_agent_instance_agent_command_target_t FORCE AUTHID CURRENT_USER IS OBJECT (
  instance_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_target_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_target_t (
    instance_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

instance_id

(optional) The OCID of the target instance.

DBMS_CLOUD_OCI_COMPUTE_INSTANCE_AGENT_INSTANCE_AGENT_COMMAND_SOURCE_DETAILS_T Type

The source of the command.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_compute_instance_agent_instance_agent_command_source_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  source_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_source_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_source_details_t (
    source_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

source_type

(required) The source type for the command. The following values are supported: - `TEXT` - uses a plain text command that is specified inline with the request. - `OBJECT_STORAGE_URI` - imports a command from an Object Storage URL. - `OBJECT_STORAGE_TUPLE` - imports a command from an Object Storage bucket. For background information about Object Storage buckets and URLs, see Overview of Object Storage.

Allowed values are: 'TEXT', 'OBJECT_STORAGE_URI', 'OBJECT_STORAGE_TUPLE'

DBMS_CLOUD_OCI_COMPUTE_INSTANCE_AGENT_INSTANCE_AGENT_COMMAND_OUTPUT_DETAILS_T Type

The output destination for the command.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_compute_instance_agent_instance_agent_command_output_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  output_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_output_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_output_details_t (
    output_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

output_type

(required) The output type for the command. The following values are supported: - `TEXT` - the command output is returned as plain text. - `OBJECT_STORAGE_URI` - the command output is saved to an Object Storage URL. - `OBJECT_STORAGE_TUPLE` - the command output is saved to an Object Storage bucket. For background information about Object Storage buckets and URLs, see Overview of Object Storage.

Allowed values are: 'TEXT', 'OBJECT_STORAGE_URI', 'OBJECT_STORAGE_TUPLE'

DBMS_CLOUD_OCI_COMPUTE_INSTANCE_AGENT_INSTANCE_AGENT_COMMAND_CONTENT_T Type

The contents of the command.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_compute_instance_agent_instance_agent_command_content_t FORCE AUTHID CURRENT_USER IS OBJECT (
  source dbms_cloud_oci_compute_instance_agent_instance_agent_command_source_details_t,
  output dbms_cloud_oci_compute_instance_agent_instance_agent_command_output_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_content_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_content_t (
    source dbms_cloud_oci_compute_instance_agent_instance_agent_command_source_details_t,
    output dbms_cloud_oci_compute_instance_agent_instance_agent_command_output_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

source

(required) The source of the command.

output

(optional) The output destination for the command.

DBMS_CLOUD_OCI_COMPUTE_INSTANCE_AGENT_CREATE_INSTANCE_AGENT_COMMAND_DETAILS_T Type

Creation details for an Oracle Cloud Agent command.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_compute_instance_agent_create_instance_agent_command_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  execution_time_out_in_seconds number,
  display_name varchar2(32767),
  target dbms_cloud_oci_compute_instance_agent_instance_agent_command_target_t,
  content dbms_cloud_oci_compute_instance_agent_instance_agent_command_content_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_create_instance_agent_command_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_create_instance_agent_command_details_t (
    compartment_id varchar2,
    execution_time_out_in_seconds number,
    display_name varchar2,
    target dbms_cloud_oci_compute_instance_agent_instance_agent_command_target_t,
    content dbms_cloud_oci_compute_instance_agent_instance_agent_command_content_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment to create the command in.

execution_time_out_in_seconds

(required) The amount of time that Oracle Cloud Agent is given to run the command on the instance before timing out. The timer starts when Oracle Cloud Agent starts the command. Zero means no timeout.

display_name

(optional) A user-friendly name for the command. It does not have to be unique. Avoid entering confidential information. Example: `Database Backup Script`

target

(required) The target instance to run the command on.

content

(required) The contents of the command.

DBMS_CLOUD_OCI_COMPUTE_INSTANCE_AGENT_ERROR_T Type

Error response

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_compute_instance_agent_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_error_t (
    code varchar2,
    message varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

code

(required) A short error code that defines the error, meant for programmatic parsing. See API Errors.

message

(required) A human-readable error string.

DBMS_CLOUD_OCI_COMPUTE_INSTANCE_AGENT_INSTANCE_AGENT_COMMAND_T Type

The command payload.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_compute_instance_agent_instance_agent_command_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  is_canceled number,
  execution_time_out_in_seconds number,
  target dbms_cloud_oci_compute_instance_agent_instance_agent_command_target_t,
  content dbms_cloud_oci_compute_instance_agent_instance_agent_command_content_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_t (
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    is_canceled number,
    execution_time_out_in_seconds number,
    target dbms_cloud_oci_compute_instance_agent_instance_agent_command_target_t,
    content dbms_cloud_oci_compute_instance_agent_instance_agent_command_content_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the command.

compartment_id

(required) The OCID of the compartment containing the command.

display_name

(optional) A user-friendly name. Does not have to be unique. Avoid entering confidential information.

time_created

(optional) The date and time the command was created, in the format defined by RFC3339.

time_updated

(optional) The date and time the command was last updated, in the format defined by RFC3339.

is_canceled

(optional) Whether a request was made to cancel the command. Canceling a command is a best-effort attempt.

execution_time_out_in_seconds

(optional) The amount of time that Oracle Cloud Agent is given to run the command on the instance before timing out. The timer starts when Oracle Cloud Agent starts the command. Zero means no timeout.

target

(required) The target instance that the command runs on.

content

(required) The contents of the command.

DBMS_CLOUD_OCI_COMPUTE_INSTANCE_AGENT_INSTANCE_AGENT_COMMAND_EXECUTION_OUTPUT_CONTENT_T Type

The execution output from a command.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_compute_instance_agent_instance_agent_command_execution_output_content_t FORCE AUTHID CURRENT_USER IS OBJECT (
  output_type varchar2(32767),
  exit_code number,
  message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_execution_output_content_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_execution_output_content_t (
    output_type varchar2,
    exit_code number,
    message varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

output_type

(required) The output destination type for the command. The following values are supported: - TEXT - the command output is returned as plain text. - OBJECT_STORAGE_URI - the command output is saved to an Object Storage URL. - OBJECT_STORAGE_TUPLE - the command output is saved to an Object Storage bucket. For background information about Object Storage buckets and URLs, see Overview of Object Storage.

Allowed values are: 'TEXT', 'OBJECT_STORAGE_URI', 'OBJECT_STORAGE_TUPLE'

exit_code

(required) The exit code for the command. Exit code `0` indicates success.

message

(optional) An optional status message that Oracle Cloud Agent can populate for additional troubleshooting.

DBMS_CLOUD_OCI_COMPUTE_INSTANCE_AGENT_INSTANCE_AGENT_COMMAND_EXECUTION_T Type

A command's execution summary.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_compute_instance_agent_instance_agent_command_execution_t FORCE AUTHID CURRENT_USER IS OBJECT (
  instance_agent_command_id varchar2(32767),
  instance_id varchar2(32767),
  delivery_state varchar2(32767),
  lifecycle_state varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  sequence_number number,
  display_name varchar2(32767),
  content dbms_cloud_oci_compute_instance_agent_instance_agent_command_execution_output_content_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_execution_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_execution_t (
    instance_agent_command_id varchar2,
    instance_id varchar2,
    delivery_state varchar2,
    lifecycle_state varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    sequence_number number,
    display_name varchar2,
    content dbms_cloud_oci_compute_instance_agent_instance_agent_command_execution_output_content_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

instance_agent_command_id

(required) The OCID of the command

instance_id

(required) The OCID of the instance

delivery_state

(required) Specifies the command delivery state. * `VISIBLE` - The command is visible to instance. * `PENDING` - The command is pending ack from the instance. * `ACKED` - The command has been received and acked by the instance. * `ACKED_CANCELED` - The canceled command has been received and acked by the instance. * `EXPIRED` - The instance has not requested for commands and its delivery has expired.

Allowed values are: 'VISIBLE', 'PENDING', 'ACKED', 'ACKED_CANCELED', 'EXPIRED'

lifecycle_state

(required) command execution life cycle state. * `ACCEPTED` - The command execution has been accepted to run. * `IN_PROGRESS` - The command execution is in progress. * `SUCCEEDED` - The command execution is successful. * `FAILED` - The command execution has failed. * `TIMED_OUT` - The command execution has timedout. * `CANCELED` - The command execution has canceled.

Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'SUCCEEDED', 'FAILED', 'TIMED_OUT', 'CANCELED'

time_created

(required) The command creation date

time_updated

(required) The command last updated at date.

sequence_number

(required) The large non-consecutive number that Run Command Service assigns to each created command.

display_name

(optional) The user friendly display name of the command.

content

(required)

DBMS_CLOUD_OCI_COMPUTE_INSTANCE_AGENT_INSTANCE_AGENT_COMMAND_EXECUTION_OUTPUT_VIA_OBJECT_STORAGE_TUPLE_DETAILS_T Type

The execution output from a command when saved to an Object Storage bucket.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_compute_instance_agent_instance_agent_command_execution_output_via_object_storage_tuple_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_compute_instance_agent_instance_agent_command_execution_output_content_t (
  bucket_name varchar2(32767),
  namespace_name varchar2(32767),
  object_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_execution_output_via_object_storage_tuple_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_execution_output_via_object_storage_tuple_details_t (
    output_type varchar2,
    exit_code number,
    message varchar2,
    bucket_name varchar2,
    namespace_name varchar2,
    object_name varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_compute_instance_agent_instance_agent_command_execution_output_via_object_storage_tuple_details_t is a subtype of the dbms_cloud_oci_compute_instance_agent_instance_agent_command_execution_output_content_t type.

Fields

Field Description

bucket_name

(required) The Object Storage bucket for the command output.

namespace_name

(required) The Object Storage namespace for the command output.

object_name

(required) The Object Storage object name for the command output.

DBMS_CLOUD_OCI_COMPUTE_INSTANCE_AGENT_INSTANCE_AGENT_COMMAND_EXECUTION_OUTPUT_VIA_OBJECT_STORAGE_URI_DETAILS_T Type

The execution output from a command when saved to an Object Storage URL.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_compute_instance_agent_instance_agent_command_execution_output_via_object_storage_uri_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_compute_instance_agent_instance_agent_command_execution_output_content_t (
  output_uri varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_execution_output_via_object_storage_uri_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_execution_output_via_object_storage_uri_details_t (
    output_type varchar2,
    exit_code number,
    message varchar2,
    output_uri varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_compute_instance_agent_instance_agent_command_execution_output_via_object_storage_uri_details_t is a subtype of the dbms_cloud_oci_compute_instance_agent_instance_agent_command_execution_output_content_t type.

Fields

Field Description

output_uri

(required) The Object Storage URL or pre-authenticated request (PAR) for the command output.

DBMS_CLOUD_OCI_COMPUTE_INSTANCE_AGENT_INSTANCE_AGENT_COMMAND_EXECUTION_OUTPUT_VIA_TEXT_DETAILS_T Type

The execution output from a command when returned in plain text.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_compute_instance_agent_instance_agent_command_execution_output_via_text_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_compute_instance_agent_instance_agent_command_execution_output_content_t (
  text varchar2(32767),
  text_sha256 varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_execution_output_via_text_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_execution_output_via_text_details_t (
    output_type varchar2,
    exit_code number,
    message varchar2,
    text varchar2,
    text_sha256 varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_compute_instance_agent_instance_agent_command_execution_output_via_text_details_t is a subtype of the dbms_cloud_oci_compute_instance_agent_instance_agent_command_execution_output_content_t type.

Fields

Field Description

text

(optional) The command output.

text_sha256

(optional) SHA-256 checksum value of the text content.

DBMS_CLOUD_OCI_COMPUTE_INSTANCE_AGENT_INSTANCE_AGENT_COMMAND_EXECUTION_SUMMARY_T Type

Execution details for a command.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_compute_instance_agent_instance_agent_command_execution_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  instance_agent_command_id varchar2(32767),
  instance_id varchar2(32767),
  delivery_state varchar2(32767),
  lifecycle_state varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  sequence_number number,
  display_name varchar2(32767),
  content dbms_cloud_oci_compute_instance_agent_instance_agent_command_execution_output_content_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_execution_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_execution_summary_t (
    instance_agent_command_id varchar2,
    instance_id varchar2,
    delivery_state varchar2,
    lifecycle_state varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    sequence_number number,
    display_name varchar2,
    content dbms_cloud_oci_compute_instance_agent_instance_agent_command_execution_output_content_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

instance_agent_command_id

(required) The OCID of the command.

instance_id

(required) The OCID of the instance.

delivery_state

(required) The command delivery state. * `VISIBLE` - The command is visible to the instance. * `PENDING` - The command is pending acknowledgment from the instance. * `ACKED` - The command has been received and acknowledged by the instance. * `ACKED_CANCELED` - The canceled command has been received and acknowledged by the instance. * `EXPIRED` - The instance has not requested for commands and the command's delivery has expired.

Allowed values are: 'VISIBLE', 'PENDING', 'ACKED', 'ACKED_CANCELED', 'EXPIRED'

lifecycle_state

(required) The command execution lifecycle state. * `ACCEPTED` - The command has been accepted to run. * `IN_PROGRESS` - The command is in progress. * `SUCCEEDED` - The command was successfully executed. * `FAILED` - The command failed to execute. * `TIMED_OUT` - The command execution timed out. * `CANCELED` - The command execution was canceled.

Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'SUCCEEDED', 'FAILED', 'TIMED_OUT', 'CANCELED'

time_created

(required) The date and time the command was created, in the format defined by RFC3339.

time_updated

(required) The date and time the command was last updated, in the format defined by RFC3339.

sequence_number

(required) A large, non-consecutive number that Oracle Cloud Agent assigns to each created command.

display_name

(optional) A user-friendly name. Does not have to be unique.

content

(required) The execution output from a command.

DBMS_CLOUD_OCI_COMPUTE_INSTANCE_AGENT_INSTANCE_AGENT_COMMAND_OUTPUT_VIA_OBJECT_STORAGE_TUPLE_DETAILS_T Type

The command output destination when saved to an Object Storage bucket.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_compute_instance_agent_instance_agent_command_output_via_object_storage_tuple_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_compute_instance_agent_instance_agent_command_output_details_t (
  bucket_name varchar2(32767),
  namespace_name varchar2(32767),
  object_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_output_via_object_storage_tuple_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_output_via_object_storage_tuple_details_t (
    output_type varchar2,
    bucket_name varchar2,
    namespace_name varchar2,
    object_name varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_compute_instance_agent_instance_agent_command_output_via_object_storage_tuple_details_t is a subtype of the dbms_cloud_oci_compute_instance_agent_instance_agent_command_output_details_t type.

Fields

Field Description

bucket_name

(required) The Object Storage bucket for the command output.

namespace_name

(required) The Object Storage namespace for the command output.

object_name

(required) The Object Storage object name for the command output.

DBMS_CLOUD_OCI_COMPUTE_INSTANCE_AGENT_INSTANCE_AGENT_COMMAND_OUTPUT_VIA_OBJECT_STORAGE_URI_DETAILS_T Type

The command output destination when saved to an Object Storage URL.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_compute_instance_agent_instance_agent_command_output_via_object_storage_uri_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_compute_instance_agent_instance_agent_command_output_details_t (
  output_uri varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_output_via_object_storage_uri_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_output_via_object_storage_uri_details_t (
    output_type varchar2,
    output_uri varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_compute_instance_agent_instance_agent_command_output_via_object_storage_uri_details_t is a subtype of the dbms_cloud_oci_compute_instance_agent_instance_agent_command_output_details_t type.

Fields

Field Description

output_uri

(required) The Object Storage URL or pre-authenticated request (PAR) for the command output.

DBMS_CLOUD_OCI_COMPUTE_INSTANCE_AGENT_INSTANCE_AGENT_COMMAND_OUTPUT_VIA_TEXT_DETAILS_T Type

The command output destination when returned in plain text.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_compute_instance_agent_instance_agent_command_output_via_text_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_compute_instance_agent_instance_agent_command_output_details_t (
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_output_via_text_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_output_via_text_details_t (
    output_type varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_compute_instance_agent_instance_agent_command_output_via_text_details_t is a subtype of the dbms_cloud_oci_compute_instance_agent_instance_agent_command_output_details_t type.

DBMS_CLOUD_OCI_COMPUTE_INSTANCE_AGENT_INSTANCE_AGENT_COMMAND_SOURCE_VIA_OBJECT_STORAGE_TUPLE_DETAILS_T Type

The source of the command when imported from an Object Storage bucket.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_compute_instance_agent_instance_agent_command_source_via_object_storage_tuple_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_compute_instance_agent_instance_agent_command_source_details_t (
  bucket_name varchar2(32767),
  namespace_name varchar2(32767),
  object_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_source_via_object_storage_tuple_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_source_via_object_storage_tuple_details_t (
    source_type varchar2,
    bucket_name varchar2,
    namespace_name varchar2,
    object_name varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_compute_instance_agent_instance_agent_command_source_via_object_storage_tuple_details_t is a subtype of the dbms_cloud_oci_compute_instance_agent_instance_agent_command_source_details_t type.

Fields

Field Description

bucket_name

(required) The Object Storage bucket for the command.

namespace_name

(required) The Object Storage namespace for the command.

object_name

(required) The Object Storage object name for the command.

DBMS_CLOUD_OCI_COMPUTE_INSTANCE_AGENT_INSTANCE_AGENT_COMMAND_SOURCE_VIA_OBJECT_STORAGE_URI_DETAILS_T Type

The source of the command when imported from an Object Storage URL.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_compute_instance_agent_instance_agent_command_source_via_object_storage_uri_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_compute_instance_agent_instance_agent_command_source_details_t (
  source_uri varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_source_via_object_storage_uri_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_source_via_object_storage_uri_details_t (
    source_type varchar2,
    source_uri varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_compute_instance_agent_instance_agent_command_source_via_object_storage_uri_details_t is a subtype of the dbms_cloud_oci_compute_instance_agent_instance_agent_command_source_details_t type.

Fields

Field Description

source_uri

(required) The Object Storage URL or pre-authenticated request (PAR) for the command.

DBMS_CLOUD_OCI_COMPUTE_INSTANCE_AGENT_INSTANCE_AGENT_COMMAND_SOURCE_VIA_TEXT_DETAILS_T Type

The source of the command when provided using plain text.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_compute_instance_agent_instance_agent_command_source_via_text_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_compute_instance_agent_instance_agent_command_source_details_t (
  text varchar2(32767),
  text_sha256 varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_source_via_text_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_source_via_text_details_t (
    source_type varchar2,
    text varchar2,
    text_sha256 varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_compute_instance_agent_instance_agent_command_source_via_text_details_t is a subtype of the dbms_cloud_oci_compute_instance_agent_instance_agent_command_source_details_t type.

Fields

Field Description

text

(required) The plain text command.

text_sha256

(optional) SHA-256 checksum value of the text content.

DBMS_CLOUD_OCI_COMPUTE_INSTANCE_AGENT_INSTANCE_AGENT_COMMAND_SUMMARY_T Type

Summary information for a command.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_compute_instance_agent_instance_agent_command_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  instance_agent_command_id varchar2(32767),
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  is_canceled number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_command_summary_t (
    instance_agent_command_id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    is_canceled number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

instance_agent_command_id

(required) The OCID of the command.

display_name

(optional) A user-friendly name. Does not have to be unique.

compartment_id

(required) The OCID of the compartment containing the command.

time_created

(required) The date and time the command was created, in the format defined by RFC3339.

time_updated

(required) The date and time the command was last updated, in the format defined by RFC3339.

is_canceled

(optional) Whether a request was made to cancel the command. Canceling a command is a best-effort attempt.

DBMS_CLOUD_OCI_COMPUTE_INSTANCE_AGENT_INSTANCE_AGENT_PLUGIN_T Type

The agent plugin

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_compute_instance_agent_instance_agent_plugin_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  status varchar2(32767),
  time_last_updated_utc timestamp with time zone,
  message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_plugin_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_plugin_t (
    name varchar2,
    status varchar2,
    time_last_updated_utc timestamp with time zone,
    message varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) The plugin name

status

(required) The plugin status Specified the plugin state on the instance * `RUNNING` - The plugin is in running state * `STOPPED` - The plugin is in stopped state * `NOT_SUPPORTED` - The plugin is not supported on this platform * `INVALID` - The plugin state is not recognizable by the service

Allowed values are: 'RUNNING', 'STOPPED', 'NOT_SUPPORTED', 'INVALID'

time_last_updated_utc

(required) The last update time of the plugin in UTC

message

(optional) The optional message from the agent plugin

DBMS_CLOUD_OCI_COMPUTE_INSTANCE_AGENT_INSTANCE_AGENT_PLUGIN_SUMMARY_T Type

The agent plugin information

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_compute_instance_agent_instance_agent_plugin_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  status varchar2(32767),
  time_last_updated_utc timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_plugin_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_instance_agent_plugin_summary_t (
    name varchar2,
    status varchar2,
    time_last_updated_utc timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) The plugin name

status

(required) The plugin status Specified the plugin state on the instance * `RUNNING` - The plugin is in running state * `STOPPED` - The plugin is in stopped state * `NOT_SUPPORTED` - The plugin is not supported on this platform * `INVALID` - The plugin state is not recognizable by the service

Allowed values are: 'RUNNING', 'STOPPED', 'NOT_SUPPORTED', 'INVALID'

time_last_updated_utc

(required) The last update time of the plugin in UTC

DBMS_CLOUD_OCI_COMPUTE_INSTANCE_AGENT_PLUGIN_T Type

The agent plugin

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_compute_instance_agent_plugin_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  version varchar2(32767),
  status varchar2(32767),
  last_update_time timestamp with time zone,
  message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_plugin_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_compute_instance_agent_plugin_t (
    name varchar2,
    version varchar2,
    status varchar2,
    last_update_time timestamp with time zone,
    message varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) The plugin name

version

(required) The plugin version

status

(required) The plugin status

last_update_time

(optional) The last update time of the plugin

message

(optional) The optional message from the agent plugin

Was this article helpful?