CreateRunbookDetails

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

Bases: object

The information about new Runbook.

Attributes:

OS_TYPE_GENERIC

A constant which can be used with the os_type property of a CreateRunbookDetails.

OS_TYPE_LINUX

A constant which can be used with the os_type property of a CreateRunbookDetails.

OS_TYPE_WINDOWS

A constant which can be used with the os_type property of a CreateRunbookDetails.

compartment_id

[Required] Gets the compartment_id of this CreateRunbookDetails.

defined_tags

Gets the defined_tags of this CreateRunbookDetails.

description

Gets the description of this CreateRunbookDetails.

display_name

[Required] Gets the display_name of this CreateRunbookDetails.

estimated_time

Gets the estimated_time of this CreateRunbookDetails.

freeform_tags

Gets the freeform_tags of this CreateRunbookDetails.

is_default

Gets the is_default of this CreateRunbookDetails.

is_sudo_access_needed

Gets the is_sudo_access_needed of this CreateRunbookDetails.

operation

[Required] Gets the operation of this CreateRunbookDetails.

os_type

Gets the os_type of this CreateRunbookDetails.

platform

Gets the platform of this CreateRunbookDetails.

runbook_version

[Required] Gets the runbook_version of this CreateRunbookDetails.

Methods:

__init__(**kwargs)

Initializes a new CreateRunbookDetails object with values from keyword arguments.

OS_TYPE_GENERIC = 'GENERIC'

A constant which can be used with the os_type property of a CreateRunbookDetails. This constant has a value of “GENERIC”

OS_TYPE_LINUX = 'LINUX'

A constant which can be used with the os_type property of a CreateRunbookDetails. This constant has a value of “LINUX”

OS_TYPE_WINDOWS = 'WINDOWS'

A constant which can be used with the os_type property of a CreateRunbookDetails. This constant has a value of “WINDOWS”

__init__(**kwargs)

Initializes a new CreateRunbookDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • display_name (str) – The value to assign to the display_name property of this CreateRunbookDetails.

  • description (str) – The value to assign to the description property of this CreateRunbookDetails.

  • operation (str) – The value to assign to the operation property of this CreateRunbookDetails.

  • os_type (str) – The value to assign to the os_type property of this CreateRunbookDetails. Allowed values for this property are: “WINDOWS”, “LINUX”, “GENERIC”

  • platform (str) – The value to assign to the platform property of this CreateRunbookDetails.

  • is_default (bool) – The value to assign to the is_default property of this CreateRunbookDetails.

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

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

  • runbook_version (oci.fleet_apps_management.models.Version) – The value to assign to the runbook_version property of this CreateRunbookDetails.

  • compartment_id (str) – The value to assign to the compartment_id property of this CreateRunbookDetails.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateRunbookDetails.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateRunbookDetails.

property compartment_id

[Required] Gets the compartment_id of this CreateRunbookDetails. OCID of the compartment to which the resource belongs to.

Returns

The compartment_id of this CreateRunbookDetails.

Return type

str

property defined_tags

Gets the defined_tags of this CreateRunbookDetails. 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 CreateRunbookDetails.

Return type

dict(str, dict(str, object))

property description

Gets the description of this CreateRunbookDetails. A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.

Returns

The description of this CreateRunbookDetails.

Return type

str

property display_name

[Required] Gets the display_name of this CreateRunbookDetails. 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 CreateRunbookDetails.

Return type

str

property estimated_time

Gets the estimated_time of this CreateRunbookDetails. Estimated time to successfully complete the runbook execution.

Returns

The estimated_time of this CreateRunbookDetails.

Return type

str

property freeform_tags

Gets the freeform_tags of this CreateRunbookDetails. 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 CreateRunbookDetails.

Return type

dict(str, str)

property is_default

Gets the is_default of this CreateRunbookDetails. Is the runbook default?

Returns

The is_default of this CreateRunbookDetails.

Return type

bool

property is_sudo_access_needed

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

Returns

The is_sudo_access_needed of this CreateRunbookDetails.

Return type

bool

property operation

[Required] Gets the operation of this CreateRunbookDetails. The lifecycle operation performed by the task.

Returns

The operation of this CreateRunbookDetails.

Return type

str

property os_type

Gets the os_type of this CreateRunbookDetails. The OS type for the runbook.

Allowed values for this property are: “WINDOWS”, “LINUX”, “GENERIC”

Returns

The os_type of this CreateRunbookDetails.

Return type

str

property platform

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

Returns

The platform of this CreateRunbookDetails.

Return type

str

property runbook_version

[Required] Gets the runbook_version of this CreateRunbookDetails.

Returns

The runbook_version of this CreateRunbookDetails.

Return type

oci.fleet_apps_management.models.Version