Plugin Commands¶
- application_catalog –
- baremetal – OpenStackClient plugin for Bare Metal service.
- baremetal-introspection – OpenStackClient plugin for Ironic Inspector.
- clustering – OpenStackClient plugin for Clustering service.
- congressclient –
- data_processing – OpenStackClient plugin for Data Processing service.
- dns – OpenStackClient plugin for DNS service.
- key_manager –
- messaging –
- metric –
- neutronclient –
- orchestration –
- search –
- workflow_engine –
aodh¶
alarm create¶
Create an alarm
alarm delete¶
Delete an alarm
alarm list¶
List alarms
alarm show¶
Show an alarm
alarm state get¶
Delete an alarm
alarm state set¶
Delete an alarm
alarm update¶
Update an alarm
alarm-history search¶
Show history for all alarms based on query
alarm-history show¶
Show history for an alarm
alarming capabilities list¶
List capabilities
barbican¶
acl_delete¶
Delete ACLs for a secret or container as identified by its href.
acl_get¶
Retrieve ACLs for a secret or container by providing its href.
acl_submit¶
Submit ACL on a secret or container as identified by its href.
acl_user_add¶
Add ACL users to a secret or container as identified by its href.
acl_user_remove¶
Remove ACL users from a secret or container as identified by its href.
ca_get¶
Retrieve a CA by providing its URI.
ca_list¶
List cas.
secret_container_create¶
Store a container in Barbican.
secret_container_delete¶
Delete a container by providing its href.
secret_container_get¶
Retrieve a container by providing its URI.
secret_container_list¶
List containers.
secret_delete¶
Delete a secret by providing its URI.
secret_get¶
Retrieve a secret by providing its URI.
secret_list¶
List secrets.
secret_order_create¶
Create a new order.
secret_order_delete¶
Delete an order by providing its href.
secret_order_get¶
Retrieve an order by providing its URI.
secret_order_list¶
List orders.
secret_store¶
Store a secret in Barbican.
secret_update¶
Update a secret with no payload in Barbican.
congress¶
congress_datasource_actions_show¶
List supported actions for datasource.
congress_datasource_create¶
Create a datasource.
congress_datasource_delete¶
Delete a datasource.
congress_datasource_list¶
List Datasources.
congress_datasource_request-refresh¶
Trigger a datasource to poll.
congress_datasource_row_list¶
List datasource rows.
congress_datasource_row_update¶
Update rows to a datasource table.
congress_datasource_schema_show¶
Show schema for datasource.
congress_datasource_status_show¶
List status for datasource.
congress_datasource_table_list¶
List datasource tables.
congress_datasource_table_schema_show¶
Show schema for datasource table.
congress_datasource_table_show¶
Show Datasource Table properties.
congress_driver_config_show¶
List driver tables.
congress_driver_list¶
List drivers.
congress_driver_schema_show¶
List datasource tables.
congress_policy_create¶
Create a policy.
congress_policy_delete¶
Delete a policy.
congress_policy_list¶
List Policy.
congress_policy_row_list¶
List policy rows.
congress_policy_rule_create¶
Create a policy rule.
congress_policy_rule_delete¶
Delete a policy rule.
congress_policy_rule_list¶
List policy rules.
congress_policy_rule_show¶
Show a policy rule.
congress_policy_show¶
Show policy properties.
congress_policy_simulate¶
Show the result of simulation.
congress_policy_table_list¶
List policy tables.
congress_policy_table_show¶
Show policy table properties.
congress_version_list¶
List API Versions.
designate¶
heat¶
orchestration_build_info¶
Retrieve build information.
orchestration_resource_type_list¶
List resource types.
orchestration_resource_type_show¶
Show details and optionally generate a template for a resource type.
orchestration_service_list¶
List the Heat engines.
orchestration_template_function_list¶
List the available functions.
orchestration_template_validate¶
Validate a template
orchestration_template_version_list¶
List the available template versions.
software_config_create¶
Create software config
software_config_delete¶
Delete software configs
software_config_list¶
List software configs
software_config_show¶
Show software config details
software_deployment_create¶
Create a software deployment.
software_deployment_delete¶
Delete software deployment(s) and correlative config(s).
software_deployment_list¶
List software deployments.
software_deployment_metadata_show¶
Get deployment configuration metadata for the specified server.
software_deployment_output_show¶
Show a specific deployment output.
software_deployment_show¶
Show SoftwareDeployment Details.
stack_abandon¶
Abandon stack and output results.
stack_adopt¶
Adopt a stack.
stack_check¶
Check a stack.
stack_create¶
Create a stack.
stack_delete¶
Delete stack(s).
stack_environment_show¶
Show a stack’s environment.
stack_event_list¶
List events.
stack_event_show¶
Show event details.
stack_failures_list¶
Show information about failed stack resources.
stack_file_list¶
Show a stack’s files map.
stack_hook_clear¶
Clear resource hooks on a given stack.
stack_hook_poll¶
List resources with pending hook for a stack.
stack_list¶
List stacks.
stack_output_list¶
List stack outputs.
stack_output_show¶
Show stack output.
stack_resource_list¶
List stack resources.
stack_resource_mark_unhealthy¶
Set resource’s health.
stack_resource_metadata¶
Show resource metadata
stack_resource_show¶
Display stack resource.
stack_resource_signal¶
Signal a resource with optional data.
stack_resume¶
Resume a stack.
stack_show¶
Show stack details.
stack_snapshot_create¶
Create stack snapshot.
stack_snapshot_delete¶
Delete stack snapshot.
stack_snapshot_list¶
List stack snapshots.
stack_snapshot_restore¶
Restore stack snapshot
stack_snapshot_show¶
Show stack snapshot.
stack_suspend¶
Suspend a stack.
stack_template_show¶
Display stack template.
stack_update¶
Update a stack.
ironic¶
baremetal_chassis_create¶
Create a new chassis.
baremetal_chassis_delete¶
Delete a chassis.
baremetal_chassis_list¶
List the chassis.
baremetal_chassis_set¶
Set chassis properties.
baremetal_chassis_show¶
Show chassis details.
baremetal_chassis_unset¶
Unset chassis properties.
baremetal_create¶
Create resources from files or Register a new node (DEPRECATED).
Create resources from files (by only specifying the files) or register a new node by specifying one or more optional arguments (DEPRECATED, use ‘openstack baremetal node create’ instead).
baremetal_delete¶
Unregister a baremetal node. DEPRECATED
baremetal_driver_list¶
List the enabled drivers.
baremetal_driver_passthru_call¶
Call a vendor passthru method for a driver.
baremetal_driver_passthru_list¶
List available vendor passthru methods for a driver.
baremetal_driver_show¶
Show information about a driver.
baremetal_list¶
List baremetal nodes. DEPRECATED
baremetal_node_abort¶
Set provision state of baremetal node to ‘abort’
baremetal_node_adopt¶
Set provision state of baremetal node to ‘adopt’
baremetal_node_boot_device_set¶
Set the boot device for a node
baremetal_node_boot_device_show¶
Show the boot device information for a node
baremetal_node_clean¶
Set provision state of baremetal node to ‘clean’
baremetal_node_console_disable¶
Disable console access for a node
baremetal_node_console_enable¶
Enable console access for a node
baremetal_node_console_show¶
Show console information for a node
baremetal_node_create¶
Register a new node with the baremetal service
baremetal_node_delete¶
Unregister baremetal node(s)
baremetal_node_deploy¶
Set provision state of baremetal node to ‘deploy’
baremetal_node_inspect¶
Set provision state of baremetal node to ‘inspect’
baremetal_node_list¶
List baremetal nodes
baremetal_node_maintenance_set¶
Set baremetal node to maintenance mode
baremetal_node_maintenance_unset¶
Unset baremetal node from maintenance mode
baremetal_node_manage¶
Set provision state of baremetal node to ‘manage’
baremetal_node_passthru_call¶
Call a vendor passthu method for a node
baremetal_node_passthru_list¶
List vendor passthru methods for a node
baremetal_node_power¶
Set power state of baremetal node
baremetal_node_provide¶
Set provision state of baremetal node to ‘provide’
baremetal_node_reboot¶
Reboot baremetal node
baremetal_node_rebuild¶
Set provision state of baremetal node to ‘rebuild’
baremetal_node_set¶
Set baremetal properties
baremetal_node_show¶
Show baremetal node details
baremetal_node_undeploy¶
Set provision state of baremetal node to ‘deleted’
baremetal_node_unset¶
Unset baremetal properties
baremetal_node_validate¶
Validate a node’s driver interfaces
baremetal_port_create¶
Create a new port
baremetal_port_delete¶
Delete port(s).
baremetal_port_list¶
List baremetal ports.
baremetal_port_set¶
Set baremetal port properties.
baremetal_port_show¶
Show baremetal port details.
baremetal_port_unset¶
Unset baremetal port properties.
baremetal_set¶
Set baremetal properties. DEPRECATED
baremetal_show¶
Show baremetal node details. DEPRECATED
baremetal_unset¶
Unset baremetal properties. DEPRECATED
ironic-inspector¶
baremetal_introspection_abort¶
Abort running introspection for node.
baremetal_introspection_data_save¶
Save or display raw introspection data.
baremetal_introspection_reprocess¶
Reprocess stored introspection data
baremetal_introspection_rule_delete¶
Delete an introspection rule.
baremetal_introspection_rule_import¶
Import one or several introspection rules from a json file.
baremetal_introspection_rule_list¶
List all introspection rules.
baremetal_introspection_rule_purge¶
Drop all introspection rules.
baremetal_introspection_rule_show¶
Show an introspection rule.
baremetal_introspection_start¶
Start the introspection.
baremetal_introspection_status¶
Get introspection status.
mistral¶
action_definition_create¶
Create new action.
action_definition_definition_show¶
Show action definition.
action_definition_delete¶
Delete action.
action_definition_list¶
List all actions.
action_definition_show¶
Show specific action.
action_definition_update¶
Update action.
action_execution_delete¶
Delete action execution.
action_execution_input_show¶
Show Action execution input data.
action_execution_list¶
List all Action executions.
action_execution_output_show¶
Show Action execution output data.
action_execution_run¶
Create new Action execution or just run specific action.
action_execution_show¶
Show specific Action execution.
action_execution_update¶
Update specific Action execution.
cron_trigger_create¶
Create new trigger.
cron_trigger_delete¶
Delete trigger.
cron_trigger_list¶
List all cron triggers.
cron_trigger_show¶
Show specific cron trigger.
resource_member_create¶
Shares a resource to another tenant.
resource_member_delete¶
Delete a resource sharing relationship.
resource_member_list¶
List all members.
resource_member_show¶
Show specific member information.
resource_member_update¶
Update resource sharing status.
task_execution_list¶
List all tasks.
task_execution_published_show¶
Show task published variables.
task_execution_rerun¶
Rerun an existing task.
task_execution_result_show¶
Show task output data.
task_execution_show¶
Show specific task.
workbook_create¶
Create new workbook.
workbook_definition_show¶
Show workbook definition.
workbook_delete¶
Delete workbook.
workbook_list¶
List all workbooks.
workbook_show¶
Show specific workbook.
workbook_update¶
Update workbook.
workbook_validate¶
Validate workbook.
workflow_create¶
Create new workflow.
workflow_definition_show¶
Show workflow definition.
workflow_delete¶
Delete workflow.
workflow_engine_service_list¶
List all services.
workflow_env_create¶
Create new environment.
workflow_env_delete¶
Delete environment.
workflow_env_list¶
List all environments.
workflow_env_show¶
Show specific environment.
workflow_env_update¶
Update environment.
workflow_execution_create¶
Create new execution.
workflow_execution_delete¶
Delete execution.
workflow_execution_input_show¶
Show execution input data.
workflow_execution_list¶
List all executions.
workflow_execution_output_show¶
Show execution output data.
workflow_execution_show¶
Show specific execution.
workflow_execution_update¶
Update execution.
workflow_list¶
List all workflows.
workflow_show¶
Show specific workflow.
workflow_update¶
Update workflow.
workflow_validate¶
Validate workflow.
murano¶
category_create¶
Create a category.
category_delete¶
Delete a category.
category_list¶
List all available categories.
category_show¶
Display category details.
class-schema¶
Show class schema.
deployment_list¶
List deployments for an environment.
environment_apps_edit¶
Edit environment’s object model.
FILE is path to a file, that contains jsonpatch, that describes changes to be made to environment’s object-model.
- [
- { “op”: “add”, “path”: “/-”,
- “value”: { ... your-app object model here ... }
}, { “op”: “replace”, “path”: “/0/?/name”,
“value”: “new_name”},
]
NOTE: Values ‘===id1===’, ‘===id2===’, etc. in the resulting object-model will be substituted with uuids.
For more info on jsonpatch see RFC 6902
environment_create¶
Create an environment.
environment_delete¶
Delete an environment.
environment_deploy¶
Start deployment of a murano environment session.
environment_list¶
Lists environments
environment_rename¶
Rename an environment.
environment_session_create¶
Creates a new configuration session for environment ID.
environment_show¶
Display environment details
package_create¶
Create an application package.
static-action_call¶
Call static method of the MuranoPL class.
neutron¶
network_subport_list¶
List all subports for a given network trunk
network_trunk_create¶
Create a network trunk for a given project
network_trunk_delete¶
Delete a given network trunk
network_trunk_list¶
List all network trunks
network_trunk_set¶
Set network trunk properties
network_trunk_show¶
Show information of a given network trunk
network_trunk_unset¶
Unset subports from a given network trunk
sahara¶
dataprocessing_cluster_create¶
Creates cluster
dataprocessing_cluster_delete¶
Deletes cluster
dataprocessing_cluster_list¶
Lists clusters
dataprocessing_cluster_scale¶
Scales cluster
dataprocessing_cluster_show¶
Display cluster details
dataprocessing_cluster_template_create¶
Creates cluster template
dataprocessing_cluster_template_delete¶
Deletes cluster template
dataprocessing_cluster_template_list¶
Lists cluster templates
dataprocessing_cluster_template_show¶
Display cluster template details
dataprocessing_cluster_template_update¶
Updates cluster template
dataprocessing_cluster_update¶
Updates cluster
dataprocessing_cluster_verification¶
Updates cluster verifications
dataprocessing_data_source_create¶
Creates data source
dataprocessing_data_source_delete¶
Delete data source
dataprocessing_data_source_list¶
Lists data sources
dataprocessing_data_source_show¶
Display data source details
dataprocessing_data_source_update¶
Update data source
dataprocessing_image_list¶
Lists registered images
dataprocessing_image_register¶
Register an image
dataprocessing_image_show¶
Display image details
dataprocessing_image_tags_add¶
Add image tags
dataprocessing_image_tags_remove¶
Remove image tags
dataprocessing_image_tags_set¶
Set image tags (Replace current image tags with provided ones)
dataprocessing_image_unregister¶
Unregister image(s)
dataprocessing_job_binary_create¶
Creates job binary
dataprocessing_job_binary_delete¶
Deletes job binary
dataprocessing_job_binary_download¶
Downloads job binary
dataprocessing_job_binary_list¶
Lists job binaries
dataprocessing_job_binary_show¶
Display job binary details
dataprocessing_job_binary_update¶
Updates job binary
dataprocessing_job_delete¶
Deletes job
dataprocessing_job_execute¶
Executes job
dataprocessing_job_list¶
Lists jobs
dataprocessing_job_show¶
Display job details
dataprocessing_job_template_create¶
Creates job template
dataprocessing_job_template_delete¶
Deletes job template
dataprocessing_job_template_list¶
Lists job templates
dataprocessing_job_template_show¶
Display job template details
dataprocessing_job_template_update¶
Updates job template
dataprocessing_job_type_configs_get¶
Get job type configs
dataprocessing_job_type_list¶
Lists job types supported by plugins
dataprocessing_job_update¶
Updates job
dataprocessing_node_group_template_create¶
Creates node group template
dataprocessing_node_group_template_delete¶
Deletes node group template
dataprocessing_node_group_template_list¶
Lists node group templates
dataprocessing_node_group_template_show¶
Display node group template details
dataprocessing_node_group_template_update¶
Updates node group template
dataprocessing_plugin_configs_get¶
Get plugin configs
dataprocessing_plugin_list¶
Lists plugins
dataprocessing_plugin_show¶
Display plugin details
dataprocessing_plugin_update¶
Warning
No documentation found in dataprocessing_plugin_update = saharaclient.osc.v1.plugins:UpdatePlugin
searchlight¶
search_facet_list¶
List Searchlight Facet.
search_query¶
Search Searchlight resource.
search_resource_type_list¶
List Searchlight Resource Type (Plugin).
senlin¶
cluster_action_list¶
List actions.
cluster_action_show¶
Show detailed info about the specified action.
cluster_build_info¶
Retrieve build information.
cluster_check¶
Check the cluster(s).
cluster_collect¶
Collect attributes across a cluster.
cluster_create¶
Create the cluster.
cluster_delete¶
Delete the cluster(s).
cluster_event_list¶
List events.
cluster_event_show¶
Describe the event.
cluster_expand¶
Scale out a cluster by the specified number of nodes.
cluster_list¶
List the user’s clusters.
cluster_members_add¶
Add specified nodes to cluster.
cluster_members_del¶
Delete specified nodes from cluster.
cluster_members_list¶
List nodes from cluster.
cluster_node_check¶
Check the node(s).
cluster_node_create¶
Create the node.
cluster_node_delete¶
Delete the node(s).
cluster_node_list¶
Show list of nodes.
cluster_node_recover¶
Recover the node(s).
cluster_node_show¶
Show detailed info about the specified node.
cluster_node_update¶
Update the node.
cluster_policy_attach¶
Attach policy to cluster.
cluster_policy_binding_list¶
List policies from cluster.
cluster_policy_binding_show¶
Show a specific policy that is bound to the specified cluster.
cluster_policy_binding_update¶
Update a policy’s properties on a cluster.
cluster_policy_create¶
Create a policy.
cluster_policy_delete¶
Delete policy(s).
cluster_policy_detach¶
Detach policy from cluster.
cluster_policy_list¶
List policies that meet the criteria.
cluster_policy_show¶
Show the policy details.
cluster_policy_type_list¶
List the available policy types.
cluster_policy_type_show¶
Get the details about a policy type.
cluster_policy_update¶
Update a policy.
cluster_policy_validate¶
Validate a policy.
cluster_profile_create¶
Create a profile.
cluster_profile_delete¶
Delete profile(s).
cluster_profile_list¶
List profiles that meet the criteria.
cluster_profile_show¶
Show profile details.
cluster_profile_type_list¶
List the available profile types.
cluster_profile_type_show¶
Show the details about a profile type.
cluster_profile_update¶
Update a profile.
cluster_profile_validate¶
Validate a profile.
cluster_receiver_create¶
Create a receiver.
cluster_receiver_delete¶
Delete receiver(s).
cluster_receiver_list¶
List receivers that meet the criteria.
cluster_receiver_show¶
Show the receiver details.
cluster_recover¶
Recover the cluster(s).
cluster_resize¶
Resize a cluster.
cluster_run¶
Run scripts on cluster.
cluster_show¶
Show details of the cluster.
cluster_shrink¶
Scale in a cluster by the specified number of nodes.
cluster_update¶
Update the cluster.
zaqar¶
claim_create¶
Create claim and return a list of claimed messages
claim_query¶
Display claim details
claim_release¶
Delete a claim
claim_renew¶
Renew a claim
messaging_flavor_create¶
Create a pool flavor
messaging_flavor_delete¶
Delete a flavor
messaging_flavor_list¶
List available flavors
messaging_flavor_show¶
Display flavor details
messaging_flavor_update¶
Update a flavor’s attributes
messaging_health¶
Display detailed health status of Zaqar server
messaging_ping¶
Check if Zaqar server is alive or not
pool_create¶
Create a pool
pool_delete¶
Delete a pool
pool_list¶
List available Pools
pool_show¶
Display pool details
pool_update¶
Update a pool attribute
queue_create¶
Create a queue
queue_delete¶
Delete a queue
queue_get_metadata¶
Get queue metadata
queue_list¶
List available queues
queue_set_metadata¶
Set queue metadata
queue_signed_url¶
Create a queue
queue_stats¶
Get queue stats
subscription_create¶
Create a subscription for queue
subscription_delete¶
Delete a subscription
subscription_list¶
List available subscriptions
subscription_show¶
Display subscription details
subscription_update¶
Update a subscription