list-blueprints

The list-blueprints command displays a list of the active blueprints defined in a catalog. What catalog the blueprints are displayed from is determined by one of the options in the order below:

  1. By specifying the --publicCatalog command argument.
  2. By specifying the desired company catalog with the command argument --catalogid
  3. Otherwise the company catalog associated with the customer of the user running the command is used.

Help

list-blueprints -h
usage: list-blueprints [-h] [--catalogid CATALOGID] [--likename LIKENAME]
                       [--details] [--depth DEPTH] [--publicCatalog]

Lists all visible blueprints in a catalog. Visibility is determined by
blueprints that are marked as the Acitve Version

optional arguments:
  -h, --help            show this help message and exit
  --catalogid CATALOGID
                        Optional catalogId to add blueprint to, defaults to
                        company catalog
  --likename LIKENAME   Searches for blueprints with like names
  --details             Show all attributes of each Blueprint. Note some
                        details are hidden based on the depth
  --depth DEPTH         Depth of objects to print, default=3. Note only
                        available with the details option
  --publicCatalog       Use public catalog

Note

The list-blueprints command has a --depth parameter which determines how much detail gets displayed. You specify the --depth parameter with a number in the range from 1 to 10 (1 = minimum detail, 10 = maximum detail). The default is 3.

Note

Listing blueprints requires that the Dell Cloud Manager user (user API key) has the necessary access rights to access blueprints.

Example 1

List the active blueprints in the public catalog.

list-blueprints --publicCatalog
Loading API environment
  API access validated
  API access key type is User, userId: 10
  Found public catalog, id= 10
  Found Customer catalog, id= 10

Number of Blueprints found: 1

+----+---------------------+---------------------------------+------------+------------------------------+---------+
| Id | Name                | Description                     | Created by | Created                      | Updated |
+----+---------------------+---------------------------------+------------+------------------------------+---------+
| 10 | Payroll Application | Simple Single Machine Blueprint | None       | 2015-05-07T20:00:54.937+0000 | None    |
+----+---------------------+---------------------------------+------------+------------------------------+---------+

Example 2

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 Customer catalog, id= 11
Defaulting to customer catalog id: 11

Number of Blueprints found: 2

+----+-----------------+---------------------------------+---------+------------------------------+---------+
| Id | Name            | Description                     | Version | Created                      | Updated |
+----+-----------------+---------------------------------+---------+------------------------------+---------+
| 14 | GAF-Chef-Apache | Installs Apache using Chef      | 1.00    | 2015-06-08T18:13:09.438+0000 | None    |
| 15 | GAF-TEST        | Simple Single Machine Blueprint | 1.00    | 2015-06-08T17:46:01.787+0000 | None    |
+----+-----------------+---------------------------------+---------+------------------------------+---------+