Runbook

class oci.fleet_apps_management.models.Runbook(**kwargs)

Bases: object

Runbook definition. Runbooks allow you to capture procedural tasks for handling a workflow. Only active versions of runbook will be available for executions.

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a Runbook.

LIFECYCLE_STATE_CREATING

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_DELETING

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.

LIFECYCLE_STATE_INACTIVE

A constant which can be used with the lifecycle_state property of a Runbook.

LIFECYCLE_STATE_UPDATING

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.

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.

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.

has_draft_version

Gets the has_draft_version of this Runbook.

id

[Required] Gets the id of this Runbook.

is_default

[Required] Gets the is_default of this Runbook.

is_sudo_access_needed

Gets the is_sudo_access_needed of this Runbook.

latest_version

Gets the latest_version 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

Gets the os_type of this Runbook.

platform

Gets the platform of this Runbook.

resource_region

Gets the resource_region of this Runbook.

runbook_version

Gets the runbook_version 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_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a Runbook. This constant has a value of “CREATING”

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_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a Runbook. This constant has a value of “DELETING”

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”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a Runbook. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a Runbook. This constant has a value of “UPDATING”

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”

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’.

  • 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.

  • is_sudo_access_needed (bool) – The value to assign to the is_sudo_access_needed property of this Runbook.

  • estimated_time (str) – The value to assign to the estimated_time property of this Runbook.

  • latest_version (str) – The value to assign to the latest_version property of this Runbook.

  • has_draft_version (bool) – The value to assign to the has_draft_version 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”, “INACTIVE”, “CREATING”, “DELETING”, “UPDATING”, ‘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.

  • runbook_version (oci.fleet_apps_management.models.Version) – The value to assign to the runbook_version 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.

property 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

property defined_tags

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))

property 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

property 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

property 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

property freeform_tags

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)

property has_draft_version

Gets the has_draft_version of this Runbook. Does this runbook has draft versions?

Returns

The has_draft_version of this Runbook.

Return type

bool

property id

[Required] Gets the id of this Runbook. The OCID of the resource.

Returns

The id of this Runbook.

Return type

str

property is_default

[Required] Gets the is_default of this Runbook. Is the runbook default? Sets this runbook as the default for the chosen product/product stack for the specified lifecycle operation.

Returns

The is_default of this Runbook.

Return type

bool

property is_sudo_access_needed

Gets the is_sudo_access_needed of this Runbook. Does this runbook need SUDO access to execute?

Returns

The is_sudo_access_needed of this Runbook.

Return type

bool

property latest_version

Gets the latest_version of this Runbook. Latest runbook version.

Returns

The latest_version of this Runbook.

Return type

str

property 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

property 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”, “INACTIVE”, “CREATING”, “DELETING”, “UPDATING”, ‘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

property operation

[Required] Gets the operation of this Runbook. The lifecycle operation performed by the runbook.

Returns

The operation of this Runbook.

Return type

str

property os_type

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

property platform

Gets the platform of this Runbook. The platform of the runbook.

Returns

The platform of this Runbook.

Return type

str

property resource_region

Gets the resource_region of this Runbook. Associated region

Returns

The resource_region of this Runbook.

Return type

str

property runbook_version

Gets the runbook_version of this Runbook.

Returns

The runbook_version of this Runbook.

Return type

oci.fleet_apps_management.models.Version

property system_tags

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))

property 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

property 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

property 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