ManagementAgentInstallKey¶

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

Bases: object

The details of the Agent install Key

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ManagementAgentInstallKey.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a ManagementAgentInstallKey.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ManagementAgentInstallKey.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a ManagementAgentInstallKey.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a ManagementAgentInstallKey.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a ManagementAgentInstallKey.
`LIFECYCLE_STATE_TERMINATED`	A constant which can be used with the lifecycle_state property of a ManagementAgentInstallKey.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a ManagementAgentInstallKey.
`allowed_key_install_count`	Gets the allowed_key_install_count of this ManagementAgentInstallKey.
`compartment_id`	[Required] Gets the compartment_id of this ManagementAgentInstallKey.
`created_by_principal_id`	Gets the created_by_principal_id of this ManagementAgentInstallKey.
`current_key_install_count`	Gets the current_key_install_count of this ManagementAgentInstallKey.
`defined_tags`	Gets the defined_tags of this ManagementAgentInstallKey.
`display_name`	Gets the display_name of this ManagementAgentInstallKey.
`freeform_tags`	Gets the freeform_tags of this ManagementAgentInstallKey.
`id`	[Required] Gets the id of this ManagementAgentInstallKey.
`is_unlimited`	Gets the is_unlimited of this ManagementAgentInstallKey.
`key`	Gets the key of this ManagementAgentInstallKey.
`lifecycle_details`	Gets the lifecycle_details of this ManagementAgentInstallKey.
`lifecycle_state`	Gets the lifecycle_state of this ManagementAgentInstallKey.
`system_tags`	Gets the system_tags of this ManagementAgentInstallKey.
`time_created`	Gets the time_created of this ManagementAgentInstallKey.
`time_expires`	Gets the time_expires of this ManagementAgentInstallKey.
`time_updated`	Gets the time_updated of this ManagementAgentInstallKey.

Methods

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

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

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

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

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

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

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

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

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

__init__(**kwargs)¶

Initializes a new ManagementAgentInstallKey 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 ManagementAgentInstallKey.
display_name (str) – The value to assign to the display_name property of this ManagementAgentInstallKey.
key (str) – The value to assign to the key property of this ManagementAgentInstallKey.
created_by_principal_id (str) – The value to assign to the created_by_principal_id property of this ManagementAgentInstallKey.
compartment_id (str) – The value to assign to the compartment_id property of this ManagementAgentInstallKey.
allowed_key_install_count (int) – The value to assign to the allowed_key_install_count property of this ManagementAgentInstallKey.
current_key_install_count (int) – The value to assign to the current_key_install_count property of this ManagementAgentInstallKey.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ManagementAgentInstallKey. 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 ManagementAgentInstallKey.
time_expires (datetime) – The value to assign to the time_expires property of this ManagementAgentInstallKey.
time_created (datetime) – The value to assign to the time_created property of this ManagementAgentInstallKey.
time_updated (datetime) – The value to assign to the time_updated property of this ManagementAgentInstallKey.
is_unlimited (bool) – The value to assign to the is_unlimited property of this ManagementAgentInstallKey.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ManagementAgentInstallKey.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ManagementAgentInstallKey.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ManagementAgentInstallKey.

allowed_key_install_count¶

Gets the allowed_key_install_count of this ManagementAgentInstallKey. Total number of install for this keys

Returns:	The allowed_key_install_count of this ManagementAgentInstallKey.
Return type:	int

compartment_id¶

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

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

created_by_principal_id¶

Gets the created_by_principal_id of this ManagementAgentInstallKey. Principal id of user who created the Agent Install key

Returns:	The created_by_principal_id of this ManagementAgentInstallKey.
Return type:	str

current_key_install_count¶

Gets the current_key_install_count of this ManagementAgentInstallKey. Total number of install for this keys

Returns:	The current_key_install_count of this ManagementAgentInstallKey.
Return type:	int

defined_tags¶

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

display_name¶

Gets the display_name of this ManagementAgentInstallKey. Management Agent Install Key Name

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

freeform_tags¶

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

id¶

[Required] Gets the id of this ManagementAgentInstallKey. Agent install Key identifier

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

is_unlimited¶

Gets the is_unlimited of this ManagementAgentInstallKey. If set to true, the install key has no expiration date or usage limit. Defaults to false

Returns:	The is_unlimited of this ManagementAgentInstallKey.
Return type:	bool

key¶

Gets the key of this ManagementAgentInstallKey. Management Agent Install Key

Returns:	The key of this ManagementAgentInstallKey.
Return type:	str

lifecycle_details¶

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

lifecycle_state¶

Gets the lifecycle_state of this ManagementAgentInstallKey. Status of Key

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 ManagementAgentInstallKey.
Return type:	str

system_tags¶

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

time_created¶

Gets the time_created of this ManagementAgentInstallKey. The time when Management Agent install Key was created. An RFC3339 formatted date time string

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

time_expires¶

Gets the time_expires of this ManagementAgentInstallKey. date after which key would expire after creation

Returns:	The time_expires of this ManagementAgentInstallKey.
Return type:	datetime

time_updated¶

Gets the time_updated of this ManagementAgentInstallKey. The time when Management Agent install Key was updated. An RFC3339 formatted date time string

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