Managing Catalogs

This chapter contains the following sections:

About Managing Catalogs

You can self-provision virtual machines (VMs) and bare metal (BM) servers using predefined catalog items. Only a system administrator can create a catalog. A catalog defines parameters, such as the cloud name and the group name to which the VM is bound.

The following folders are available by default. You cannot edit or delete them.

  • Standard

  • Advanced

  • Service Container

  • Bare Metal

To aid in managing catalogs, Cisco UCS Director allows you to group similar catalogs within a folder. While creating a catalog, you can choose to add it in a previously created folder, or create a new folder. A folder is visible in the system only when it contains a catalog.

The Manage Folder option on the Catalog page allows you to perform the following tasks:

  • Edit a folder—Modify the name of a user-created folder or the folder icon for all folders. You cannot modify the name of a default folder.

  • Delete a folder—Delete a folder from Cisco UCS Director. If this folder contains catalogs, then these catalogs are automatically moved into the folders that are available by default, based on the catalog type.

    Default folders cannot be deleted.

  • Re-order the list of folder—Change the order in which the folders are listed in the Catalog page. By default, folders are listed alphabetically.


Important

If you have upgraded Cisco UCS Director to the latest version, then all catalogs created in prior versions are grouped into folders available by default, based on their catalog types.

By default, catalogs are displayed in a tile view format. You can choose to have the catalogs displayed in a table view format as well. Use the options on the far right of the screen to switch between the table view and the tile view format. In the table view format, you can use the options to expand or collapse all folders.

From the Catalog page, you can create a Service Request. Click Create Service Request, and complete the procedure documented in Creating a Service Request with Catalog Type—Standard.

Publishing a Catalog

Procedure

Step 1

Choose Policies > Catalogs.

Step 2

On the Catalogs page, click Add.

Step 3

On the Add Catalog screen, choose the Catalog Type that you want to add.

It can be one of the following:

  • Standard—Used to create catalogs for VM provisioning, using images from a list of clouds.

  • Advanced—Used to publish orchestration workflows, such as catalog items.

  • Service Container—Used to publish application containers as catalog items.

  • Bare Metal—Used to create catalogs for bare metal server provisioning.

    For information on how to create a bare metal catalog, see Creating a Bare Metal Server Catalog.

Step 4

Click Submit.

Step 5

On the Add Catalog: Basic Information screen, complete the required fields, including the following:

Name

Description

Catalog Name field

Enter a name for the catalog.

Note

 

After created, a catalog name cannot be modified.

Catalog Description field

Enter a description of the catalog.

Catalog Type drop-down list

Displays the type of catalog you previously chose. To change the catalog type, you need to cancel and restart this procedure.

Catalog Icon drop-down list

Choose from a list of icons to associate this catalog with an image. This icon is seen when you are creating a service request using this catalog.

Applied to all groups check box

Check the box to enable all groups to use this catalog. Leave it unchecked to deny its use to other groups.

Support Contact Email Address field

Enter the email address of the support contact who is notified when a service request is created using this catalog item.

Selected Groups list

Click Select to the check the checkboxes of specific user groups. The checked groups use this catalog to provision new VMs. After checking the checkboxes of user groups, click Select to return to the Add Catalog screen.

Publish to end users check box

By default, this box is checked. Uncheck this box if you do not want this catalog to be visible to users. If you do not uncheck this box, then this catalog is visible to the users of the system.

Cloud Name drop-down list

Choose the cloud with the image for VM provisioning.

Provision new VM for ISO mounting check box

Check this box to clone a new VM from a selected image. If you do not check this check box, a blank VM is created.

Image list

Click Select to the check the checkboxes of the type of image (any existing templates such as Windows, Linux, and other files that make up the image) to use when VMs are provisioned using this catalog. After checking the checkboxes of the required images, click Select to return to the Add Catalog screen.

If you are a group administrator, or a user in a group with permissions to create catalogs, this field displays images that are assigned to the group to which you belong.

If you are an MSP administrator, then this field displays images that are assigned to your MSP organization, and to the groups within the MSP organization.

Provision new VM using Content Library VM Template check box

Check this box to ensure that the new VM is provisioned using the Content Library VM Template.

If you choose this option, the Image list is hidden.

Content Library VM Template list

Choose the content library VM template.

Windows License Pool field

Enter the Windows License.

Note

 

This field appears only when a Windows image is chosen. This option is not supported in the RHEV KVM Connector.

Use ReadyClone check box

Check the box to ensure that VMs are deployed using ReadyClones.

