create-blueprint command

Note

The create-blueprint command is included with the Dell Cloud Manager Blueprint Tools commands. These commands need to be installed and setup. Refer to the Prerequisites section in this document for instructions on how to install and setup these commands if you have not done so already.

To create a blueprint from a template execute the create-blueprint command and pass it the following arguments:

  • main_template_file
  • --publicCatalog
The --publicCatalog parameter is used to specify that the blueprint is to be added to the public catalog. The --publicCatalog parameter is optional.
  • --catalogid catalog_id

The --catalogid argument is used to specify the internal ID of the catalog where the blueprint will be created in. The --catalogid argument is optional.

Note

The --publicCatalog command argument and the --catalogid command argument are mutually exclusive. If neither are specified then the catalog associated with the company of the user running the create-blueprint command (determined by the User API key) will be used.

  • --groupids one_or_more_group_ids_separated_by_a_comma
When creating a blueprint you can assign one or more owning groups (by group ID) to the blueprint to control/restrict access to it. The --groupids parameter is optional.
  • --imagefile icon_image_file
When creating a blueprint you can add an image icon to be displayed on the blueprint. Maximum image size is 64x64 pixels. The --imagefile parameter is optional.
  • --imports one_or_more_template_files_separated_by_a_comma

Note

You must specify the base_types.yaml file (this contains the TOSCA Dell Cloud Manager node types, relationships, and capability types which are referenced in the template file). If you have split your blueprint definition into multiple template files, you must also specify each additional template file that makes up your blueprint separated by a comma, in any order.

Note

Creating blueprints in public and company catalogs.

To create a blueprint in a public catalog, you will need to specify the parameter --publicCatalog or the parameter --catalogid with the id of the public catalog on the create-blueprint command.

To create a blueprint in a company catalog do not specify the catalog (omit the --publicCatalog and --catalogid parameters). The blueprint will be added to your customer company company catalog.

Note

If you issue the create-blueprint command to create a blueprint with the same name as an existing blueprint in a catalog but with a different version, the newly created blueprint will become the active blueprint.

Note

You can perform a bulk create of multiple blueprints from a list specified in a json file. Refer to the bulk-create-blueprint command reference page in this document for more details.

See also

You can create and manage multiple versions of a blueprint in Dell Cloud Manager. For more details refer to the Managing Blueprint Versions section in this document.

See also

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

Example 1

Here is an example of creating a blueprint in the customer company company catalog with an image acme_logo.png

Since neither the --publicCatalog or --catalogid arguments were specifed, the blueprint is added to the user’s customer company catalog.

create-blueprint apache_web_server_no_cm.yaml --imports base_types.yaml --imagefile acme_logo.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: "acme_logo.png"
Adding blueprint to catalog 10, activeVersion=True, name= "Apache Web Server on Linux"
  Added "Apache Web Server on Linux" id: 73 version: 1.00

As soon as the create-blueprint command completes successfully, the blueprint will appear on the Dell Cloud Manager console in the company catalog.

../_images/blueprint_in_company_catalog_on_console.png

Example 2

Here is an example of creating a blueprint in the public catalog with an image joomla.png

create-blueprint joomla_two_server.yaml --imports base_types.yaml --imagefile joomla.png --publicCatalog
Loading API environment
  API access validated
  API access key type is User, userId: 10
  Found public catalog, id= 15
  Found Company catalog, id= 10
  Including import: "base_types.yaml"
  Including image file: "joomla.png"
Adding blueprint to catalog 15, activeVersion=True, name= "Joomla Two Server Stack using Chef"
  Added "Joomla Two Server Stack using Chef" id: 74 version: 1.00

As soon as the create-blueprint command completes successfully, the blueprint will appear on the Dell Cloud Manager console in the public catalog.

../_images/blueprint_in_public_catalog_on_console.png