ManagementAgentSummary¶

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

Bases: object

The summary 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 ManagementAgentSummary.
`AVAILABILITY_STATUS_NOT_AVAILABLE`	A constant which can be used with the availability_status property of a ManagementAgentSummary.
`AVAILABILITY_STATUS_SILENT`	A constant which can be used with the availability_status property of a ManagementAgentSummary.
`INSTALL_TYPE_AGENT`	A constant which can be used with the install_type property of a ManagementAgentSummary.
`INSTALL_TYPE_GATEWAY`	A constant which can be used with the install_type property of a ManagementAgentSummary.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ManagementAgentSummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a ManagementAgentSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ManagementAgentSummary.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a ManagementAgentSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a ManagementAgentSummary.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a ManagementAgentSummary.
`LIFECYCLE_STATE_TERMINATED`	A constant which can be used with the lifecycle_state property of a ManagementAgentSummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a ManagementAgentSummary.
`PLATFORM_TYPE_AIX`	A constant which can be used with the platform_type property of a ManagementAgentSummary.
`PLATFORM_TYPE_LINUX`	A constant which can be used with the platform_type property of a ManagementAgentSummary.
`PLATFORM_TYPE_MACOSX`	A constant which can be used with the platform_type property of a ManagementAgentSummary.
`PLATFORM_TYPE_SOLARIS`	A constant which can be used with the platform_type property of a ManagementAgentSummary.
`PLATFORM_TYPE_WINDOWS`	A constant which can be used with the platform_type property of a ManagementAgentSummary.
`availability_status`	Gets the availability_status of this ManagementAgentSummary.
`compartment_id`	[Required] Gets the compartment_id of this ManagementAgentSummary.
`data_source_summary_list`	Gets the data_source_summary_list of this ManagementAgentSummary.
`defined_tags`	Gets the defined_tags of this ManagementAgentSummary.
`display_name`	Gets the display_name of this ManagementAgentSummary.
`freeform_tags`	Gets the freeform_tags of this ManagementAgentSummary.
`host`	Gets the host of this ManagementAgentSummary.
`host_id`	Gets the host_id of this ManagementAgentSummary.
`id`	[Required] Gets the id of this ManagementAgentSummary.
`install_key_id`	Gets the install_key_id of this ManagementAgentSummary.
`install_type`	Gets the install_type of this ManagementAgentSummary.
`is_agent_auto_upgradable`	Gets the is_agent_auto_upgradable of this ManagementAgentSummary.
`is_customer_deployed`	Gets the is_customer_deployed of this ManagementAgentSummary.
`latest_supported_version`	Gets the latest_supported_version of this ManagementAgentSummary.
`lifecycle_details`	Gets the lifecycle_details of this ManagementAgentSummary.
`lifecycle_state`	Gets the lifecycle_state of this ManagementAgentSummary.
`platform_name`	Gets the platform_name of this ManagementAgentSummary.
`platform_type`	Gets the platform_type of this ManagementAgentSummary.
`platform_version`	Gets the platform_version of this ManagementAgentSummary.
`plugin_list`	Gets the plugin_list of this ManagementAgentSummary.
`resource_artifact_version`	Gets the resource_artifact_version of this ManagementAgentSummary.
`system_tags`	Gets the system_tags of this ManagementAgentSummary.
`time_created`	Gets the time_created of this ManagementAgentSummary.
`time_last_heartbeat`	Gets the time_last_heartbeat of this ManagementAgentSummary.
`time_updated`	Gets the time_updated of this ManagementAgentSummary.
`version`	[Required] Gets the version of this ManagementAgentSummary.

Methods

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

AVAILABILITY_STATUS_ACTIVE = 'ACTIVE'¶: A constant which can be used with the availability_status property of a ManagementAgentSummary. 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 ManagementAgentSummary. 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 ManagementAgentSummary. This constant has a value of “SILENT”

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

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

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

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

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

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

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

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

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

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

PLATFORM_TYPE_AIX = 'AIX'¶: A constant which can be used with the platform_type property of a ManagementAgentSummary. This constant has a value of “AIX”

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

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

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

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

__init__(**kwargs)¶

