Overcloud_roles

class tuskarclient.v1.overcloud_roles.OvercloudRole(manager, info, loaded=False)

Bases: tuskarclient.openstack.common.apiclient.base.Resource

Represents an instance of an Overcloud Role in the Tuskar API.

Parameters:

• manager – Manager object
• info – dictionary representing the resource attributes
• loaded – prevent lazy-loading if set to True

class tuskarclient.v1.overcloud_roles.OvercloudRoleManager(api)

Bases: tuskarclient.common.base.Manager

OvercloudRoleManager interacts with the Tuskar API and provides CRUD operations for the overcloud role type.

create(**fields)

Create a new Overcloud Role.

Parameters:fields (string) – A set of key/value pairs representing a OvercloudRole Returns:A Overcloud Role instance or None if its not found. Return type:tuskarclient.v1.overcloud_roles.OvercloudRole

delete(overcloud_role_id)

Delete a Overcloud Role.

Parameters:id (string) – id of the Overcloud Role. Returns:None Return type:None

get(overcloud_role_id)

Get the Overcloud Role by its ID.

Parameters:id (string) – id of the Overcloud Role. Returns:A Overcloud Role instance or None if its not found. Return type:tuskarclient.v1.overcloud_roles.OvercloudRole or None

list()

Get a list of the existing Overcloud Roles

Returns:A list of Overcloud Roles or an empty list if none exist. Return type:[tuskarclient.v1.overcloud_roles.OvercloudRole] or []

resource_class

The class used to represent an overcloud role instance

alias of OvercloudRole

update(overcloud_role_id, **fields)

Update an existing Overcloud Role.

Parameters:

• overcloud_role_id (string) – id of the Overcloud Role.
• fields (string) – A set of key/value pairs representing a OvercloudRole

Returns:

An OvercloudRole instance or None if its not found.

Return type:

tuskarclient.v1.overcloud_roles.OvercloudRole or None