When this box is checked, the Use Linked Clone and Provision all disks in single datastore check boxes are not available for editing.

Note

 

This checkbox is not visible if:

1. The selected image is not on the HX datastore.

2. The VM has multiple disks.

Use Linked Clone check box

Check the box if you want to use a linked clone.

Linked Clone or Full Clone depends on the Linked Clone selection in the Storage Policy.

Note

 

This field appears only when a Snapshot image is chosen.

Provision all disks in single datastore check box

Check the box to provision all disks in a single datastore. You can also choose to use the datastores configured for each disk in the storage policy.

For more information on multiple disk storage policy creation, see Managing Policies.

Note

 

This field appears only if the chosen template has multiple disks. This option is not supported in the RHEV KVM Connector.

Service Container Template Name drop-down list

Choose the template from the list.

Note

 

This field appears only when the chosen Catalog Type is Service Container.

Select Folder drop-down list

Choose the folder within which this catalog must be created.

Note

 

The drop-down list includes names of folders that are available by default. You can either choose a folder that is available, or click Create New Folder.

On the Add New Folder screen, enter a Folder Name, choose a Folder Icon, and click Add.

Bare Metal Server Provisioning Policy drop-down list

Note

 

This field appears only when the chosen Catalog Type is Bare Metal.

Configure Service Request Support Email check box

Check this box to enable the user to set the support email for sending service request status.

Step 6

Click Next.

Step 7

On the Add Catalog: Application Details screen, complete the required fields, including the following:

Name

Description

Category list

Expand the list to choose a VDC category and click Select.

Override check box

Check the box to enable the user to override the selected category while provisioning a VM using a service request.

Support Contact Email Address field

Enter the email address of the contact who is notified when a service request is created using this catalog item.

Specify OS drop-down list

Choose the type of OS installed on the VM when it is provisioned.

Note

 

This option is not supported in the RHEV KVM Connector.

Specify Other OS field

Enter an OS that is not available in the Specify OS drop-down list.

Note

 

This option is not supported in the RHEV KVM Connector.

Specify Applications check boxes

Check the appropriate boxes to specify applications that are installed on the VM during provisioning.

Note

 

This option is not supported in the RHEV KVM Connector.

Specify Other Applications field

Enter other applications that are not available from the Specify Applications check boxes.

Note

 

This option is not supported in the RHEV KVM Connector.

Application Code field

Enter an application code that is used in the VM name.

The application code can be between 1 to 4 characters (for example: W2K3, DB, WS). The application code can be used in a system policy for the VM name by using the variable ${APPCODE}.

For example, if the VM Name Template is vm-${GROUP_NAME}-${APPCODE}, the VM provisioned with the system policy has the name vm-groupname-W2K3.

Note

 

This option is not supported in the RHEV KVM Connector.

Step 8

Click Next.

Step 9

On the Add Catalog: User credentials screen, complete the required fields, including the following:

Note

 

These options are not supported in the RHEV KVM Connector.

Name

Description

Credential Options drop-down list

Choose to allow or disallow users to retrieve VM access credentials (shared). The following options are available:

  • Do not share

  • Share after password reset

  • Share template credentials

The Do not share option is chosen if the administrator wants to send the credentials privately to another user outside Cisco UCS Director.

User ID field

Enter the user ID.

Note

 

This field is available only if a choice is made to share under Credential Options.

Password field

Enter the password.

Note

 

This field is available only if a choice is made to share under Credential Options.

Step 10

Click Next.

Step 11

On the Add Catalog: Customization screen, complete the required fields, including the following:

Name

Description

Automatic Guest Customization Enable check box

Check the box to enable automatic guest customization.

If you do not check this check box, then Cisco UCS Director does not configure the DNS, Network, and Guest OS properties.

Service Request Options Lock check box

Check the Lock check box to lock a service request.

Selecting the Lock check box prevents archiving of the service request.

This is applicable only when you choose the catalog type as Standard.

Pre Provisioning Custom Actions Enable

Check the Enable check box to enable execution of an orchestration workflow before VM provisioning.

Workflow field

Click Select to check the compound workflow that should be used in the orchestration workflow before VM provisioning.

Check the check boxes of the required workflows, and click Select to return to the Add Catalog screen.

Note

 

This field appears when Pre Provisioning Custom Actions Enable is checked.

Post Provisioning Custom Actions Enable check box

Check the box to enable execution of an orchestration workflow after VM provisioning.

Workflow drop-down list

Click Select to check the check boxes of the workflows that need to be used in the orchestration workflow after VM provisioning.

