openstack.baremetal.v1.runbooks

The Runbook Class

The Runbook class inherits from Resource.

class openstack.baremetal.v1.runbooks.Runbook(_synchronized=False, connection=None, **attrs)

The base resource

Parameters:

  • _synchronized – This is not intended to be used directly. See new() and existing().

  • connection – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of self._connection in Resource code should protect itself with a check for None.

resources_key = 'runbooks'

Plural form of key for resource.

base_path = '/runbooks'

The base part of the URI for this resource.

allow_create = True

Allow create operation for this resource.

allow_fetch = True

Allow get operation for this resource.

allow_commit = True

Allow update operation for this resource.

allow_delete = True

Allow delete operation for this resource.

allow_list = True

Allow list operation for this resource.

allow_patch = True

Allow patch operation for this resource.

commit_method = 'PATCH'

Method for committing a resource. This must be PATCH if allow_patch is True.

name

The name of this resource.

created_at

Timestamp at which the runbook was created.

description

A human readable description of the runbook. Introduced in API microversion 1.112.

extra

A set of one or more arbitrary metadata key and value pairs.

A list of relative links. Includes the self and bookmark links.

steps

A set of physical information of the runbook.

public

Indicates whether the runbook is publicly accessible.

owner

The name or ID of the project that owns the runbook.

traits

The traits of the runbook. A node may only be acted upon by a runbook whose traits intersect with the traits of the node. Read-only here, use the trait methods to modify it. Introduced in API microversion 1.112.

updated_at

Timestamp at which the runbook was last updated.

id

The UUID of the resource.

add_trait(session, trait)

Add a trait to the runbook.

Parameters:

  • session – The session to use for making this request.

  • trait – The trait to add to the runbook.

Returns:

None

remove_trait(session, trait)

Remove a trait from the runbook.

Removing a trait the runbook does not have is a no-op on the server side.

Parameters:

  • session – The session to use for making this request.

  • trait – The trait to remove from the runbook.

Returns:

None

set_traits(session, traits)

Set traits for the runbook.

Removes any existing traits and adds the traits passed in to this method. Pass an empty list to remove all traits.

Parameters:

  • session – The session to use for making this request.

  • traits – list of traits to set on the runbook.

Returns:

None