For details on how to use orchestration, see Using OpenStack Orchestration
The orchestration high-level interface is available through the orchestration member of a Connection object. The orchestration member will only be added if the service is detected.
Create a new stack from attributes
Parameters: | |
---|---|
Returns: | The results of stack creation |
Return type: |
Find a single stack
Parameters: |
|
---|---|
Returns: | One Stack or None |
Return a generator of stacks
Parameters: | **query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of stack objects |
Return type: | Stack |
Get a single stack
Parameters: | stack – The value can be the ID of a stack or a Stack instance. |
---|---|
Returns: | One Stack |
Raises: | ResourceNotFound when no resource can be found. |
Update a stack
Parameters: |
|
---|---|
Returns: | The updated stack |
Return type: | |
Raises: | ResourceNotFound when no resource can be found. |
Delete a stack
Parameters: |
|
---|---|
Returns: | None |
Check a stack’s status
Since this is an asynchronous action, the only way to check the result is to track the stack’s status.
Parameters: | stack – The value can be either the ID of a stack or an instance of Stack. |
---|---|
Returns: | None |
Return a generator of resources
Parameters: |
|
---|---|
Returns: | A generator of resource objects if the stack exists and there are resources in it. If the stack cannot be found, an exception is thrown. |
Return type: | A generator of Resource |
Raises: | ResourceNotFound when the stack cannot be found. |
Create a new software config from attributes
Parameters: | attrs (dict) – Keyword arguments which will be used to create a SoftwareConfig, comprised of the properties on the SoftwareConfig class. |
---|---|
Returns: | The results of software config creation |
Return type: | SoftwareConfig |
Returns a generator of software configs
Parameters: | query (dict) – Optional query parameters to be sent to limit the software configs returned. |
---|---|
Returns: | A generator of software config objects. |
Return type: |
SoftwareConfig
Get details about a specific software config.
Parameters: | software_config – The value can be the ID of a software config or a instace of SoftwareConfig, |
---|---|
Returns: | An object of type SoftwareConfig |
Delete a software config
Parameters: |
|
---|---|
Returns: | None |
Create a new software deployment from attributes
Parameters: | attrs (dict) – Keyword arguments which will be used to create a SoftwareDeployment, comprised of the properties on the SoftwareDeployment class. |
---|---|
Returns: | The results of software deployment creation |
Return type: | SoftwareDeployment |
Returns a generator of software deployments
Parameters: | query (dict) – Optional query parameters to be sent to limit the software deployments returned. |
---|---|
Returns: | A generator of software deployment objects. |
Return type: |
SoftwareDeployment
Get details about a specific software deployment resource
Parameters: | software_deployment – The value can be the ID of a software deployment or an instace of SoftwareDeployment, |
---|---|
Returns: | An object of type SoftwareDeployment |
Delete a software deployment
Parameters: |
|
---|---|
Returns: | None |
Update a software deployment
Parameters: |
|
---|---|
Returns: | The updated software deployment |
Return type: |
SoftwareDeployment
Validates a template.
Parameters: |
|
---|---|
Returns: | The result of template validation. |
Raises: | InvalidRequest if neither template not template_url is provided. |
Raises: | HttpException if the template fails the validation. |
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.