ManagementAgent¶

class oci.management_agent.models.ManagementAgent(**kwargs)¶

Bases: object

The details of the Management Agent inventory including the associated plugins.

Attributes

`AVAILABILITY_STATUS_ACTIVE`	A constant which can be used with the availability_status property of a ManagementAgent.
`AVAILABILITY_STATUS_NOT_AVAILABLE`	A constant which can be used with the availability_status property of a ManagementAgent.
`AVAILABILITY_STATUS_SILENT`	A constant which can be used with the availability_status property of a ManagementAgent.
`INSTALL_TYPE_AGENT`	A constant which can be used with the install_type property of a ManagementAgent.
`INSTALL_TYPE_GATEWAY`	A constant which can be used with the install_type property of a ManagementAgent.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ManagementAgent.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a ManagementAgent.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ManagementAgent.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a ManagementAgent.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a ManagementAgent.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a ManagementAgent.
`LIFECYCLE_STATE_TERMINATED`	A constant which can be used with the lifecycle_state property of a ManagementAgent.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a ManagementAgent.
`PLATFORM_TYPE_LINUX`	A constant which can be used with the platform_type property of a ManagementAgent.
`PLATFORM_TYPE_MACOSX`	A constant which can be used with the platform_type property of a ManagementAgent.
`PLATFORM_TYPE_SOLARIS`	A constant which can be used with the platform_type property of a ManagementAgent.
`PLATFORM_TYPE_WINDOWS`	A constant which can be used with the platform_type property of a ManagementAgent.
`availability_status`	Gets the availability_status of this ManagementAgent.
`compartment_id`	[Required] Gets the compartment_id of this ManagementAgent.
`data_source_list`	Gets the data_source_list of this ManagementAgent.
`defined_tags`	Gets the defined_tags of this ManagementAgent.
`display_name`	Gets the display_name of this ManagementAgent.
`freeform_tags`	Gets the freeform_tags of this ManagementAgent.
`host`	Gets the host of this ManagementAgent.
`host_id`	Gets the host_id of this ManagementAgent.
`id`	[Required] Gets the id of this ManagementAgent.
`install_key_id`	Gets the install_key_id of this ManagementAgent.
`install_path`	Gets the install_path of this ManagementAgent.
`install_type`	Gets the install_type of this ManagementAgent.
`is_agent_auto_upgradable`	Gets the is_agent_auto_upgradable of this ManagementAgent.
`is_customer_deployed`	Gets the is_customer_deployed of this ManagementAgent.
`lifecycle_details`	Gets the lifecycle_details of this ManagementAgent.
`lifecycle_state`	Gets the lifecycle_state of this ManagementAgent.
`management_agent_properties`	Gets the management_agent_properties of this ManagementAgent.
`platform_name`	Gets the platform_name of this ManagementAgent.
`platform_type`	Gets the platform_type of this ManagementAgent.
`platform_version`	Gets the platform_version of this ManagementAgent.
`plugin_list`	Gets the plugin_list of this ManagementAgent.
`resource_artifact_version`	Gets the resource_artifact_version of this ManagementAgent.
`time_created`	Gets the time_created of this ManagementAgent.
`time_last_heartbeat`	Gets the time_last_heartbeat of this ManagementAgent.
`time_updated`	Gets the time_updated of this ManagementAgent.
`version`	[Required] Gets the version of this ManagementAgent.

Methods

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

AVAILABILITY_STATUS_ACTIVE = 'ACTIVE'¶: A constant which can be used with the availability_status property of a ManagementAgent. This constant has a value of “ACTIVE”

AVAILABILITY_STATUS_NOT_AVAILABLE = 'NOT_AVAILABLE'¶: A constant which can be used with the availability_status property of a ManagementAgent. This constant has a value of “NOT_AVAILABLE”

AVAILABILITY_STATUS_SILENT = 'SILENT'¶: A constant which can be used with the availability_status property of a ManagementAgent. This constant has a value of “SILENT”

INSTALL_TYPE_AGENT = 'AGENT'¶: A constant which can be used with the install_type property of a ManagementAgent. This constant has a value of “AGENT”

INSTALL_TYPE_GATEWAY = 'GATEWAY'¶: A constant which can be used with the install_type property of a ManagementAgent. This constant has a value of “GATEWAY”

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

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

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

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a ManagementAgent. This constant has a value of “DELETING”

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

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

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'¶: A constant which can be used with the lifecycle_state property of a ManagementAgent. This constant has a value of “TERMINATED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a ManagementAgent. This constant has a value of “UPDATING”

PLATFORM_TYPE_LINUX = 'LINUX'¶: A constant which can be used with the platform_type property of a ManagementAgent. This constant has a value of “LINUX”

PLATFORM_TYPE_MACOSX = 'MACOSX'¶: A constant which can be used with the platform_type property of a ManagementAgent. This constant has a value of “MACOSX”

PLATFORM_TYPE_SOLARIS = 'SOLARIS'¶: A constant which can be used with the platform_type property of a ManagementAgent. This constant has a value of “SOLARIS”

PLATFORM_TYPE_WINDOWS = 'WINDOWS'¶: A constant which can be used with the platform_type property of a ManagementAgent. This constant has a value of “WINDOWS”

__init__(**kwargs)¶