Initializes a new ManagementAgentSummary 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 ManagementAgentSummary.
install_key_id (str) – The value to assign to the install_key_id property of this ManagementAgentSummary.
display_name (str) – The value to assign to the display_name property of this ManagementAgentSummary.
platform_type (str) – The value to assign to the platform_type property of this ManagementAgentSummary. Allowed values for this property are: “LINUX”, “WINDOWS”, “SOLARIS”, “MACOSX”, “AIX”, ‘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 ManagementAgentSummary.
platform_version (str) – The value to assign to the platform_version property of this ManagementAgentSummary.
version (str) – The value to assign to the version property of this ManagementAgentSummary.
resource_artifact_version (str) – The value to assign to the resource_artifact_version property of this ManagementAgentSummary.
is_agent_auto_upgradable (bool) – The value to assign to the is_agent_auto_upgradable property of this ManagementAgentSummary.
time_created (datetime) – The value to assign to the time_created property of this ManagementAgentSummary.
time_updated (datetime) – The value to assign to the time_updated property of this ManagementAgentSummary.
host (str) – The value to assign to the host property of this ManagementAgentSummary.
host_id (str) – The value to assign to the host_id property of this ManagementAgentSummary.
plugin_list (list[oci.management_agent.models.ManagementAgentPluginDetails]) – The value to assign to the plugin_list property of this ManagementAgentSummary.
compartment_id (str) – The value to assign to the compartment_id property of this ManagementAgentSummary.
time_last_heartbeat (datetime) – The value to assign to the time_last_heartbeat property of this ManagementAgentSummary.
availability_status (str) – The value to assign to the availability_status property of this ManagementAgentSummary. 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 ManagementAgentSummary. 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 ManagementAgentSummary.
is_customer_deployed (bool) – The value to assign to the is_customer_deployed property of this ManagementAgentSummary.
install_type (str) – The value to assign to the install_type property of this ManagementAgentSummary. 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’.
latest_supported_version (str) – The value to assign to the latest_supported_version property of this ManagementAgentSummary.
data_source_summary_list (list[oci.management_agent.models.DataSourceSummaryItem]) – The value to assign to the data_source_summary_list property of this ManagementAgentSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ManagementAgentSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ManagementAgentSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ManagementAgentSummary.

availability_status¶

Gets the availability_status of this ManagementAgentSummary. 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 ManagementAgentSummary.
Return type:	str

compartment_id¶

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

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

data_source_summary_list¶

Gets the data_source_summary_list of this ManagementAgentSummary. list of dataSources summaries associated with the agent

Returns:	The data_source_summary_list of this ManagementAgentSummary.
Return type:	list[oci.management_agent.models.DataSourceSummaryItem]

defined_tags¶

Gets the defined_tags of this ManagementAgentSummary. 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 ManagementAgentSummary.
Return type:	dict(str, dict(str, object))

display_name¶

Gets the display_name of this ManagementAgentSummary. Management Agent Name

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

freeform_tags¶

Gets the freeform_tags of this ManagementAgentSummary. 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 ManagementAgentSummary.
Return type:	dict(str, str)

host¶

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

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

host_id¶

Gets the host_id of this ManagementAgentSummary. Host resource ocid

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

id¶

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

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

install_key_id¶

Gets the install_key_id of this ManagementAgentSummary. agent install key identifier

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

install_type¶

Gets the install_type of this ManagementAgentSummary. 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 ManagementAgentSummary.
Return type:	str

is_agent_auto_upgradable¶

Gets the is_agent_auto_upgradable of this ManagementAgentSummary. 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 ManagementAgentSummary.
Return type:	bool

is_customer_deployed¶

Gets the is_customer_deployed of this ManagementAgentSummary. 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 ManagementAgentSummary.
Return type:	bool

latest_supported_version¶

Gets the latest_supported_version of this ManagementAgentSummary. The latest supported management agent version

Returns:	The latest_supported_version of this ManagementAgentSummary.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this ManagementAgentSummary. 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 ManagementAgentSummary.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this ManagementAgentSummary. 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 ManagementAgentSummary.
Return type:	str

platform_name¶

Gets the platform_name of this ManagementAgentSummary. Platform Name

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

platform_type¶

Gets the platform_type of this ManagementAgentSummary. Platform Type

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

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

platform_version¶

Gets the platform_version of this ManagementAgentSummary. Platform Version

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

plugin_list¶

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

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

resource_artifact_version¶

Gets the resource_artifact_version of this ManagementAgentSummary. 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 ManagementAgentSummary.
Return type:	str

system_tags¶

Gets the system_tags of this ManagementAgentSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: { “orcl-cloud”: { “free-tier-retained”: “true” } }

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

time_created¶

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

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

time_last_heartbeat¶

Gets the time_last_heartbeat of this ManagementAgentSummary. The time the Management Agent has last recorded its heartbeat. An RFC3339 formatted datetime string

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

time_updated¶

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

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

version¶

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

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