Managing versions using commands

Each blueprint in a catalog must have a unique name (template_name). Dell Cloud Manager allows you to maintain multiple versions of a blueprint (template_version). However only one version of a blueprint can exist in a catalog (be active) and be available for non administrator users to launch stacks from.

You can manage all versions of a blueprint using the Blueprint Tools commands.

  • You can list the active blueprints in a catalog using the list-blueprints command.
  • You can list the top level blueprints using the list-blueprints-admin command. A top level blueprint is either the active blueprint or the highest version of a blueprint in a version set if none are marked as active.
  • You can list all versions of a blueprint using the list-blueprint-versions command.
  • You can change a blueprint version to be active or inactive using the update-blueprint-activeversion command.
  • You can create a new version of a blueprint and make it active using the create-blueprint command.
  • You can update a blueprint using the update-blueprint command. The updated blueprint becomes the active blueprint version.
  • You can delete a blueprint using the delete-blueprint command.

list-blueprints

Example

List the active blueprints in the company catalog.

list-blueprints
Loading API environment
  API access validated
  API access key type is User, userId: 10
  Found public catalog, id= 15
  Found Company catalog, id= 10
Defaulting to Company catalog, id: 10

Number of Blueprints found: 1

+----+----------------------------+-------------------------------------------------------------------------+---------+------------------------------+---------+
| Id | Name                       | Description                                                             | Version | Created                      | Updated |
+----+----------------------------+-------------------------------------------------------------------------+---------+------------------------------+---------+
| 52 | Apache Web Server on Linux | Deploys an Apache Web Server single server stack without Chef or Puppet | 1.10    | 2015-09-09T14:45:43.516+0000 | None    |
+----+----------------------------+-------------------------------------------------------------------------+---------+------------------------------+---------+

See also

For more details on the list-blueprints command including additional options refer to the list-blueprints command reference page in this document.

list-blueprints-admin

Example

List the top level blueprints in the company catalog.

list-blueprints-admin
Loading API environment
  API access validated
  API access key type is User, userId: 10
  Found public catalog, id= 15
  Found Company catalog, id= 10
Defaulting to Company catalog, id: 10

Number of Blueprints found: 2

+----+--------+------------------------------------+---------+---------------+------------------------------+------------------------------+
| Id | Parent | Name                               | Version | ActiveVersion | Created                      | Updated                      |
+----+--------+------------------------------------+---------+---------------+------------------------------+------------------------------+
| 52 | 51     | Apache Web Server on Linux         | 1.10    | True          | 2015-09-09T14:45:43.516+0000 | None                         |
| 53 | 53     | Drupal Two Server Stack using Chef | 2.00    | False         | 2015-09-09T14:56:51.130+0000 | 2015-09-09T14:57:36.124+0000 |
+----+--------+------------------------------------+---------+---------------+------------------------------+------------------------------+

See also

For more details on the list-blueprints-admin command including additional options refer to the list-blueprints-admin command reference page in this document.

list-blueprint-versions

Example

List all versions of a blueprint. You are required to specify the top level version of the blueprint.

list-blueprint-versions 51
Loading API environment
  API access validated
  API access key type is User, userId: 10
  Found public catalog, id= 15
  Found Company catalog, id= 10

Number of Blueprints found: 3

+----+--------+----------------------------+---------+---------------+------------------------------+------------------------------+
| Id | Parent | Name                       | Version | ActiveVersion | Created                      | Updated                      |
+----+--------+----------------------------+---------+---------------+------------------------------+------------------------------+
| 51 | 51     | Apache Web Server on Linux | 1.00    | False         | 2015-09-09T14:44:59.656+0000 | 2015-09-09T14:45:43.516+0000 |
| 52 | 51     | Apache Web Server on Linux | 1.10    | False         | 2015-09-09T14:45:43.516+0000 | 2015-09-09T15:05:12.028+0000 |
| 54 | 51     | Apache Web Server on Linux | 1.10.1  | True          | 2015-09-09T15:05:12.028+0000 | None                         |
+----+--------+----------------------------+---------+---------------+------------------------------+------------------------------+

See also

For more details on the list-blueprint-versions command including additional options refer to the list-blueprint-versions command reference page in this document.

update-blueprint-activeversion

Example

Make a blueprint version active in the company catalog.

update-blueprint-activeversion 52
Loading API environment
  API access validated
  API access key type is User, userId: 10
  Found public catalog, id= 15
  Found Company catalog, id= 10
Defaulting to Company catalog, id: 10
Update id: 52 ActiveVerson: True
Updated id: 52 name='Apache Web Server on Linux'

