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.
clm serviceblueprint-create [-h] [--waitfor TIME_OUT_SECONDS] --jsonfile FILE_PATH [--blueprintname NAME]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 = serviceblueprint_create(gcac, blueprint_name=None, json_file=None)
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.
clm serviceblueprint-export [-h] [--waitfor TIME_OUT_SECONDS] --blueprint NAME|id:<GUID> --outfile FILE_PATHUse 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 = serviceblueprint_export(gcac, blueprint=None, file_name=None)
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.
clm serviceblueprint-list [-h] [-l] [-u] [-n] [-s] [-k FIELD_NAME [FIELD_NAME ...]]
[--filter FIELD_NAME=VALUE [FIELD_NAME=VALUE ...]]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 = serviceblueprint_list(gcac, filters=None)
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. |
make-latest
Use serviceblueprint-make-latest from the command line to mark the specified version of a service blueprint as the latest version.
clm serviceblueprint-make-latest [-h] [--waitfor TIME_OUT_SECONDS] --blueprint NAME|id:<GUID>
[--versionnumber VERSIONNUMBER]Use serviceblueprint_make_latest in the API to mark the specified version of a service blueprint as the latest version. This command returns a BlueprintDocument API object with the same attributes and relationships.
obj = serviceblueprint_make_latest(gcac, blueprint=None, versionnumber=None)
obj.guid # returns the GUID
obj.name # returns the name
...| Command-line argument | API parameter | Description | Required? |
|---|---|---|---|
--blueprint | blueprint | Name or GUID of the service blueprint. | Yes |
--versionnumber | versionnumber | Version number of the service blueprint. | |
--waitfor | Time in seconds to wait for a response from the server, otherwise return running task details. | ||
gcac | GenericCloudAPIClient instance/user authentication. |
map-to
Use serviceblueprint-map-to from the command line to map tags to artifacts defined in a service blueprint.
clm serviceblueprint-map-to [-h] [--waitfor TIME_OUT_SECONDS] --blueprint NAME|id:<GUID>
--tag GROUP[TAG1,TAG2,...] --configuration NAME [--resourceset NAME] [--versionnumber VERSIONNUMBER]Use serviceblueprint_map in the API to map tags to artifacts defined in a service blueprint. This command returns a BlueprintDocument API object with the same attributes and relationships.
obj = serviceblueprint_map(gcac, blueprint=None, resourceset=None, configuration=None,
versionnumber=None, tagList=None)
obj.guid # returns the GUID
obj.name # returns the name
...| Command-line argument | API parameter | Description | Required? |
|---|---|---|---|
--blueprint | blueprint | Name or GUID of the service blueprint. | Yes |
--tag | tagList | List of tags to map. | Yes |
--configuration | configuration | Name of the deployment model. | Yes |
--resourceset | resourceset | Name of the resource set. | |
--versionnumber | versionnumber | Version number of the service blueprint. | |
--waitfor | Time in seconds to wait for a response from the server, otherwise return running task details. | ||
gcac | GenericCloudAPIClient instance/user authentication. |
unmap-to
Use serviceblueprint-unmap-to from the command line to unmap tags from artifacts defined in a service blueprint.
clm serviceblueprint-unmap-to [-h] [--waitfor TIME_OUT_SECONDS] --blueprint NAME|id:<GUID>
--tag GROUP[TAG1,TAG2,...] --configuration NAME [--resourceset NAME] [--versionnumber VERSIONNUMBER]Use serviceblueprint_unmap in the API to unmap tags from artifacts defined in a service blueprint. This command returns a BlueprintDocument API object with the same attributes and relationships.
obj = serviceblueprint_unmap(gcac, blueprint=None, resourceset=None, configuration=None,
versionnumber=None, tagList=None)
obj.guid # returns the GUID
obj.name # returns the name
...| Command-line argument | API parameter | Description | Required? |
|---|---|---|---|
--blueprint | blueprint | Name or GUID of the service blueprint. | Yes |
--tag | tagList | List of tags to unmap. | Yes |
--configuration | configuration | Name of the deployment model. | Yes |
--resourceset | resourceset | Name of the resource set. | |
--versionnumber | versionnumber | Version number of the service blueprint. | |
--waitfor | Time in seconds to wait for a response from the server, otherwise return running task details. | ||
gcac | GenericCloudAPIClient instance/user authentication. |
Comments
Log in or register to comment.