Check the check boxes of the required workflows, and click Select to return to the Add Catalog screen.

Note

 

This field appears when Post Provisioning Custom Actions Enable is checked.

Virtual Storage Catalog Enable check box

Check the box to choose storage entries from the Virtual Storage catalog.

Virtual Storage Catalog drop-down list

Chose a storage entry from the catalog.

Note

 

This field appears when Virtual Storage Catalog Enable is checked.

Cost Computation

Charge Duration drop-down list

Choose Hourly or Monthly.

Active VM Application Cost USD field

Enter the cost for the application that is included in the template.

Note

 

This option is not supported in the RHEV KVM Connector.

Inactive VM Application Cost USD field

Enter the cost to this catalog of a VM in inactive state, per hour or month.

Note

 

This option is not supported in the RHEV KVM Connector.

VM Life Cycle Configuration

Lease Time check box

Check the box to define a lease time (in days and hours).

Days field

Enter the number of days.

Note

 

This field appears when Lease Time is checked.

Hours field

Enter the number of hours.

Note

 

This field appears when Lease Time is checked.

Hide end user lease configuration check box

Check the box to prevent service users from configuring a lease time for VMs.

Hide end user VM provision later check box

Check the box to prevent service users from provisioning VMs at a later time.

Step 12

Click Next.

Step 13

On the Add Catalog: VM Access screen, complete the required fields, including the following:

Name

Description

Web Access Configuration Enable check box

Check the box to enable web access to the VM. By default, this check box is unchecked which means that web access to the VM is disabled.

URL field

Enter the URL of the VM.

Note

 

This field appears when Web Access Configuration Enable is checked.

Label field

Enter the label that is defined for this URL.

Note

 

This field appears when Web Access Configuration Enable is checked.

Remote Desktop Access Configuration Enable check box

Check the box to enable remote desktop access to the VM. By default, this check box is unchecked, which means that remote desktop access to the VM is disabled.

Server field

Enter the IP address of the server for remote access.

Note

 

This field appears when Remote Desktop Access Configuration Enable is checked.

Port field

Enter the port number on the server for remote access.

Note

 

This field appears when Remote Desktop Access Configuration Enable is checked.

Label field

Enter the label that is defined for this remote access.

Note

 

This field appears when Remote Desktop Access Configuration Enable is checked.

VMRC Console Configuration Enable check box

Check the box to enable VMRC console access to the VM. By default, this check box is unchecked, which means that the VMRC console access to the VM is disabled.

Step 14

Click Next.

Step 15

Review the catalog information on the Add Catalog: Summary screen.

Step 16

Click Submit.

About Publishing Advanced Catalogs

When you choose the Advanced catalog type, you can provision workflow catalogs. End users can execute workflows with these catalogs during a Service Request. You create an Advanced Catalog Item by defining parameters such as Group Name and Workflow.

Publishing Advanced Catalogs

Procedure

Step 1

Choose Policies > Catalogs.

Step 2

On the Catalog page, click Add.

Step 3

In the Catalog Add screen, from the Catalog Type drop-down list, select Advanced.

Step 4

Click Submit.

Step 5

In the Add Catalog screen, complete the required fields, including the following:

Name

Description

Basic Information Pane

Catalog Name field

The name of the catalog.

Catalog Description field

The description of the catalog.

Catalog Type

Choose Advanced.

Catalog Icon drop-down list

Choose the icon to associate this catalog with an image. The icon is seen when creating a service request using this catalog.

Applied to all groups check box

Check the check box to enable all groups to use this catalog. By default, this check box is not checked, which means that all groups cannot use this catalog.

Support Contact Email Address field

The email address of the support contact person.

Selected Groups

Click Select and complete the following:

  1. (Optional) Click Check All to choose all of the categories or click Check None to deselect all categories.

  2. From the Select Items dialog box, check the appropriate groups to include. The checked groups can use this catalog to provision new VMs.

  3. Click Select to finish your selection of categories.

Publish to end users check box

By default, this check box is checked, which means that the catalog is available to end users. Uncheck this check box if you do not want this catalog to be visible to end users.

Select Folder drop-down list

Choose the folder within which this catalog must be created in.

Note

 

The drop-down list includes names of folders that are already available. You can either select a folder that is available, or click the + icon to create a new folder.

To create a new folder in the Add New Folder dialog box, specify a folder name, and select an icon for the folder.

Configure Service Request Support Email field

Check this check box to specify the email address to which the service request status email must be sent to.

Step 6

Click Next.

Step 7

