Agent¶

class oci.cloud_bridge.models.Agent(**kwargs)¶

Bases: object

Description of Agent.

Attributes

`AGENT_TYPE_APPLIANCE`	A constant which can be used with the agent_type property of a Agent.
`HEART_BEAT_STATUS_FAILED`	A constant which can be used with the heart_beat_status property of a Agent.
`HEART_BEAT_STATUS_HEALTHY`	A constant which can be used with the heart_beat_status property of a Agent.
`HEART_BEAT_STATUS_INACTIVE`	A constant which can be used with the heart_beat_status property of a Agent.
`HEART_BEAT_STATUS_UNHEALTHY`	A constant which can be used with the heart_beat_status property of a Agent.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a Agent.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a Agent.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a Agent.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a Agent.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a Agent.
`agent_pub_key`	Gets the agent_pub_key of this Agent.
`agent_type`	[Required] Gets the agent_type of this Agent.
`agent_version`	[Required] Gets the agent_version of this Agent.
`compartment_id`	[Required] Gets the compartment_id of this Agent.
`defined_tags`	[Required] Gets the defined_tags of this Agent.
`display_name`	[Required] Gets the display_name of this Agent.
`environment_id`	[Required] Gets the environment_id of this Agent.
`freeform_tags`	[Required] Gets the freeform_tags of this Agent.
`heart_beat_status`	Gets the heart_beat_status of this Agent.
`id`	[Required] Gets the id of this Agent.
`lifecycle_details`	Gets the lifecycle_details of this Agent.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Agent.
`os_version`	[Required] Gets the os_version of this Agent.
`plugin_list`	Gets the plugin_list of this Agent.
`system_tags`	Gets the system_tags of this Agent.
`time_created`	[Required] Gets the time_created of this Agent.
`time_expire_agent_key_in_ms`	Gets the time_expire_agent_key_in_ms of this Agent.
`time_last_sync_received`	Gets the time_last_sync_received of this Agent.
`time_updated`	Gets the time_updated of this Agent.

Methods

__init__(**kwargs) Initializes a new Agent object with values from keyword arguments.

AGENT_TYPE_APPLIANCE = 'APPLIANCE'¶: A constant which can be used with the agent_type property of a Agent. This constant has a value of “APPLIANCE”

HEART_BEAT_STATUS_FAILED = 'FAILED'¶: A constant which can be used with the heart_beat_status property of a Agent. This constant has a value of “FAILED”

HEART_BEAT_STATUS_HEALTHY = 'HEALTHY'¶: A constant which can be used with the heart_beat_status property of a Agent. This constant has a value of “HEALTHY”

HEART_BEAT_STATUS_INACTIVE = 'INACTIVE'¶: A constant which can be used with the heart_beat_status property of a Agent. This constant has a value of “INACTIVE”

HEART_BEAT_STATUS_UNHEALTHY = 'UNHEALTHY'¶: A constant which can be used with the heart_beat_status property of a Agent. This constant has a value of “UNHEALTHY”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a Agent. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a Agent. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a Agent. This constant has a value of “DELETED”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a Agent. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a Agent. This constant has a value of “INACTIVE”

__init__(**kwargs)¶

Initializes a new Agent object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this Agent.
display_name (str) – The value to assign to the display_name property of this Agent.
compartment_id (str) – The value to assign to the compartment_id property of this Agent.
agent_type (str) – The value to assign to the agent_type property of this Agent. Allowed values for this property are: “APPLIANCE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
agent_version (str) – The value to assign to the agent_version property of this Agent.
os_version (str) – The value to assign to the os_version property of this Agent.
time_created (datetime) – The value to assign to the time_created property of this Agent.
time_updated (datetime) – The value to assign to the time_updated property of this Agent.
time_last_sync_received (datetime) – The value to assign to the time_last_sync_received property of this Agent.
heart_beat_status (str) – The value to assign to the heart_beat_status property of this Agent. Allowed values for this property are: “HEALTHY”, “UNHEALTHY”, “FAILED”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
environment_id (str) – The value to assign to the environment_id property of this Agent.
agent_pub_key (str) – The value to assign to the agent_pub_key property of this Agent.
time_expire_agent_key_in_ms (datetime) – The value to assign to the time_expire_agent_key_in_ms property of this Agent.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Agent. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this Agent.
plugin_list (list[oci.cloud_bridge.models.PluginSummary]) – The value to assign to the plugin_list property of this Agent.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Agent.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Agent.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Agent.

agent_pub_key¶

Gets the agent_pub_key of this Agent. Resource principal public key.

Returns:	The agent_pub_key of this Agent.
Return type:	str

agent_type¶

[Required] Gets the agent_type of this Agent. Type of the Agent.

Allowed values for this property are: “APPLIANCE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The agent_type of this Agent.
Return type:	str

agent_version¶

[Required] Gets the agent_version of this Agent. Agent identifier.

Returns:	The agent_version of this Agent.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this Agent. Compartment identifier.

Returns:	The compartment_id of this Agent.
Return type:	str

defined_tags¶

[Required] Gets the defined_tags of this Agent. The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this Agent.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this Agent. Agent identifier, can be renamed.

Returns:	The display_name of this Agent.
Return type:	str

environment_id¶

[Required] Gets the environment_id of this Agent. Environment identifier.

Returns:	The environment_id of this Agent.
Return type:	str

freeform_tags¶

[Required] Gets the freeform_tags of this Agent. The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {“Department”: “Finance”}

Returns:	The freeform_tags of this Agent.
Return type:	dict(str, str)

heart_beat_status¶

Gets the heart_beat_status of this Agent. The current heartbeat status of the Agent based on its timeLastSyncReceived value.

Allowed values for this property are: “HEALTHY”, “UNHEALTHY”, “FAILED”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The heart_beat_status of this Agent.
Return type:	str

id¶

[Required] Gets the id of this Agent. Unique identifier that is immutable on creation.

Returns:	The id of this Agent.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this Agent. A message describing the current state of the Agent in more detail. For example, it can be used to provide actionable information for a resource in Failed state.

Returns:	The lifecycle_details of this Agent.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this Agent. The current state of the Agent.

Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this Agent.
Return type:	str

os_version¶

[Required] Gets the os_version of this Agent. OS version.

Returns:	The os_version of this Agent.
Return type:	str

plugin_list¶

Gets the plugin_list of this Agent. List of plugins associated with the agent.

Returns:	The plugin_list of this Agent.
Return type:	list[oci.cloud_bridge.models.PluginSummary]

system_tags¶

Gets the system_tags of this Agent. The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

Returns:	The system_tags of this Agent.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this Agent. The time when the Agent was created. An RFC3339 formatted datetime string.

Returns:	The time_created of this Agent.
Return type:	datetime

time_expire_agent_key_in_ms¶

Gets the time_expire_agent_key_in_ms of this Agent. The time since epoch for when the public key will expire. An RFC3339 formatted datetime string.

Returns:	The time_expire_agent_key_in_ms of this Agent.
Return type:	datetime

time_last_sync_received¶

Gets the time_last_sync_received of this Agent. The time when the last heartbeat of the Agent was noted. An RFC3339 formatted datetime string.

Returns:	The time_last_sync_received of this Agent.
Return type:	datetime

time_updated¶

Gets the time_updated of this Agent. The time when the Agent was updated. An RFC3339 formatted datetime string.

Returns:	The time_updated of this Agent.
Return type:	datetime