Management Agent Common Types
DBMS_CLOUD_OCI_MANAGEMENT_AGENT_VARCHAR2_TBL Type
Nested table type of varchar2(32767).
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_varchar2_tbl FORCE IS TABLE OF (varchar2(32767)) NOT PERSISTABLE;DBMS_CLOUD_OCI_MANAGEMENT_AGENT_AUTO_UPGRADABLE_CONFIG_T Type
The tenancy-level agent AutoUpgradable configuration.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_auto_upgradable_config_t FORCE AUTHID CURRENT_USER IS OBJECT (
is_agent_auto_upgradable number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_auto_upgradable_config_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_auto_upgradable_config_t (
is_agent_auto_upgradable number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) true if the agents can be upgraded automatically; false if they must be upgraded manually. |
DBMS_CLOUD_OCI_MANAGEMENT_AGENT_AVAILABILITY_HISTORY_SUMMARY_T Type
Availability history of Management Agent.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_availability_history_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
management_agent_id varchar2(32767),
availability_status varchar2(32767),
time_availability_status_started timestamp with time zone,
time_availability_status_ended timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_availability_history_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_availability_history_summary_t (
management_agent_id varchar2,
availability_status varchar2,
time_availability_status_started timestamp with time zone,
time_availability_status_ended timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) agent identifier |
|
|
(required) The availability status of managementAgent Allowed values are: 'ACTIVE', 'SILENT', 'NOT_AVAILABLE' |
|
|
(optional) The time at which the Management Agent moved to the availability status. An RFC3339 formatted datetime string |
|
|
(optional) The time till which the Management Agent was known to be in the availability status. An RFC3339 formatted datetime string |
DBMS_CLOUD_OCI_MANAGEMENT_AGENT_CREATE_MANAGEMENT_AGENT_INSTALL_KEY_DETAILS_T Type
The information about new Management Agent install Key.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_create_management_agent_install_key_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
display_name varchar2(32767),
allowed_key_install_count number,
time_expires timestamp with time zone,
compartment_id varchar2(32767),
is_unlimited number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_create_management_agent_install_key_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_create_management_agent_install_key_details_t (
display_name varchar2,
allowed_key_install_count number,
time_expires timestamp with time zone,
compartment_id varchar2,
is_unlimited number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Management Agent install Key Name |
|
|
(optional) Total number of install for this keys |
|
|
(optional) date after which key would expire after creation |
|
|
(required) Compartment Identifier |
|
|
(optional) If set to true, the install key has no expiration date or usage limit. Defaults to false |
DBMS_CLOUD_OCI_MANAGEMENT_AGENT_DEPLOY_PLUGINS_DETAILS_T Type
The information required to deploy new Management Agent Plugins.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_deploy_plugins_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
plugin_ids dbms_cloud_oci_management_agent_varchar2_tbl,
agent_compartment_id varchar2(32767),
agent_ids dbms_cloud_oci_management_agent_varchar2_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_deploy_plugins_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_deploy_plugins_details_t (
plugin_ids dbms_cloud_oci_management_agent_varchar2_tbl,
agent_compartment_id varchar2,
agent_ids dbms_cloud_oci_management_agent_varchar2_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Plugin Id |
|
|
(required) Management Agent Compartment Identifier |
|
|
(required) List of Agent identifiers |
DBMS_CLOUD_OCI_MANAGEMENT_AGENT_MANAGEMENT_AGENT_PLUGIN_DETAILS_T Type
The information about the current management agent plugins that agent is having.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_management_agent_plugin_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
plugin_id varchar2(32767),
plugin_name varchar2(32767),
plugin_display_name varchar2(32767),
plugin_version varchar2(32767),
plugin_status varchar2(32767),
plugin_status_message varchar2(32767),
is_enabled number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_plugin_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_plugin_details_t (
plugin_id varchar2,
plugin_name varchar2,
plugin_display_name varchar2,
plugin_version varchar2,
plugin_status varchar2,
plugin_status_message varchar2,
is_enabled number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) Plugin Id |
|
|
(required) Management Agent Plugin Name |
|
|
(optional) Management Agent Plugin Identifier, can be renamed |
|
|
(optional) Plugin Version |
|
|
(optional) Plugin Status Allowed values are: 'RUNNING', 'STOPPED', 'INVALID', 'FAILED' |
|
|
(optional) Status message of the Plugin |
|
|
(optional) flag indicating whether the plugin is in enabled mode or disabled mode. |
DBMS_CLOUD_OCI_MANAGEMENT_AGENT_MANAGEMENT_AGENT_PROPERTY_T Type
Property item in name/value pair, with optional unit type.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_management_agent_property_t FORCE AUTHID CURRENT_USER IS OBJECT (
name varchar2(32767),
l_values dbms_cloud_oci_management_agent_varchar2_tbl,
units varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_property_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_property_t (
name varchar2,
l_values dbms_cloud_oci_management_agent_varchar2_tbl,
units varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Name of the property |
|
|
(required) Values of the property |
|
|
(optional) Unit for the property Allowed values are: 'PERCENTAGE', 'MB' |
DBMS_CLOUD_OCI_MANAGEMENT_AGENT_MANAGEMENT_AGENT_PLUGIN_DETAILS_TBL Type
Nested table type of dbms_cloud_oci_management_agent_management_agent_plugin_details_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_management_agent_plugin_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_management_agent_management_agent_plugin_details_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_MANAGEMENT_AGENT_MANAGEMENT_AGENT_PROPERTY_TBL Type
Nested table type of dbms_cloud_oci_management_agent_management_agent_property_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_management_agent_property_tbl FORCE IS TABLE OF (dbms_cloud_oci_management_agent_management_agent_property_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_MANAGEMENT_AGENT_MANAGEMENT_AGENT_T Type
The details of the Management Agent inventory including the associated plugins.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_management_agent_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
install_key_id varchar2(32767),
display_name varchar2(32767),
platform_type varchar2(32767),
platform_name varchar2(32767),
platform_version varchar2(32767),
version varchar2(32767),
resource_artifact_version varchar2(32767),
host varchar2(32767),
host_id varchar2(32767),
install_path varchar2(32767),
plugin_list dbms_cloud_oci_management_agent_management_agent_plugin_details_tbl,
compartment_id varchar2(32767),
is_agent_auto_upgradable number,
time_created timestamp with time zone,
time_updated timestamp with time zone,
time_last_heartbeat timestamp with time zone,
availability_status varchar2(32767),
lifecycle_state varchar2(32767),
lifecycle_details varchar2(32767),
is_customer_deployed number,
install_type varchar2(32767),
management_agent_properties dbms_cloud_oci_management_agent_management_agent_property_tbl,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_t (
id varchar2,
install_key_id varchar2,
display_name varchar2,
platform_type varchar2,
platform_name varchar2,
platform_version varchar2,
version varchar2,
resource_artifact_version varchar2,
host varchar2,
host_id varchar2,
install_path varchar2,
plugin_list dbms_cloud_oci_management_agent_management_agent_plugin_details_tbl,
compartment_id varchar2,
is_agent_auto_upgradable number,
time_created timestamp with time zone,
time_updated timestamp with time zone,
time_last_heartbeat timestamp with time zone,
availability_status varchar2,
lifecycle_state varchar2,
lifecycle_details varchar2,
is_customer_deployed number,
install_type varchar2,
management_agent_properties dbms_cloud_oci_management_agent_management_agent_property_tbl,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) agent identifier |
|
|
(optional) agent install key identifier |
|
|
(optional) Management Agent Name |
|
|
(optional) Platform Type Allowed values are: 'LINUX', 'WINDOWS', 'SOLARIS', 'MACOSX' |
|
|
(optional) Platform Name |
|
|
(optional) Platform Version |
|
|
(required) Management Agent Version |
|
|
(optional) Version of the deployment artifact instantiated by this Management Agent. The format for Standalone resourceMode is YYMMDD.HHMM, and the format for other modes (whose artifacts are based upon Standalone but can advance independently) is YYMMDD.HHMM.VVVVVVVVVVVV. VVVVVVVVVVVV is always a numeric value between 000000000000 and 999999999999 |
|
|
(optional) Management Agent host machine name |
|
|
(optional) Host resource ocid |
|
|
(optional) Path where Management Agent is installed |
|
|
(optional) list of managementAgentPlugins associated with the agent |
|
|
(required) Compartment Identifier |
|
|
(optional) true if the agent can be upgraded automatically; false if it must be upgraded manually. This flag is derived from the tenancy level auto upgrade preference. |
|
|
(optional) The time the Management Agent was created. An RFC3339 formatted datetime string |
|
|
(optional) The time the Management Agent was updated. An RFC3339 formatted datetime string |
|
|
(optional) The time the Management Agent has last recorded its health status in telemetry. This value will be null if the agent has not recorded its health status in last 7 days. An RFC3339 formatted datetime string |
|
|
(optional) The current availability status of managementAgent Allowed values are: 'ACTIVE', 'SILENT', 'NOT_AVAILABLE' |
|
|
(optional) The current state of managementAgent Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'TERMINATED', 'DELETING', 'DELETED', 'FAILED' |
|
|
(optional) A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. |
|
|
(optional) true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent. |
|
|
(optional) The install type, either AGENT or GATEWAY Allowed values are: 'AGENT', 'GATEWAY' |
|
|
(optional) Additional properties for this Management Agent |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_MANAGEMENT_AGENT_MANAGEMENT_AGENT_AGGREGATION_DIMENSIONS_T Type
The Aggregation of Management Agent Dimensions
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_management_agent_aggregation_dimensions_t FORCE AUTHID CURRENT_USER IS OBJECT (
availability_status varchar2(32767),
platform_type varchar2(32767),
version varchar2(32767),
has_plugins number,
install_type varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_aggregation_dimensions_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_aggregation_dimensions_t (
availability_status varchar2,
platform_type varchar2,
version varchar2,
has_plugins number,
install_type varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The availability status of managementAgent Allowed values are: 'ACTIVE', 'SILENT', 'NOT_AVAILABLE' |
|
|
(optional) Platform Type Allowed values are: 'LINUX', 'WINDOWS', 'SOLARIS', 'MACOSX' |
|
|
(optional) Agent image version |
|
|
(optional) Whether or not a managementAgent has at least one plugin |
|
|
(optional) The install type, either AGENT or GATEWAY Allowed values are: 'AGENT', 'GATEWAY' |
DBMS_CLOUD_OCI_MANAGEMENT_AGENT_MANAGEMENT_AGENT_AGGREGATION_T Type
A count of Management Agents sharing the values for specified dimensions.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_management_agent_aggregation_t FORCE AUTHID CURRENT_USER IS OBJECT (
dimensions dbms_cloud_oci_management_agent_management_agent_aggregation_dimensions_t,
l_count number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_aggregation_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_aggregation_t (
dimensions dbms_cloud_oci_management_agent_management_agent_aggregation_dimensions_t,
l_count number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) |
|
|
(optional) The number of Management Agents in this group |
DBMS_CLOUD_OCI_MANAGEMENT_AGENT_MANAGEMENT_AGENT_AGGREGATION_TBL Type
Nested table type of dbms_cloud_oci_management_agent_management_agent_aggregation_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_management_agent_aggregation_tbl FORCE IS TABLE OF (dbms_cloud_oci_management_agent_management_agent_aggregation_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_MANAGEMENT_AGENT_MANAGEMENT_AGENT_AGGREGATION_COLLECTION_T Type
The summary of Management Agent count items
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_management_agent_aggregation_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_management_agent_management_agent_aggregation_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_aggregation_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_aggregation_collection_t (
items dbms_cloud_oci_management_agent_management_agent_aggregation_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) List in which each item describes an aggregation of Managment Agents |
DBMS_CLOUD_OCI_MANAGEMENT_AGENT_MANAGEMENT_AGENT_ERROR_T Type
Error Information.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_management_agent_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
code varchar2(32767),
message varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_error_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_error_t (
code varchar2,
message varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) A short error code that defines the error, meant for programmatic parsing. |
|
|
(required) A human-readable error string. |
DBMS_CLOUD_OCI_MANAGEMENT_AGENT_OBJECT_DETAILS_T Type
Details of the Objectstorage object
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_object_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
object_namespace varchar2(32767),
object_bucket varchar2(32767),
object_name varchar2(32767),
object_url varchar2(32767),
checksum varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_object_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_object_details_t (
object_namespace varchar2,
object_bucket varchar2,
object_name varchar2,
object_url varchar2,
checksum varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Objectstorage namespace reference providing the original location of this object |
|
|
(required) Objectstorage bucket reference providing the original location of this object |
|
|
(required) Objectstorage object name reference providing the original location of this object |
|
|
(optional) Object storage URL for download |
|
|
(optional) Object content SHA256 Hash |
DBMS_CLOUD_OCI_MANAGEMENT_AGENT_MANAGEMENT_AGENT_IMAGE_T Type
Supported Agent downloads
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_management_agent_image_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
platform_type varchar2(32767),
platform_name varchar2(32767),
package_type varchar2(32767),
package_architecture_type varchar2(32767),
version varchar2(32767),
l_size number,
checksum varchar2(32767),
object_url varchar2(32767),
image_object_storage_details dbms_cloud_oci_management_agent_object_details_t,
lifecycle_state varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_image_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_image_t (
id varchar2,
platform_type varchar2,
platform_name varchar2,
package_type varchar2,
package_architecture_type varchar2,
version varchar2,
l_size number,
checksum varchar2,
object_url varchar2,
image_object_storage_details dbms_cloud_oci_management_agent_object_details_t,
lifecycle_state varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Agent image resource id |
|
|
(required) Agent image platform type Allowed values are: 'LINUX', 'WINDOWS', 'SOLARIS', 'MACOSX' |
|
|
(optional) Agent image platform display name |
|
|
(optional) The installation package type Allowed values are: 'RPM', 'ZIP' |
|
|
(optional) The installation package target architecture type Allowed values are: 'X86_64', 'SPARC', 'X86', 'M1' |
|
|
(required) Agent image version |
|
|
(optional) Agent image size in bytes |
|
|
(optional) Agent image content SHA256 Hash |
|
|
(optional) Object storage URL for download |
|
|
(optional) |
|
|
(optional) The current state of Management Agent Image Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'TERMINATED', 'DELETING', 'DELETED', 'FAILED' |
DBMS_CLOUD_OCI_MANAGEMENT_AGENT_MANAGEMENT_AGENT_IMAGE_SUMMARY_T Type
Supported Agent downloads
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_management_agent_image_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
platform_type varchar2(32767),
platform_name varchar2(32767),
package_type varchar2(32767),
package_architecture_type varchar2(32767),
version varchar2(32767),
l_size number,
checksum varchar2(32767),
object_url varchar2(32767),
image_object_storage_details dbms_cloud_oci_management_agent_object_details_t,
lifecycle_state varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_image_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_image_summary_t (
id varchar2,
platform_type varchar2,
platform_name varchar2,
package_type varchar2,
package_architecture_type varchar2,
version varchar2,
l_size number,
checksum varchar2,
object_url varchar2,
image_object_storage_details dbms_cloud_oci_management_agent_object_details_t,
lifecycle_state varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Agent image resource id |
|
|
(required) Agent image platform type Allowed values are: 'LINUX', 'WINDOWS', 'SOLARIS', 'MACOSX' |
|
|
(optional) Agent image platform display name |
|
|
(optional) The installation package type Allowed values are: 'RPM', 'ZIP' |
|
|
(optional) The installation package target architecture type Allowed values are: 'X86_64', 'SPARC', 'X86', 'M1' |
|
|
(required) Agent image version |
|
|
(optional) Agent image size in bytes |
|
|
(optional) Agent image content SHA256 Hash |
|
|
(optional) Object storage URL for download |
|
|
(optional) |
|
|
(optional) The current state of Management Agent Image Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'TERMINATED', 'DELETING', 'DELETED', 'FAILED' |
DBMS_CLOUD_OCI_MANAGEMENT_AGENT_MANAGEMENT_AGENT_INSTALL_KEY_T Type
The details of the Agent install Key
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_management_agent_install_key_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
display_name varchar2(32767),
key varchar2(32767),
created_by_principal_id varchar2(32767),
compartment_id varchar2(32767),
allowed_key_install_count number,
current_key_install_count number,
lifecycle_state varchar2(32767),
lifecycle_details varchar2(32767),
time_expires timestamp with time zone,
time_created timestamp with time zone,
time_updated timestamp with time zone,
is_unlimited number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_install_key_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_install_key_t (
id varchar2,
display_name varchar2,
key varchar2,
created_by_principal_id varchar2,
compartment_id varchar2,
allowed_key_install_count number,
current_key_install_count number,
lifecycle_state varchar2,
lifecycle_details varchar2,
time_expires timestamp with time zone,
time_created timestamp with time zone,
time_updated timestamp with time zone,
is_unlimited number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Agent install Key identifier |
|
|
(optional) Management Agent Install Key Name |
|
|
(optional) Management Agent Install Key |
|
|
(optional) Principal id of user who created the Agent Install key |
|
|
(required) Compartment Identifier |
|
|
(optional) Total number of install for this keys |
|
|
(optional) Total number of install for this keys |
|
|
(optional) Status of Key Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'TERMINATED', 'DELETING', 'DELETED', 'FAILED' |
|
|
(optional) A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. |
|
|
(optional) date after which key would expire after creation |
|
|
(optional) The time when Management Agent install Key was created. An RFC3339 formatted date time string |
|
|
(optional) The time when Management Agent install Key was updated. An RFC3339 formatted date time string |
|
|
(optional) If set to true, the install key has no expiration date or usage limit. Defaults to false |
DBMS_CLOUD_OCI_MANAGEMENT_AGENT_MANAGEMENT_AGENT_INSTALL_KEY_SUMMARY_T Type
The summary of the Agent Install Key details.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_management_agent_install_key_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
display_name varchar2(32767),
created_by_principal_id varchar2(32767),
allowed_key_install_count number,
current_key_install_count number,
lifecycle_state varchar2(32767),
lifecycle_details varchar2(32767),
time_created timestamp with time zone,
time_expires timestamp with time zone,
compartment_id varchar2(32767),
is_unlimited number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_install_key_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_install_key_summary_t (
id varchar2,
display_name varchar2,
created_by_principal_id varchar2,
allowed_key_install_count number,
current_key_install_count number,
lifecycle_state varchar2,
lifecycle_details varchar2,
time_created timestamp with time zone,
time_expires timestamp with time zone,
compartment_id varchar2,
is_unlimited number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Agent Install Key identifier |
|
|
(optional) Management Agent Install Key Name |
|
|
(optional) Principal id of user who created the Agent Install key |
|
|
(optional) Total number of install for this keys |
|
|
(optional) Total number of install for this keys |
|
|
(optional) Status of Key Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'TERMINATED', 'DELETING', 'DELETED', 'FAILED' |
|
|
(optional) A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. |
|
|
(optional) The time when Management Agent install Key was created. An RFC3339 formatted date time string |
|
|
(optional) date after which key would expire after creation |
|
|
(required) Compartment Identifier |
|
|
(optional) If set to true, the install key has no expiration date or usage limit. Properties allowedKeyInstallCount and timeExpires are ignored if set to true. Defaults to false. |
DBMS_CLOUD_OCI_MANAGEMENT_AGENT_MANAGEMENT_AGENT_PLUGIN_T Type
Summary of the ManagementAgentPlugin.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_management_agent_plugin_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
name varchar2(32767),
version number,
supported_platform_types dbms_cloud_oci_management_agent_varchar2_tbl,
display_name varchar2(32767),
description varchar2(32767),
is_console_deployable number,
lifecycle_state varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_plugin_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_plugin_t (
id varchar2,
name varchar2,
version number,
supported_platform_types dbms_cloud_oci_management_agent_varchar2_tbl,
display_name varchar2,
description varchar2,
is_console_deployable number,
lifecycle_state varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Management Agent Plugin Id |
|
|
(required) Management Agent Plugin Name |
|
|
(optional) Management Agent Plugin Version |
|
|
(optional) Supported Platform Types Allowed values are: 'LINUX', 'WINDOWS', 'SOLARIS', 'MACOSX' |
|
|
(optional) Management Agent Plugin Display Name |
|
|
(optional) Management Agent Plugin description |
|
|
(optional) A flag to indicate whether a given plugin can be deployed from Agent Console UI or not. |
|
|
(required) The current state of Management Agent Plugin Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'TERMINATED', 'DELETING', 'DELETED', 'FAILED' |
DBMS_CLOUD_OCI_MANAGEMENT_AGENT_MANAGEMENT_AGENT_PLUGIN_AGGREGATION_DIMENSIONS_T Type
The Aggregation of Management Agent Plugin Dimensions
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_management_agent_plugin_aggregation_dimensions_t FORCE AUTHID CURRENT_USER IS OBJECT (
plugin_name varchar2(32767),
plugin_display_name varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_plugin_aggregation_dimensions_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_plugin_aggregation_dimensions_t (
plugin_name varchar2,
plugin_display_name varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) Management Agent Plugin Name |
|
|
(optional) Management Agent Plugin Display Name |
DBMS_CLOUD_OCI_MANAGEMENT_AGENT_MANAGEMENT_AGENT_PLUGIN_AGGREGATION_T Type
A count of Management Agents Plugins sharing the values for specified dimensions.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_management_agent_plugin_aggregation_t FORCE AUTHID CURRENT_USER IS OBJECT (
dimensions dbms_cloud_oci_management_agent_management_agent_plugin_aggregation_dimensions_t,
l_count number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_plugin_aggregation_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_plugin_aggregation_t (
dimensions dbms_cloud_oci_management_agent_management_agent_plugin_aggregation_dimensions_t,
l_count number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) |
|
|
(optional) The number of Management Agent Plugins in this group |
DBMS_CLOUD_OCI_MANAGEMENT_AGENT_MANAGEMENT_AGENT_PLUGIN_AGGREGATION_TBL Type
Nested table type of dbms_cloud_oci_management_agent_management_agent_plugin_aggregation_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_management_agent_plugin_aggregation_tbl FORCE IS TABLE OF (dbms_cloud_oci_management_agent_management_agent_plugin_aggregation_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_MANAGEMENT_AGENT_MANAGEMENT_AGENT_PLUGIN_AGGREGATION_COLLECTION_T Type
The summary of Management Agent Plugin count items
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_management_agent_plugin_aggregation_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_management_agent_management_agent_plugin_aggregation_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_plugin_aggregation_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_plugin_aggregation_collection_t (
items dbms_cloud_oci_management_agent_management_agent_plugin_aggregation_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) List in which each item describes an aggregation of Managment Agent Plugins |
DBMS_CLOUD_OCI_MANAGEMENT_AGENT_MANAGEMENT_AGENT_PLUGIN_SUMMARY_T Type
Summary of the ManagementAgentPlugin.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_management_agent_plugin_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
name varchar2(32767),
version number,
supported_platform_types dbms_cloud_oci_management_agent_varchar2_tbl,
display_name varchar2(32767),
description varchar2(32767),
is_console_deployable number,
lifecycle_state varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_plugin_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_plugin_summary_t (
id varchar2,
name varchar2,
version number,
supported_platform_types dbms_cloud_oci_management_agent_varchar2_tbl,
display_name varchar2,
description varchar2,
is_console_deployable number,
lifecycle_state varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Management Agent Plugin Id |
|
|
(required) Management Agent Plugin Name |
|
|
(optional) Management Agent Plugin Version |
|
|
(optional) Supported Platform Types Allowed values are: 'LINUX', 'WINDOWS', 'SOLARIS', 'MACOSX' |
|
|
(optional) Management Agent Plugin Display Name |
|
|
(optional) Management Agent Plugin description |
|
|
(optional) A flag to indicate whether a given plugin can be deployed from Agent Console UI or not. |
|
|
(required) The current state of Management Agent Plugin Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'TERMINATED', 'DELETING', 'DELETED', 'FAILED' |
DBMS_CLOUD_OCI_MANAGEMENT_AGENT_MANAGEMENT_AGENT_SUMMARY_T Type
The summary of the Management Agent inventory including the associated plugins.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_management_agent_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
install_key_id varchar2(32767),
display_name varchar2(32767),
platform_type varchar2(32767),
platform_name varchar2(32767),
platform_version varchar2(32767),
version varchar2(32767),
resource_artifact_version varchar2(32767),
is_agent_auto_upgradable number,
time_created timestamp with time zone,
time_updated timestamp with time zone,
host varchar2(32767),
host_id varchar2(32767),
plugin_list dbms_cloud_oci_management_agent_management_agent_plugin_details_tbl,
compartment_id varchar2(32767),
time_last_heartbeat timestamp with time zone,
availability_status varchar2(32767),
lifecycle_state varchar2(32767),
lifecycle_details varchar2(32767),
is_customer_deployed number,
install_type varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_management_agent_summary_t (
id varchar2,
install_key_id varchar2,
display_name varchar2,
platform_type varchar2,
platform_name varchar2,
platform_version varchar2,
version varchar2,
resource_artifact_version varchar2,
is_agent_auto_upgradable number,
time_created timestamp with time zone,
time_updated timestamp with time zone,
host varchar2,
host_id varchar2,
plugin_list dbms_cloud_oci_management_agent_management_agent_plugin_details_tbl,
compartment_id varchar2,
time_last_heartbeat timestamp with time zone,
availability_status varchar2,
lifecycle_state varchar2,
lifecycle_details varchar2,
is_customer_deployed number,
install_type varchar2,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) agent identifier |
|
|
(optional) agent install key identifier |
|
|
(optional) Management Agent Name |
|
|
(optional) Platform Type Allowed values are: 'LINUX', 'WINDOWS', 'SOLARIS', 'MACOSX' |
|
|
(optional) Platform Name |
|
|
(optional) Platform Version |
|
|
(required) Management Agent Version |
|
|
(optional) Version of the deployment artifact instantiated by this Management Agent. The format for Standalone resourceMode is YYMMDD.HHMM, and the format for other modes (whose artifacts are based upon Standalone but can advance independently) is YYMMDD.HHMM.VVVVVVVVVVVV. VVVVVVVVVVVV is always a numeric value between 000000000000 and 999999999999 |
|
|
(optional) true if the agent can be upgraded automatically; false if it must be upgraded manually. This flag is derived from the tenancy level auto upgrade preference. |
|
|
(optional) The time the Management Agent was created. An RFC3339 formatted datetime string |
|
|
(optional) The time the Management Agent was last updated. An RFC3339 formatted datetime string |
|
|
(optional) Management Agent host machine name |
|
|
(optional) Host resource ocid |
|
|
(optional) list of managementAgentPlugins associated with the agent |
|
|
(required) Compartment Identifier |
|
|
(optional) The time the Management Agent has last recorded its heartbeat. An RFC3339 formatted datetime string |
|
|
(optional) The current availability status of managementAgent Allowed values are: 'ACTIVE', 'SILENT', 'NOT_AVAILABLE' |
|
|
(optional) The current state of managementAgent Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'TERMINATED', 'DELETING', 'DELETED', 'FAILED' |
|
|
(optional) A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. |
|
|
(optional) true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent. |
|
|
(optional) The install type, either AGENT or GATEWAY Allowed values are: 'AGENT', 'GATEWAY' |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_MANAGEMENT_AGENT_SET_AUTO_UPGRADABLE_CONFIG_DETAILS_T Type
Details for configuring tenancy-level agent AutoUpgradable configuration.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_set_auto_upgradable_config_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
compartment_id varchar2(32767),
is_agent_auto_upgradable number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_set_auto_upgradable_config_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_set_auto_upgradable_config_details_t (
compartment_id varchar2,
is_agent_auto_upgradable number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Tenancy identifier i.e, Root compartment identifier |
|
|
(required) true if the agents can be upgraded automatically; false if they must be upgraded manually. |
DBMS_CLOUD_OCI_MANAGEMENT_AGENT_UPDATE_MANAGEMENT_AGENT_DETAILS_T Type
Details required to update console-managed properties of the Management Agent.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_update_management_agent_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
display_name varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_update_management_agent_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_update_management_agent_details_t (
display_name varchar2,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) New displayName of Agent. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_MANAGEMENT_AGENT_UPDATE_MANAGEMENT_AGENT_INSTALL_KEY_DETAILS_T Type
Details required to change Management Agent install key.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_update_management_agent_install_key_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
is_key_active number,
display_name varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_update_management_agent_install_key_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_update_management_agent_install_key_details_t (
is_key_active number,
display_name varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) if set to true the install key state would be set to Active and if false to Inactive |
|
|
(optional) New displayName of Agent install key. |
DBMS_CLOUD_OCI_MANAGEMENT_AGENT_WORK_REQUEST_RESOURCE_T Type
A resource created or operated on by a work request.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_work_request_resource_t FORCE AUTHID CURRENT_USER IS OBJECT (
entity_type varchar2(32767),
action_type varchar2(32767),
identifier varchar2(32767),
source_id varchar2(32767),
source_name varchar2(32767),
source_version varchar2(32767),
entity_uri varchar2(32767),
time_accepted timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone,
metadata json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_work_request_resource_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_work_request_resource_t (
entity_type varchar2,
action_type varchar2,
identifier varchar2,
source_id varchar2,
source_name varchar2,
source_version varchar2,
entity_uri varchar2,
time_accepted timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone,
metadata json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The resource type the work request affects. |
|
|
(required) The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively. Allowed values are: 'CREATED', 'UPDATED', 'DELETED', 'IN_PROGRESS', 'RELATED' |
|
|
(required) The identifier of the resource the work request affects. |
|
|
(optional) The identifier of the source the work request is requesting. |
|
|
(optional) The name of the source the work request is requesting. |
|
|
(optional) The version of the source the work request is requesting. |
|
|
(optional) The URI path that the user can do a GET on to access the resource metadata |
|
|
(optional) The date and time the request was created, as described in RFC 3339, section 5.6. |
|
|
(optional) The date and time the request was started, as described in RFC 3339, section 5.6. |
|
|
(optional) The date and time the request was finished, as described in RFC 3339, section 5.6. |
|
|
(optional) Additional metadata about the resource that has been operated upon by this work request. For WorkRequests operationType WORK_DELIVERY the metadata will contain: workDeliveryStatus indicating the status of the work delivery item as a WorkDeliveryStatus value, workSubmissionKey the WorkSubmission request id, and workSubmissionDetails containing any details of result |
DBMS_CLOUD_OCI_MANAGEMENT_AGENT_WORK_REQUEST_RESOURCE_TBL Type
Nested table type of dbms_cloud_oci_management_agent_work_request_resource_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_work_request_resource_tbl FORCE IS TABLE OF (dbms_cloud_oci_management_agent_work_request_resource_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_MANAGEMENT_AGENT_WORK_REQUEST_T Type
A description of workrequest status
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_work_request_t FORCE AUTHID CURRENT_USER IS OBJECT (
operation_type varchar2(32767),
status varchar2(32767),
id varchar2(32767),
compartment_id varchar2(32767),
resources dbms_cloud_oci_management_agent_work_request_resource_tbl,
percent_complete number,
time_accepted timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_work_request_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_work_request_t (
operation_type varchar2,
status varchar2,
id varchar2,
compartment_id varchar2,
resources dbms_cloud_oci_management_agent_work_request_resource_tbl,
percent_complete number,
time_accepted timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Type of the work request Allowed values are: 'DEPLOY_PLUGIN', 'UPGRADE_PLUGIN', 'CREATE_UPGRADE_PLUGINS', 'AGENTIMAGE_UPGRADE' |
|
|
(required) Status of current work request. Allowed values are: 'CREATED', 'ACCEPTED', 'IN_PROGRESS', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED' |
|
|
(required) The id of the work request. |
|
|
(required) The ocid of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used |
|
|
(required) The resources affected by this work request. |
|
|
(required) Percentage of the request completed. |
|
|
(required) The date and time the request was created, as described in RFC 3339, section 5.6. |
|
|
(optional) The date and time the request was started, as described in RFC 3339, section 5.6. |
|
|
(optional) The date and time the object was finished, as described in RFC 3339. |
DBMS_CLOUD_OCI_MANAGEMENT_AGENT_WORK_REQUEST_ERROR_T Type
An error encountered while executing a work request.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_work_request_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
code varchar2(32767),
message varchar2(32767),
l_timestamp timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_work_request_error_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_work_request_error_t (
code varchar2,
message varchar2,
l_timestamp timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) A machine-usable code for the error that occured. Error codes are listed on (https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm) |
|
|
(required) A human readable description of the issue encountered. |
|
|
(required) The time the error occured. An RFC3339 formatted datetime string. |
DBMS_CLOUD_OCI_MANAGEMENT_AGENT_WORK_REQUEST_LOG_ENTRY_T Type
A log message from the execution of a work request.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_work_request_log_entry_t FORCE AUTHID CURRENT_USER IS OBJECT (
message varchar2(32767),
l_timestamp timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_work_request_log_entry_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_work_request_log_entry_t (
message varchar2,
l_timestamp timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Human-readable log message. |
|
|
(required) The time the log message was written. An RFC3339 formatted datetime string |
DBMS_CLOUD_OCI_MANAGEMENT_AGENT_WORK_REQUEST_SUMMARY_T Type
A description of workrequest status
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_work_request_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
operation_type varchar2(32767),
status varchar2(32767),
id varchar2(32767),
compartment_id varchar2(32767),
resources dbms_cloud_oci_management_agent_work_request_resource_tbl,
percent_complete number,
time_accepted timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_work_request_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_work_request_summary_t (
operation_type varchar2,
status varchar2,
id varchar2,
compartment_id varchar2,
resources dbms_cloud_oci_management_agent_work_request_resource_tbl,
percent_complete number,
time_accepted timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Type of the work request Allowed values are: 'DEPLOY_PLUGIN', 'UPGRADE_PLUGIN', 'CREATE_UPGRADE_PLUGINS', 'AGENTIMAGE_UPGRADE' |
|
|
(required) Status of current work request. Allowed values are: 'CREATED', 'ACCEPTED', 'IN_PROGRESS', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED' |
|
|
(required) The id of the work request. |
|
|
(required) The ocid of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used |
|
|
(optional) The resources affected by this work request. |
|
|
(required) Percentage of the request completed. |
|
|
(required) The date and time the request was created, as described in RFC 3339, section 5.6. |
|
|
(optional) The date and time the request was started, as described in RFC 3339, section 5.6. |
|
|
(optional) The date and time the object was finished, as described in RFC 3339. |
DBMS_CLOUD_OCI_MANAGEMENT_AGENT_WORK_SUBMISSION_KEY_T Type
Work Submission Identifier
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_agent_work_submission_key_t FORCE AUTHID CURRENT_USER IS OBJECT (
work_submission_key varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_work_submission_key_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_management_agent_work_submission_key_t (
work_submission_key varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Work Submission Identifier |