CloudShell Version: 8.3 GA

Help Version: 1.2

Api Guide
View / Download All Help Versions
Online Help

This help article applies to CloudShell 8.3. To see the latest, click here.

You are here: Blueprints > Blueprints Catalog
Run a free text search for blueprints listed in the dashboard.Switch between the Blueprint Catalog and the Sandboxes dashboard.Use the filters to find blueprints matching specific criteria.The catalog header displays the number of blueprints in the catalog, enables you to clear any filters you applied to the catalog, and switch between the catalog views.View and manage the different blueprints in the catalog. Click a tile to open the blueprint's workspace.Use this pane to filter blueprints by category.Select whether to display blueprints in a list or tilesReserve the blueprint (creates a sandbox).Click to access the blueprint's diagram and properties page. Select Delete to remove the blueprint from CloudShell.Display details about the blueprint and its status.Display the blueprint's current status and whether any resources are unavailable.

Blueprint Catalog

The Blueprint Catalog displays public blueprints as well as your private blueprints in the domains you are permitted to access. The Blueprint Catalog is displayed by default when you log in to CloudShell. However, CloudShell remembers the last page you were in and displays that page when you next log in.

Navigating the Blueprint Catalog

In the image below, hover over an area or option to learn more about it, or use the table that follows.

In the Blueprint Catalog, you can:

View blueprints by categories

The Browse by Category pane is displayed when there are categories associated with the current domain. This pane lists the different categories in the portal and enables you to view blueprints that belong to a specific category.

Note: Categories are created and managed by the system administrator through the Manage dashboard.

To display blueprints of a specific category:

  • On the right of the screen, in the Browse by Category pane, click the required category.

To return to the previous view in the catalog:

  • In the catalog header, click Back to Blueprint Catalog.

Filter the Blueprint Catalog

Featured or All blueprints

By default, blueprints in the catalog are displayed in one of the following ways:

  • Featured (default view) – Arranges the blueprints according to recent activities and includes the following sections:
    • New - Recently created public blueprints
    • Recently Modified – Recently modified blueprints that are owned by the user
    • Recently Reserved - Recently reserved blueprints
  • All Blueprints – Displays all the blueprints in the domain. The blueprints are displayed in alphabetical order.

Note: The Featured section is optional. If the Featured section is disabled, the All blueprints section is displayed.

To switch between these views:

  • Use the and buttons in the top left-hand corner of the Blueprint Catalog.

    The number of matching blueprints is displayed to the right of the Blueprint Catalog header caption.

Filter pane

To apply additional filters to the catalog, use the Filter options from the left sidebar. Different filters appear according to the blueprints in the catalog and your user permissions.

The following table describes the available filters:

Filter typeDescription Filter
My Blueprints

Displays blueprints directly related to the logged in user.

Note: If you don’t own any blueprints, the filter is not displayed.

Owned by me - Blueprints you currently own.
Share Level

Displays blueprints you own and public blueprints in your current domain.

Note: If all the blueprints are either public or private, the filter is not displayed.

Public - Only displays public blueprints (from all users).

Private (My) - Only displays private blueprints owned by the current user.

Private (All) - This option is only available to an administrator. Allows to view private blueprints of any user in the domain.

Blueprint StatusBlueprint status enables you to view blueprints based on their current availability. To ensure a responsive behavior, the status is calculated using a very basic availability check. Only the current status of physical resources in the blueprint is checked. Conflicts related to abstract resources and connectivity is not reflected by the blueprint status.

Available - Only displays blueprints whose physical resources are currently available.

Unavailable - Only displays blueprints whose physical resources are currently in use.

View only - Displays blueprints that contain resources that are not in your domain or blueprints for which you have View Only permissions.

Blueprint Type

In the Blueprint Catalog, you can display blueprints according to blueprint type by using the Type filter located in the top right-hand area of the page. There are four types of blueprints: Regular, Order, Build and View. The Type filter is displayed if more than one blueprint is enabled. Enabling blueprints of types Order, Build or View requires setting a configuration key.

To display a blueprint type:

  1. In the top right hand corner of the Blueprint Catalog, click the Type dropdown list.
  2. Select one of the following types:
  • All - display blueprints of all types (Default)
  • Regular – display blueprints of type Regular
  • Order - display blueprints of type Order. Orders are sandboxes that need to be manually activated, enabling users to make modifications to the sandbox itself before it goes live, without changing the blueprint's settings.
  • Build – display only blueprints of type Build. Build blueprints are designed to run specific automation processes in a blueprint. For example, to set up and provision lab equipment.
  • View – display blueprints for which you have view only permissions. You cannot edit, delete or reserve view only blueprints.

The last blueprint type that you selected is remembered and is displayed when you next open the Blueprint Catalog.

Reserve a blueprint from the Catalog

For additional information about sandboxes and sandbox conflicts, see Creating Sandboxes.

Note: Blueprints of type ‘view’ cannot be reserved.

To create an immediate or future sandbox:

  1. In the Blueprint Catalog, on the required blueprint tile, click Reserve. Alternatively, in the blueprint workspace, click the Reserve button.

    The Reserve dialog box is displayed.

    Note: The timezone for the sandbox is indicated in the title of the Reserve dialog box.

  2. In the Schedule field, you can set the required sandbox duration or specify the explicit start and/or end time. Use the Calendar button to set future dates.
  3. Note: If a maximum duration was set for the sandbox, the user will not be able to reserve for a duration beyond this setting.

  4. To have this sandbox repeat in a series, click Add Recurrence. If this option is missing, the admin needs to enable it using the EnableRecurringReservation key.

    The Recurrence page is displayed.

    1. To have the sandbox repeat on specific days, click the Pattern field and either select the days or select Daily to have the sandbox repeat on all days of the week.
    2. In the Range field, define the period in which the sandbox will repeat.
  5. Optionally change the Name of the sandbox. By default, the new sandbox name is the blueprint name.
  6. In the Blueprint field, you can see the blueprint on which the sandbox is based. Once reserved, it is not possible to change the blueprint for the active sandbox.
  7. To specify additional options, click the Advanced Form button.

    The advanced form enables you to configure the email notifications, permissions and other options.

    1. Optionally enter a Description. Otherwise, the description of the sandbox will default to the blueprint description.
    2. To define an owner for the sandbox, click the Owner and select the required user. By default, the user who initiated the scheduling action is set as the sandbox owner.

    3. Instead of changing the owner of the sandbox, you can permit additional users to use the sandbox. Click the Permitted Users section and select the users you wish to add.

    4. You can configure CloudShell to send email notifications to the owner of the sandbox and permitted users.

      Note: This capability requires the administrator to activate the email notifications feature using the ReservationEmail configuration keys.

      1. Click the Email Notifications field.

        The Email Notifications area expands.

      2. Configure the email notification settings.

        • On start - Sends notification as the sandbox starts.
        • Before end - Sends notification before the Teardown process begins. The exact time is decided by the user.
        • On end - Sent when the sandbox ends.
  8. If the blueprint has inputs, you will be asked to provide them.
  9. Click Reserve.

    The sandbox is being reserved.

    If any resource is unavailable for the scheduled time slot, the Conflicts dialog box is displayed, proposing an alternative time slot, as described in Dealing with conflicts.

    The new sandbox is displayed in Diagram view with a blue Sandbox label at the top of the canvas and a green Active icon in the toolbar:

    To learn how to use the sandbox workspace, see Using the Sandbox Workspace.