The heat.cfn_client.client Module

Client classes for callers of a heat system

heat.cfn_client.client.HeatClient

alias of V1Client

class heat.cfn_client.client.V1Client(host=None, port=None, use_ssl=False, auth_tok=None, creds=None, doc_root=None, key_file=None, cert_file=None, ca_file=None, insecure=False, configure_via_auth=True, service_type=None)[source]

Bases: heat.common.client.BaseClient

Main client class for accessing heat resources

DEFAULT_DOC_ROOT = '/v1'
create_stack(**kwargs)[source]
delete_stack(**kwargs)[source]
describe_stack_resource(**kwargs)[source]
describe_stack_resources(**kwargs)[source]
describe_stacks(**kwargs)[source]
estimate_template_cost(**kwargs)[source]
format_parameters(options)[source]

Reformat parameters into dict of format expected by the API

format_stack(stack)[source]
format_stack_event(event)[source]
format_stack_resource(res)[source]
format_stack_resource_detail(res)[source]
format_stack_resource_summary(res)[source]
format_stack_summary(summary)[source]
format_template(template)[source]
get_template(**kwargs)[source]
list_stack_events(**kwargs)[source]
list_stack_resources(**kwargs)[source]
list_stacks(**kwargs)[source]
stack_request(action, method, **kwargs)[source]
update_stack(**kwargs)[source]
validate_template(**kwargs)[source]
heat.cfn_client.client.get_client(host, port=None, username=None, password=None, tenant=None, auth_url=None, auth_strategy=None, auth_token=None, region=None, is_silent_upload=False, insecure=False)[source]

Returns a new client heat client object based on common kwargs. If an option isn’t specified falls back to common environment variable defaults.

This Page