Client side of the heat engine RPC API.
-
class heat.rpc.client.EngineClient[source]
Bases: heat.openstack.common.rpc.proxy.RpcProxy
Client side of the heat engine rpc API.
API version history:
1.0 - Initial version.
-
BASE_RPC_API_VERSION = '1.0'
-
authenticated_to_backend(ctxt)[source]
Verify that the credentials in the RPC context are valid for the
current cloud backend.
| Parameters: | ctxt – RPC context. |
|---|
-
create_stack(ctxt, stack_name, template, params, args)[source]
The create_stack method creates a new stack using the template
provided.
Note that at this stage the template has already been fetched from the
heat-api process if using a template-url.
| Parameters: |
- ctxt – RPC context.
- stack_name – Name of the stack you want to create.
- template – Template of stack you want to create.
- params – Stack Input Params
- args – Request parameters/args passed from API
|
|---|
-
create_watch_data(ctxt, watch_name, stats_data)[source]
This could be used by CloudWatch and WaitConditions
and treat HA service events like any other CloudWatch.
-
delete_stack(ctxt, stack_identity, cast=True)[source]
The delete_stack method deletes a given stack.
| Parameters: |
- ctxt – RPC context.
- stack_identity – Name of the stack you want to delete.
- params – Params passed from API.
|
|---|
-
describe_stack_resource(ctxt, stack_identity, resource_name)[source]
-
describe_stack_resources(ctxt, stack_identity, resource_name)[source]
-
find_physical_resource(ctxt, physical_resource_id)[source]
Return an identifier for the resource with the specified physical
resource ID.
:param ctxt RPC context.
:param physcial_resource_id The physical resource ID to look up.
-
get_template(ctxt, stack_identity)[source]
Get the template.
| Parameters: |
- ctxt – RPC context.
- stack_name – Name of the stack you want to see.
- params – Dict of http request parameters passed in from API side.
|
|---|
-
identify_stack(ctxt, stack_name)[source]
The identify_stack method returns the full stack identifier for a
single, live stack given the stack name.
| Parameters: |
- ctxt – RPC context.
- stack_name – Name of the stack you want to see,
or None to see all
|
|---|
-
list_events(ctxt, stack_identity)[source]
The list_events method lists all events associated with a given stack.
| Parameters: |
- ctxt – RPC context.
- stack_identity – Name of the stack you want to get events for.
- params – Params passed from API.
|
|---|
-
list_resource_types(ctxt)[source]
Get a list of valid resource types.
| Parameters: | ctxt – RPC context. |
|---|
-
list_stack_resources(ctxt, stack_identity)[source]
-
list_stacks(ctxt)[source]
The list_stacks method returns the attributes of all stacks.
| Parameters: | ctxt – RPC context. |
|---|
-
metadata_update(ctxt, stack_identity, resource_name, metadata)[source]
Update the metadata for the given resource.
-
set_watch_state(ctxt, watch_name, state)[source]
Temporarily set the state of a given watch
arg1 -> RPC context.
arg2 -> Name of the watch
arg3 -> State (must be one defined in WatchRule class)
-
show_stack(ctxt, stack_identity)[source]
Return detailed information about one or all stacks.
:param ctxt: RPC context.
:param stack_identity: Name of the stack you want to show, or None to
show all
-
show_watch(ctxt, watch_name)[source]
The show_watch method returns the attributes of one watch
or all watches if no watch_name is passed
| Parameters: |
- ctxt – RPC context.
- watch_name – Name of the watch/alarm you want to see,
or None to see all
|
|---|
-
show_watch_metric(ctxt, namespace=None, metric_name=None)[source]
The show_watch_metric method returns the datapoints associated
with a specified metric, or all metrics if no metric_name is passed
| Parameters: |
- ctxt – RPC context.
- namespace – Name of the namespace you want to see,
or None to see all
- metric_name – Name of the metric you want to see,
or None to see all
|
|---|
-
update_stack(ctxt, stack_identity, template, params, args)[source]
The update_stack method updates an existing stack based on the
provided template and parameters.
Note that at this stage the template has already been fetched from the
heat-api process if using a template-url.
| Parameters: |
- ctxt – RPC context.
- stack_name – Name of the stack you want to create.
- template – Template of stack you want to create.
- params – Stack Input Params
- args – Request parameters/args passed from API
|
|---|
-
validate_template(ctxt, template)[source]
The validate_template method uses the stack parser to check
the validity of a template.
| Parameters: |
- ctxt – RPC context.
- template – Template of stack you want to create.
- params – Params passed from API.
|
|---|