In the vApp Workflow pane, click Workflow Select.

Step 8

In the Select pane, check the check box next to the appropriate workflow.

Step 9

Click Select.

Step 10

Review the catalog information on the Summary page.

Step 11

Click Submit.

Creating a Bare Metal Server Catalog

Before you begin

You should have created a bare metal provisioning policy.

Procedure

Step 1

Choose Policies > Catalogs.

Step 2

On the Catalog page, click Add.

Step 3

In the Add Catalog screen, choose Bare Metal as the Catalog Type.

Step 4

Click Submit.

Step 5

In the Add Catalog screen, complete the required fields, including the following:

Name

Description

Basic Information pane

Catalog Name field

Enter a name of the catalog.

Note

 

Once created, a catalog name cannot be modified.

Catalog Description field

Enter a description of the catalog.

Catalog Type drop-down list

This field cannot be edited. It displays Bare Metal.

Catalog Icon drop-down list

Choose from a list of icons to associate this catalog with an image. This icon is seen when you are creating a service request using this catalog.

Applied to all groups check box

Check the check box to enable all groups to use this catalog. Leave it unchecked to deny its use to other groups.

Support Contact Email Addresses field

Specify the email address of the support contacts.

These users will receive email notifications on the status of the bare metal server provisioning using the catalog.

Note

 

This notification email is also sent to the user who initiates the bare metal server provisioning.

Selected Groups check box list

Check the check boxes for included groups that are from the Select Items dialog box. The checked groups use this catalog to provision new bare metal servers.

Publish to end users check box

By default, this check box is checked. Uncheck this check box if you do not want this catalog to be visible to end users. If you do not uncheck this check box, then this catalog is visible to the end users of the system.

Select Folder drop-down list

Choose the folder within which this catalog must be created.

Note

 

The drop-down list includes names of folders that are available by default. You can either select a folder that is available, or click the + icon to create a new folder.

To create a new folder in the Add New Folder dialog box, specify a folder name, and select an icon for the folder.

Bare Metal Server Provisioning Policy drop-down list

Choose a bare metal provisioning policy.

Configure Service Request Support Email check box

By default, this check box is unchecked. Check this check box to specify an email address to which the status of the service request must be emailed to.

Step 6

Click Next.

Step 7

In the Bare Metal Workflow pane, click Select to choose a bare metal server provisioning workflow.

To create a bare metal workflow, you will need to include the following set of tasks at a minimum:

  • The Bare Metal Provisioning wrapper

  • Select UCS Server

  • Create UCS Service Profile from Template

  • Associate UCS Service Profile

  • Setup PXE Boot With BMA Selection

  • Power On UCS Server

  • Monitor PXE Boot

  • Modify UCS Service Profile Boot Policy

  • Power On UCS Server

  • Assign UCS Server to Group

Step 8

Click Next.

Step 9

Review the catalog information in the Summary pane.

Step 10

Click Submit.

What to do next

Using this catalog, you can create a service request for bare metal servers.

Reordering Catalogs Within a Folder

By default the catalogs within a folder are listed alphabetically, but you can customize the order.

Procedure

Step 1

Choose Policies > Catalogs.

Step 2

On the Catalog page, expand a folder to view the catalogs within it.

Step 3

Select a catalog from the list.

Step 4

Click the Move Up or Move Down options to reorder the catalogs.

Accessing Hosts for Deployment

You can choose a catalog item to assess deployable hosts and provide a reason for hosts that are excluded. You can determine if you want to run this assessment on all configured VDCs, or on certain specific VDCs.

Procedure

Step 1

Choose Policies > Catalogs.

Step 2

On the Catalog page, choose a Catalog Entry to assess.

Step 3

Click Deployability Assessment.

Step 4

In the Select vDC screen, complete the required fields, including the following:

Field

Description

Run Assessment Across all VDCs check box

By default, this check box is checked, which indicates that this catalog item will be assessed with all VDCs. Uncheck this check box to select specific VDCs.

Select VDC field

Click Select to check the check boxes of the VDCs against which you want the catalog item assessed.

The list displays all the vDCs associated with the user group for the selected catalog.

Step 5

Click Submit.

Step 6

View the Deployability Assessment report and the click Close.

Reordering Catalog Folders

By default the catalog folders are listed alphabetically, but you can customize the order.

Procedure

Step 1

Choose Policies > Catalogs.

Step 2

Click Manage Folder.

Step 3

In the Manager Folder screen, select a catalog folder and use the arrows to reorder the folders.

Step 4

Click Submit.