Overclouds

class tuskarclient.v1.overclouds.Overcloud(manager, info, loaded=False)

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

Represents an instance of a Overcloud in the Tuskar API.

Parameters:

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

class tuskarclient.v1.overclouds.OvercloudManager(api)

Bases: tuskarclient.common.base.Manager

OvercloudManager interacts with the Tuskar API and provides CRUD operations for the Overcloud type.

create(**fields)

Create a new Overcloud.

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

delete(overcloud_id)

Delete an Overcloud.

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

get(overcloud_id)

Get the Overcloud by its ID.

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

list()

Get a list of the existing Overclouds

Returns:A list of overclounds or an empty list if none are found. Return type:[tuskarclient.v1.overclouds.Overcloud] or []

resource_class

The class used to represent an Overcloud instance

alias of Overcloud

template_parameters()

Get the template parameters from the Tuskar API.

Returns:Dictionary containing template parameters Return type:dict

update(overcloud_id, **fields)

Update an existing Overcloud.

Parameters:

• overcloud_id (string) – id of the Overcloud.
• fields (string) – A set of key/value pairs representing the Overcloud.

Returns:

A Overcloud instance or None if its not found.

Return type:

tuskarclient.v1.overclouds.Overcloud or None