Stacks

class heatclient.v1.stacks.Stack(manager, info, loaded=False)

Bases: Resource

abandon()
property action
create(**fields)
delete()
environment()
files()
get()

Support for lazy loading details.

Some clients, such as novaclient have the option to lazy load the details, details which can be loaded with this function.

property identifier
output_list()
output_show(output_key)
preview(**fields)
restore(snapshot_id)
snapshot(name=None)
snapshot_delete(snapshot_id)
snapshot_list()
snapshot_show(snapshot_id)
property status
update(**fields)
class heatclient.v1.stacks.StackChildManager(client)

Bases: BaseManager

property api
class heatclient.v1.stacks.StackManager(client)

Bases: StackChildManager

abandon(stack_id)

Abandon a stack.

Parameters:

stack_id – Stack name or ID to identifies the stack

create(**kwargs)

Create a stack.

delete(stack_id)

Delete a stack.

Parameters:

stack_id – Stack name or ID to identifies the stack

environment(stack_id)

Returns the environment for an existing stack.

Parameters:

stack_id – Stack name or ID to identifies the stack

Returns:

export(stack_id)

Export data of a stack.

Parameters:

stack_id – Stack name or ID to identifies the stack

files(stack_id)

Returns the files for an existing stack.

Parameters:

stack_id – Stack name or ID to identifies the stack.

Returns:

get(stack_id, resolve_outputs=True)

Get the metadata for a specific stack.

Parameters:
  • stack_id – Stack ID or name to lookup

  • resolve_outputs – If True, then outputs for this stack will be resolved

list(**kwargs)

Get a list of stacks.

Parameters:
  • limit – maximum number of stacks to return

  • marker – begin returning stacks that appear later in the stack list than that represented by this stack id

  • filters – dict of direct comparison filters that mimics the structure of a stack object

Return type:

list of Stack

output_list(stack_id)
output_show(stack_id, output_key)
preview(**kwargs)

Preview a stack.

preview_update(stack_id, **kwargs)

Preview a stack update.

Parameters:

stack_id – Stack name or ID to identifies the stack

resource_class

alias of Stack

restore(stack_id, snapshot_id)
snapshot(stack_id, name=None)

Snapshot a stack.

Parameters:

stack_id – Stack name or ID to identifies the stack

snapshot_delete(stack_id, snapshot_id)
snapshot_list(stack_id)
snapshot_show(stack_id, snapshot_id)
template(stack_id)

Get template content for a specific stack as a parsed JSON object.

Parameters:

stack_id – Stack ID or name to get the template for

update(stack_id, **kwargs)

Update a stack.

Parameters:

stack_id – Stack name or ID to identifies the stack

validate(**kwargs)

Validate a stack template.