Initializes a new ManagementAgent 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 ManagementAgent.
install_key_id (str) – The value to assign to the install_key_id property of this ManagementAgent.
display_name (str) – The value to assign to the display_name property of this ManagementAgent.
platform_type (str) – The value to assign to the platform_type property of this ManagementAgent. Allowed values for this property are: “LINUX”, “WINDOWS”, “SOLARIS”, “MACOSX”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
platform_name (str) – The value to assign to the platform_name property of this ManagementAgent.
platform_version (str) – The value to assign to the platform_version property of this ManagementAgent.
version (str) – The value to assign to the version property of this ManagementAgent.
resource_artifact_version (str) – The value to assign to the resource_artifact_version property of this ManagementAgent.
host (str) – The value to assign to the host property of this ManagementAgent.
host_id (str) – The value to assign to the host_id property of this ManagementAgent.
install_path (str) – The value to assign to the install_path property of this ManagementAgent.
plugin_list (list[oci.management_agent.models.ManagementAgentPluginDetails]) – The value to assign to the plugin_list property of this ManagementAgent.
compartment_id (str) – The value to assign to the compartment_id property of this ManagementAgent.
is_agent_auto_upgradable (bool) – The value to assign to the is_agent_auto_upgradable property of this ManagementAgent.
time_created (datetime) – The value to assign to the time_created property of this ManagementAgent.
time_updated (datetime) – The value to assign to the time_updated property of this ManagementAgent.
time_last_heartbeat (datetime) – The value to assign to the time_last_heartbeat property of this ManagementAgent.
availability_status (str) – The value to assign to the availability_status property of this ManagementAgent. Allowed values for this property are: “ACTIVE”, “SILENT”, “NOT_AVAILABLE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ManagementAgent. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “TERMINATED”, “DELETING”, “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 ManagementAgent.
is_customer_deployed (bool) – The value to assign to the is_customer_deployed property of this ManagementAgent.
install_type (str) – The value to assign to the install_type property of this ManagementAgent. Allowed values for this property are: “AGENT”, “GATEWAY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
management_agent_properties (list[oci.management_agent.models.ManagementAgentProperty]) – The value to assign to the management_agent_properties property of this ManagementAgent.
data_source_list (list[oci.management_agent.models.DataSource]) – The value to assign to the data_source_list property of this ManagementAgent.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ManagementAgent.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ManagementAgent.

availability_status¶

Gets the availability_status of this ManagementAgent. The current availability status of managementAgent

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

Returns:	The availability_status of this ManagementAgent.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this ManagementAgent. Compartment Identifier

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

data_source_list¶

Gets the data_source_list of this ManagementAgent. list of dataSources associated with the agent

Returns:	The data_source_list of this ManagementAgent.
Return type:	list[oci.management_agent.models.DataSource]

defined_tags¶

Gets the defined_tags of this ManagementAgent. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

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

display_name¶

Gets the display_name of this ManagementAgent. Management Agent Name

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

freeform_tags¶

Gets the freeform_tags of this ManagementAgent. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

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

host¶

Gets the host of this ManagementAgent. Management Agent host machine name

Returns:	The host of this ManagementAgent.
Return type:	str

host_id¶

Gets the host_id of this ManagementAgent. Host resource ocid

Returns:	The host_id of this ManagementAgent.
Return type:	str

id¶

[Required] Gets the id of this ManagementAgent. agent identifier

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

install_key_id¶

Gets the install_key_id of this ManagementAgent. agent install key identifier

Returns:	The install_key_id of this ManagementAgent.
Return type:	str

install_path¶

Gets the install_path of this ManagementAgent. Path where Management Agent is installed

Returns:	The install_path of this ManagementAgent.
Return type:	str

install_type¶

Gets the install_type of this ManagementAgent. The install type, either AGENT or GATEWAY

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

Returns:	The install_type of this ManagementAgent.
Return type:	str

is_agent_auto_upgradable¶

Gets the is_agent_auto_upgradable of this ManagementAgent. 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.

Returns:	The is_agent_auto_upgradable of this ManagementAgent.
Return type:	bool

is_customer_deployed¶

Gets the is_customer_deployed of this ManagementAgent. true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.

Returns:	The is_customer_deployed of this ManagementAgent.
Return type:	bool

lifecycle_details¶

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

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

lifecycle_state¶

Gets the lifecycle_state of this ManagementAgent. The current state of managementAgent

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “TERMINATED”, “DELETING”, “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 ManagementAgent.
Return type:	str

management_agent_properties¶

Gets the management_agent_properties of this ManagementAgent. Additional properties for this Management Agent

Returns:	The management_agent_properties of this ManagementAgent.
Return type:	list[oci.management_agent.models.ManagementAgentProperty]

platform_name¶

Gets the platform_name of this ManagementAgent. Platform Name

Returns:	The platform_name of this ManagementAgent.
Return type:	str

platform_type¶

Gets the platform_type of this ManagementAgent. Platform Type

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

Returns:	The platform_type of this ManagementAgent.
Return type:	str

platform_version¶

Gets the platform_version of this ManagementAgent. Platform Version

Returns:	The platform_version of this ManagementAgent.
Return type:	str

plugin_list¶

Gets the plugin_list of this ManagementAgent. list of managementAgentPlugins associated with the agent

Returns:	The plugin_list of this ManagementAgent.
Return type:	list[oci.management_agent.models.ManagementAgentPluginDetails]

resource_artifact_version¶

Gets the resource_artifact_version of this ManagementAgent. 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

Returns:	The resource_artifact_version of this ManagementAgent.
Return type:	str

time_created¶

Gets the time_created of this ManagementAgent. The time the Management Agent was created. An RFC3339 formatted datetime string

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

time_last_heartbeat¶

Gets the time_last_heartbeat of this ManagementAgent. 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

Returns:	The time_last_heartbeat of this ManagementAgent.
Return type:	datetime

time_updated¶

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

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

version¶

[Required] Gets the version of this ManagementAgent. Management Agent Version

Returns:	The version of this ManagementAgent.
Return type:	str