Example

Make a blueprint version not active in the company catalog.

update-blueprint-activeversion --not-active 51
Loading API environment
  API access validated
  API access key type is User, userId: 10
  Found public catalog, id= 15
  Found Company catalog, id= 10
Defaulting to Company catalog, id: 10
Update id: 51 ActiveVerson: False
Updated id: 51 name='Apache Web Server on Linux'

List the blueprint versions.

list-blueprint-versions 51
Loading API environment
  API access validated
  API access key type is User, userId: 10
  Found public catalog, id= 15
  Found Company catalog, id= 10

Number of Blueprints found: 3

+----+--------+----------------------------+---------+---------------+------------------------------+------------------------------+
| Id | Parent | Name                       | Version | ActiveVersion | Created                      | Updated                      |
+----+--------+----------------------------+---------+---------------+------------------------------+------------------------------+
| 51 | 51     | Apache Web Server on Linux | 1.00    | False         | 2015-09-09T14:44:59.656+0000 | 2015-09-09T16:30:19.585+0000 |
| 52 | 51     | Apache Web Server on Linux | 1.10    | False         | 2015-09-09T14:45:43.516+0000 | 2015-09-09T16:29:37.370+0000 |
| 54 | 51     | Apache Web Server on Linux | 1.10.1  | False         | 2015-09-09T15:05:12.028+0000 | 2015-09-09T15:24:04.220+0000 |
+----+--------+----------------------------+---------+---------------+------------------------------+------------------------------+

See also

For more details on the update-blueprint-activeversion command including additional options refer to the update-blueprint-activeversion command reference page in this document.

create-blueprint (new version)

If you issue the create-blueprint and specify a blueprint template file with a different version, a new blueprint version will be created and will become the active version. Prior versions of that blueprint will still exist in Dell Cloud Manager as inactive and they will not appear in the catalog when launching blueprints.

Example

Currently only version 1.00 of the “Apache Web Server on Linux” blueprint exists in DCM and it is the active version.

list-blueprint-versions 55
Loading API environment
  API access validated
  API access key type is User, userId: 10
  Found public catalog, id= 15
  Found Company catalog, id= 10

Number of Blueprints found: 1

+----+--------+----------------------------+---------+---------------+------------------------------+---------+
| Id | Parent | Name                       | Version | ActiveVersion | Created                      | Updated |
+----+--------+----------------------------+---------+---------------+------------------------------+---------+
| 55 | 55     | Apache Web Server on Linux | 1.00    | True          | 2015-09-09T16:55:36.981+0000 | None    |
+----+--------+----------------------------+---------+---------------+------------------------------+---------+

To create a new version of that blueprint the blueprint template yaml file is updated which includes updating the template_version: value from 1.00 to 1.10. Then the create-blueprint command is issued.

create-blueprint apache_web_server_no_cm.yaml --imports base_types.yaml --imagefile dcm_sample_icon.png
Loading API environment
  API access validated
  API access key type is User, userId: 10
  Found public catalog, id= 15
  Found Company catalog, id= 10
Defaulting to Company catalog, id: 10
  Including import: "base_types.yaml"
  Including image file: "dcm_sample_icon.png"
Adding new version of blueprint to catalog 10, activeVersion=True, name= "Apache Web Server on Linux", parentBlueprintId=55
  Added new version: 1.10 of blueprint: "Apache Web Server on Linux" , id: 56, parent id: 55

Now listing the blueprint versions shows version 1.00 of the “Apache Web Server on Linux” blueprint is inactive and the newly created version 1.10 is the active blueprint version.

list-blueprint-versions 55
Loading API environment
  API access validated
  API access key type is User, userId: 10
  Found public catalog, id= 15
  Found Company catalog, id= 10

Number of Blueprints found: 2

+----+--------+----------------------------+---------+---------------+------------------------------+------------------------------+
| Id | Parent | Name                       | Version | ActiveVersion | Created                      | Updated                      |
+----+--------+----------------------------+---------+---------------+------------------------------+------------------------------+
| 55 | 55     | Apache Web Server on Linux | 1.00    | False         | 2015-09-09T16:55:36.981+0000 | 2015-09-09T17:01:19.692+0000 |
| 56 | 55     | Apache Web Server on Linux | 1.10    | True          | 2015-09-09T17:01:19.692+0000 | None                         |
+----+--------+----------------------------+---------+---------------+------------------------------+------------------------------+

See also

For more details on the create-blueprint command including additional options refer to the create-blueprint command reference page in this document.

