serviceblueprint
This topic describes the verbs, command-line arguments, and API parameters available for the serviceblueprint noun in the BMC Cloud Lifecycle Management SDK.
create
Use serviceblueprint-create from the command line to create a service blueprint from the specified json file. If a blueprint with the same name already exists, a new version of that blueprint is created.
Use serviceblueprint_create in the API to create a service blueprint from the specified json file. If a blueprint with the same name already exists, a new version of that blueprint is created. This command returns a BlueprintDocument API object with the same attributes and relationships.
obj.guid # returns the GUID
obj.name # returns the name
...
Command-line argument | API parameter | Description | Required? |
|---|---|---|---|
--jsonfile | json_file | Path and name of the json file containing blueprint definition. | Yes |
--blueprintname | blueprint_name | Name of the service blueprint. If you do not specify a name, the name specified in the json file is used. |
|
--waitfor |
| Time in seconds to wait for a response from the server, otherwise return running task details. |
|
| gcac | GenericCloudAPIClient instance/user authentication. |
|
export
Use serviceblueprint-export from the command line to export the specified service blueprint version as a json file.
Use serviceblueprint_export in the API to export the specified service blueprint version as a json file. This command returns a BlueprintDocument API object with the same attributes and relationships.
obj.guid # returns the GUID
obj.name # returns the name
...
Command-line argument | API parameter | Description | Required? |
|---|---|---|---|
--blueprint | blueprint | Name of the service blueprint, or the GUID of a service blueprint version | Yes |
--outfile | file_name | Path and file name for the exported json file. | Yes |
--waitfor |
| Time in seconds to wait for a response from the server, otherwise return running task details. |
|
| gcac | GenericCloudAPIClient instance/user authentication. |
|
list
Use serviceblueprint-list from the command line to list available service blueprints.
Use serviceblueprint_list from the API to list available service blueprints. This command returns a list of BlueprintDocument API objects with the same attributes and relationships.
obj[n].guid returns the GUID
obj[n].name returns the name
...
Command-line argument | API parameter | Description | Required? |
|---|---|---|---|
-l |
| List all fields. This parameter does not need a value. |
|
-u |
| List only GUIDs. This parameter does not need a value. |
|
-n |
| List only names. This parameter does not need a value. |
|
-s |
| List GUIDs, names, and status (if applicable). This parameter does not need a value. |
|
-k |
| List the field names specified in the value for this parameter. |
|
--filter | filters | List the output that matches the specified filters. |
|
| gcac | GenericCloudAPIClient instance/user authentication. |
|