Client side of the heat engine RPC API.
Bases: heat.openstack.common.rpc.proxy.RpcProxy
Client side of the heat engine rpc API.
API version history:
1.0 - Initial version.
Verify that the credentials in the RPC context are valid for the current cloud backend.
Parameters: | ctxt – RPC context. |
---|
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: |
|
---|
This could be used by CloudWatch and WaitConditions and treat HA service events like any other CloudWatch. :param ctxt: RPC context. :param watch_name: Name of the watch/alarm :param stats_data: The data to post.
The delete_stack method deletes a given stack.
Parameters: |
|
---|
Get detailed resource information about a particular resource. :param ctxt: RPC context. :param stack_identity: Name of the stack. :param resource_name: the Resource.
Get detailed resource information about one or more resources. :param ctxt: RPC context. :param stack_identity: Name of the stack. :param resource_name: the Resource.
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.
Generate a template based on the specified type.
Parameters: |
|
---|
Get the template.
Parameters: |
|
---|
The identify_stack method returns the full stack identifier for a single, live stack given the stack name.
Parameters: |
|
---|
The list_events method lists all events associated with a given stack.
Parameters: |
|
---|
Get a list of valid resource types.
Parameters: | ctxt – RPC context. |
---|
List the resources belonging to a stack. :param ctxt: RPC context. :param stack_identity: Name of the stack.
The list_stacks method returns the attributes of all stacks.
Parameters: | ctxt – RPC context. |
---|
Update the metadata for the given resource.
Get the schema for a resource type.
Parameters: | ctxt – RPC context. |
---|
Generate an alarm on the resource. :param ctxt: RPC context. :param stack_identity: Name of the stack. :param resource_name: the Resource. :param details: the details of the signal.
Temporarily set the state of a given watch :param ctxt: RPC context. :param watch_name: Name of the watch :param state: State (must be one defined in WatchRule class)
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
The show_watch method returns the attributes of one watch or all watches if no watch_name is passed
Parameters: |
|
---|
The show_watch_metric method returns the datapoints associated with a specified metric, or all metrics if no metric_name is passed
Parameters: |
|
---|
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: |
|
---|
The validate_template method uses the stack parser to check the validity of a template.
Parameters: |
|
---|