update-blueprint

You can update any blueprint (any version) using the update-blueprint command. That blueprint becomes the active blueprint version. You can also change the version number of a blueprint.

Example

The following versions of the “Apache Web Server on Linux” blueprint exists in DCM: 1.00, 1.10 and 1.10.1 in the company catalog. Version 1.10.1 is the active blueprint version.

list-blueprint-versions 10
Loading API environment
  API access validated
  API access key type is User, userId: 10
  Found Company catalog, id= 10

Number of Blueprints found: 3

+----+--------+----------------------------+---------+---------------+------------------------------+------------------------------+
| Id | Parent | Name                       | Version | ActiveVersion | Created                      | Updated                      |
+----+--------+----------------------------+---------+---------------+------------------------------+------------------------------+
| 10 | 10     | Apache Web Server on Linux | 1.00    | False         | 2015-09-09T19:21:58.681+0000 | 2015-09-09T19:26:32.622+0000 |
| 11 | 10     | Apache Web Server on Linux | 1.10    | False         | 2015-09-09T19:26:32.622+0000 | 2015-09-09T19:26:47.760+0000 |
| 12 | 10     | Apache Web Server on Linux | 1.10.1  | True          | 2015-09-09T19:26:47.760+0000 | None                         |
+----+--------+----------------------------+---------+---------------+------------------------------+------------------------------+

To update the “Apache Web Server on Linux” active blueprint version 1.10.1 (Id 12) in the company catalog.

update-blueprint --imports base_types.yaml --imagefile dcm_sample_icon.png 12 apache_web_server_no_cm.yaml
Loading API environment
  API access validated
  API access key type is User, userId: 10
  Found Company catalog, id= 10
Defaulting to Company catalog, id: 10
  Including import: "base_types.yaml"
  Including image file: "dcm_sample_icon.png"
Updated id: 12 name='Apache Web Server on Linux'

Example

To update the “Apache Web Server on Linux” inactive blueprint version 1.10 (Id 11) in the company catalog.

update-blueprint --imports base_types.yaml --imagefile dcm_sample_icon.png 11 apache_web_server_no_cm.yaml
Loading API environment
  API access validated
  API access key type is User, userId: 10
  Found Company catalog, id= 10
Defaulting to Company catalog, id: 10
  Including import: "base_types.yaml"
  Including image file: "dcm_sample_icon.png"
Updated id: 11 name='Apache Web Server on Linux'

Now listing the blueprint versions shows version 1.10 of the “Apache Web Server on Linux” blueprint is the active blueprint version.

list-blueprint-versions 10
Loading API environment
  API access validated
  API access key type is User, userId: 10
  Found Company catalog, id= 10

Number of Blueprints found: 3

+----+--------+----------------------------+---------+---------------+------------------------------+------------------------------+
| Id | Parent | Name                       | Version | ActiveVersion | Created                      | Updated                      |
+----+--------+----------------------------+---------+---------------+------------------------------+------------------------------+
| 10 | 10     | Apache Web Server on Linux | 1.00    | False         | 2015-09-09T19:21:58.681+0000 | 2015-09-09T19:26:32.622+0000 |
| 11 | 10     | Apache Web Server on Linux | 1.10    | True          | 2015-09-09T19:26:32.622+0000 | 2015-09-09T20:23:15.088+0000 |
| 12 | 10     | Apache Web Server on Linux | 1.10.1  | False         | 2015-09-09T19:26:47.760+0000 | 2015-09-09T20:23:15.088+0000 |
+----+--------+----------------------------+---------+---------------+------------------------------+------------------------------+

See also

For more details on the update-blueprint command including additional options refer to the update-blueprint command reference page in this document.

delete-blueprint

You can delete any blueprint (any version) using the delete-blueprint command.

Example

To delete the “Apache Web Server on Linux” active blueprint version 1.10 (Id 11) from the company catalog.

delete-blueprint 11
Loading API environment
  API access validated
  API access key type is User, userId: 10
  Found public catalog, id= 15
  Found Company catalog, id= 10
Defaulting to Company catalog, id: 10
Blueprint deleted.

Example

To delete the “Apache Web Server on Linux” inactive blueprint version 1.00 (Id 10) from the company catalog.

delete-blueprint 10
Loading API environment
  API access validated
  API access key type is User, userId: 10
  Found public catalog, id= 15
  Found Company catalog, id= 10
Defaulting to Company catalog, id: 10
Blueprint deleted.

See also

For more details on the delete-blueprint command including additional options refer to the delete-blueprint command reference page in this document.