Runbook¶
-
class
oci.fleet_apps_management.models.
Runbook
(**kwargs)¶ Bases:
object
Runbook definition.
Attributes
LIFECYCLE_STATE_ACTIVE
A constant which can be used with the lifecycle_state property of a Runbook. LIFECYCLE_STATE_DELETED
A constant which can be used with the lifecycle_state property of a Runbook. LIFECYCLE_STATE_FAILED
A constant which can be used with the lifecycle_state property of a Runbook. OS_TYPE_GENERIC
A constant which can be used with the os_type property of a Runbook. OS_TYPE_LINUX
A constant which can be used with the os_type property of a Runbook. OS_TYPE_WINDOWS
A constant which can be used with the os_type property of a Runbook. RUNBOOK_RELEVANCE_PRODUCT
A constant which can be used with the runbook_relevance property of a Runbook. RUNBOOK_RELEVANCE_PRODUCT_GROUP
A constant which can be used with the runbook_relevance property of a Runbook. TYPE_ORACLE_DEFINED
A constant which can be used with the type property of a Runbook. TYPE_SYSTEM_DEFINED
A constant which can be used with the type property of a Runbook. TYPE_USER_DEFINED
A constant which can be used with the type property of a Runbook. associations
Gets the associations of this Runbook. compartment_id
[Required] Gets the compartment_id of this Runbook. defined_tags
Gets the defined_tags of this Runbook. description
Gets the description of this Runbook. display_name
[Required] Gets the display_name of this Runbook. estimated_time
Gets the estimated_time of this Runbook. freeform_tags
Gets the freeform_tags of this Runbook. id
[Required] Gets the id of this Runbook. is_default
[Required] Gets the is_default of this Runbook. lifecycle_details
Gets the lifecycle_details of this Runbook. lifecycle_state
[Required] Gets the lifecycle_state of this Runbook. operation
[Required] Gets the operation of this Runbook. os_type
[Required] Gets the os_type of this Runbook. platform
[Required] Gets the platform of this Runbook. resource_region
Gets the resource_region of this Runbook. runbook_relevance
[Required] Gets the runbook_relevance of this Runbook. system_tags
Gets the system_tags of this Runbook. time_created
[Required] Gets the time_created of this Runbook. time_updated
[Required] Gets the time_updated of this Runbook. type
[Required] Gets the type of this Runbook. Methods
__init__
(**kwargs)Initializes a new Runbook object with values from keyword arguments. -
LIFECYCLE_STATE_ACTIVE
= 'ACTIVE'¶ A constant which can be used with the lifecycle_state property of a Runbook. This constant has a value of “ACTIVE”
-
LIFECYCLE_STATE_DELETED
= 'DELETED'¶ A constant which can be used with the lifecycle_state property of a Runbook. This constant has a value of “DELETED”
-
LIFECYCLE_STATE_FAILED
= 'FAILED'¶ A constant which can be used with the lifecycle_state property of a Runbook. This constant has a value of “FAILED”
-
OS_TYPE_GENERIC
= 'GENERIC'¶ A constant which can be used with the os_type property of a Runbook. This constant has a value of “GENERIC”
-
OS_TYPE_LINUX
= 'LINUX'¶ A constant which can be used with the os_type property of a Runbook. This constant has a value of “LINUX”
-
OS_TYPE_WINDOWS
= 'WINDOWS'¶ A constant which can be used with the os_type property of a Runbook. This constant has a value of “WINDOWS”
-
RUNBOOK_RELEVANCE_PRODUCT
= 'PRODUCT'¶ A constant which can be used with the runbook_relevance property of a Runbook. This constant has a value of “PRODUCT”
-
RUNBOOK_RELEVANCE_PRODUCT_GROUP
= 'PRODUCT_GROUP'¶ A constant which can be used with the runbook_relevance property of a Runbook. This constant has a value of “PRODUCT_GROUP”
-
TYPE_ORACLE_DEFINED
= 'ORACLE_DEFINED'¶ A constant which can be used with the type property of a Runbook. This constant has a value of “ORACLE_DEFINED”
-
TYPE_SYSTEM_DEFINED
= 'SYSTEM_DEFINED'¶ A constant which can be used with the type property of a Runbook. This constant has a value of “SYSTEM_DEFINED”
-
TYPE_USER_DEFINED
= 'USER_DEFINED'¶ A constant which can be used with the type property of a Runbook. This constant has a value of “USER_DEFINED”
-
__init__
(**kwargs)¶ Initializes a new Runbook 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 Runbook.
- display_name (str) – The value to assign to the display_name property of this Runbook.
- description (str) – The value to assign to the description property of this Runbook.
- type (str) – The value to assign to the type property of this Runbook. Allowed values for this property are: “USER_DEFINED”, “ORACLE_DEFINED”, “SYSTEM_DEFINED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- runbook_relevance (str) – The value to assign to the runbook_relevance property of this Runbook. Allowed values for this property are: “PRODUCT_GROUP”, “PRODUCT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- operation (str) – The value to assign to the operation property of this Runbook.
- os_type (str) – The value to assign to the os_type property of this Runbook. Allowed values for this property are: “WINDOWS”, “LINUX”, “GENERIC”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- platform (str) – The value to assign to the platform property of this Runbook.
- is_default (bool) – The value to assign to the is_default property of this Runbook.
- estimated_time (str) – The value to assign to the estimated_time property of this Runbook.
- lifecycle_state (str) – The value to assign to the lifecycle_state property of this Runbook. Allowed values for this property are: “ACTIVE”, “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 Runbook.
- time_created (datetime) – The value to assign to the time_created property of this Runbook.
- time_updated (datetime) – The value to assign to the time_updated property of this Runbook.
- associations (oci.fleet_apps_management.models.Associations) – The value to assign to the associations property of this Runbook.
- compartment_id (str) – The value to assign to the compartment_id property of this Runbook.
- resource_region (str) – The value to assign to the resource_region property of this Runbook.
- freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Runbook.
- defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Runbook.
- system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Runbook.
-
associations
¶ Gets the associations of this Runbook.
Returns: The associations of this Runbook. Return type: oci.fleet_apps_management.models.Associations
-
compartment_id
¶ [Required] Gets the compartment_id of this Runbook. OCID of the compartment to which the resource belongs to.
Returns: The compartment_id of this Runbook. Return type: str
Gets the defined_tags of this Runbook. 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 Runbook. Return type: dict(str, dict(str, object))
-
description
¶ Gets the description of this Runbook. A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.
Returns: The description of this Runbook. Return type: str
-
display_name
¶ [Required] Gets the display_name of this Runbook. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
Example: My new resource
Returns: The display_name of this Runbook. Return type: str
-
estimated_time
¶ Gets the estimated_time of this Runbook. Estimated time to successfully complete the runbook execution
Returns: The estimated_time of this Runbook. Return type: str
Gets the freeform_tags of this Runbook. 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 Runbook. Return type: dict(str, str)
-
id
¶ [Required] Gets the id of this Runbook. The OCID of the resource.
Returns: The id of this Runbook. Return type: str
-
is_default
¶ [Required] Gets the is_default of this Runbook. Is the runbook default?
Returns: The is_default of this Runbook. Return type: bool
-
lifecycle_details
¶ Gets the lifecycle_details of this Runbook. 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 Runbook. Return type: str
-
lifecycle_state
¶ [Required] Gets the lifecycle_state of this Runbook. The current state of the Runbook.
Allowed values for this property are: “ACTIVE”, “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 Runbook. Return type: str
-
operation
¶ [Required] Gets the operation of this Runbook. The lifecycle operation performed by the task.
Returns: The operation of this Runbook. Return type: str
-
os_type
¶ [Required] Gets the os_type of this Runbook. The OS type for the runbook.
Allowed values for this property are: “WINDOWS”, “LINUX”, “GENERIC”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
Returns: The os_type of this Runbook. Return type: str
-
platform
¶ [Required] Gets the platform of this Runbook. The platform of the runbook.
Returns: The platform of this Runbook. Return type: str
-
resource_region
¶ Gets the resource_region of this Runbook. Associated region
Returns: The resource_region of this Runbook. Return type: str
-
runbook_relevance
¶ [Required] Gets the runbook_relevance of this Runbook. Type of runbook structure.
Allowed values for this property are: “PRODUCT_GROUP”, “PRODUCT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
Returns: The runbook_relevance of this Runbook. Return type: str
Gets the system_tags of this Runbook. System tags for this resource. Each key is predefined and scoped to a namespace. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
Returns: The system_tags of this Runbook. Return type: dict(str, dict(str, object))
-
time_created
¶ [Required] Gets the time_created of this Runbook. The time this resource was created. An RFC3339 formatted datetime string.
Returns: The time_created of this Runbook. Return type: datetime
-
time_updated
¶ [Required] Gets the time_updated of this Runbook. The time this resource was last updated. An RFC3339 formatted datetime string.
Returns: The time_updated of this Runbook. Return type: datetime
-
type
¶ [Required] Gets the type of this Runbook. The type of the runbook.
Allowed values for this property are: “USER_DEFINED”, “ORACLE_DEFINED”, “SYSTEM_DEFINED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
Returns: The type of this Runbook. Return type: str
-