KB at your finger tips

This is one stop global knowledge base where you can learn about all the products, solutions and support features.

Calm 3.5.2

Product Release Date: 2022-08-03

Last updated: 2022-11-10

Introduction

Introduction to Calm

Calm allows you to seamlessly select, provision, and manage your business applications across your infrastructure for both the private and public clouds. Calm provides application automation, lifecycle management, monitoring, and remediation to manage your heterogeneous infrastructure, for example, VMs or bare-metal servers.

Calm supports multiple platforms so that you can use the single self-service and automation interface to manage all your infrastructure. Calm provides an interactive and user-friendly graphical user interface (GUI) to manage your infrastructure.

Calm Key Benefits

Calm is a multi-cloud application management framework that offers the following key benefits:

IT Agility and Human Error Elimination
Calm simplifies the setup and management of custom enterprise applications by incorporating all important elements, such as the relevant VMs, configurations, and related binaries into an easy-to-use blueprint. These blueprints make the deployment and lifecycle management of common applications repeatable and help infrastructure teams eliminate extensive and complex routine application management.
Unified Multi-Cloud Orchestration
Calm unifies the management of all your clouds into a single-pane-of-glass, removing the need to switch between portals. Calm automates the provisioning of multi-cloud architectures, scaling both multi-tiered and distributed applications across different cloud environments, including AWS, GCP, Azure, and VMware (on both Nutanix and non-Nutanix platforms).
Automated Self-Service with Centralized Control
Calm empowers different groups in the organization to provision and manage their own applications, giving application owners and developers an attractive alternative to public cloud services. Calm provides powerful, application-centric self-service capabilities with role-based access control. All activities and changes are logged for end-to-end traceability, aiding security teams with key compliance initiatives.
Nutanix Marketplace
The marketplace offers preconfigured application blueprints that infrastructure teams can instantly consume to provision applications. The marketplace also provides the option to publish sharable runbooks. A runbook is a collection of tasks that are run sequentially at different endpoints. Infrastructure teams can define endpoints and use runbooks to automate routine tasks and procedures that pan across multiple applications without the involvement of a blueprint or an application.
Cost Governance
With native integration into Beam, Calm also shows the overall utilization and true cost of public cloud consumption to help you make deployment decisions with confidence.
Application Development and Modernization
Combined with Nutanix Karbon or your choice of certified Kubernetes, Calm provides the tools required to modernize applications without losing control of policy. Additionally, Calm natively integrates with Jenkins to empower CI/CD pipelines with automatic infrastructure provisioning or upgrades for all applications.
Calm DSL - Infrastructure-as-Code (IaC)
Calm DSL describes a simpler Python3-based Domain Specific Language (DSL) for writing Calm blueprints. DSL offers all the richness of the Calm user interface along with additional benefits of being human readable and version controllable code that can handle even the most complex application scenario. DSL can be also used to operate Calm from a CLI.

As Calm uses Services, Packages, Substrates, Deployments and Application Profiles as building blocks for a blueprint, these entities can be defined as Python classes. You can specify their attributes as class attributes and define actions on those entities (procedural runbooks) as class methods.

Calm DSL also accepts appropriate native data formats such as YAML and JSON that allow reuse into the larger application lifecycle context of a Calm blueprint.

For technical articles, videos, labs and resources on Calm DSL, see Nutanix Calm DSL on Nutanix.dev.

Calm Prerequisites

Pre-configuration for Using Calm

You must configure the following components before you start using Calm.

Image configuration for VM: To use Nutanix as your provider, you must add and configure the image for your VMs. Images are provider-specific. You can upload images to Prism Central or Prism web console and use those images when you configure your blueprints. For more information, see Image Management section in the Prism Central Guide .
SSH key (optional): Generate SSH keys so that you can use them for authentication when you configure or launch your blueprints. For more information, see Generating SSH Key on a Linux VM or Generating SSH Key on a Windows VM.
Lightweight Directory Access Protocol (LDAP): Configure LDAP to authenticate users or group of users to use Calm. For more information about LDAP, see Configuring Authentication section in the Prism Central Guide .
SSP: The Prism Self Service feature allows you to create projects within an enterprise. Users or group of users can provision and manage VMs in a self-service manner without involving IT in their day-to-day operations. For more information, see Prism Self Service Administration section in the Prism Central Guide .

Prerequisites to Enable Calm

Before you enable Calm from Prism Central, ensure that you have met the following prerequisites.

The Prism Central version is compatible with Calm.
You can go to the Software Product Interoperability page to verify the compatible versions of Calm and Prism Central.
The Prism Central in which Calm is running is registered with the same cluster.
Note:
- Calm is supported only on AHV and ESXi hypervisors on a Nutanix cluster.
- Calm is not supported on Hyper-V cluster.
- Calm does not support vSphere essential edition. If you try to enable Calm with vSphere essential edition license, you get a failure notification because hot-pluggable virtual hardware is not supported by vSphere essential edition.
A unique data service IP address is configured in the Prism web console cluster that is running on Prism Central. For more information about configuring data service IP address, see the Modifying Cluster Details in the Prism Web Console Guide .
Note: Do not change the data service IP address after Calm enablement.
A minimum allocation of 4 GB of memory for a small Prism Central and 8 GB of memory for large Prism Central. For more information, see Calm Benchmarks.
All the required ports are open to communicate between a Prism web console and Prism Central. For more information about ports, see Port Reference.
The DNS server is reachable from Prism Central. Unreachable DNS server from Prism Central can cause slow deployment of Calm.

Calm Benchmarks

Nutanix certifies the following benchmarks for single-node deployment profiles (non-scale-out) and three-node deployment profiles (scale-out). Each benchmark contains scale numbers across different entities of Calm. Because the scaling properties of these entities often depend on each other, changes to one entity might affect the scale of other entities. For example, if your deployment has smaller number of VMs than the benchmarked number, you can have a higher number of blueprints, projects, runbooks, and so on.

Use these guidelines as a good starting point for your Calm installation. You might have to allocate more resources over time as your infrastructure grows.

Calm Single-Node Profile

The following table shows the Calm benchmarks for a single-node Prism Central profile.


Prism Central size	Prism Central configuration	Number of VMs	Number of single-VM blueprints	Number of single-VM applications	Number of projects	Number of runbooks
Small (1 node)	6 vCPUs and 30 GB of memory for each node.	2000	400	2000	50	250
Large (1 node)	10 vCPUs and 52 GB of memory for each node.	7000	1400	7000	250	500

Calm Three-Node (Scale-Out) Profile

The following table shows the Calm benchmarks for a three-node Prism Central profile. If high-availability is preferred, it is recommended to use the scale-out deployment.


Prism Central size	Prism Central configuration	Number of VMs	Number of single-VM blueprints	Number of single-VM applications	Number of projects	Number of runbooks
Small (3 nodes, scale out)	6 vCPUs and 30 GB of memory for each node.	3500	700	3500	100	500
Large (3 nodes, scale out)	10 vCPUs and 52 GB of memory for each node.	12500	2500	12500	500	1000

Benchmark Considerations

The following considerations are applicable for both Calm single-node and three-node (scale-out) profiles:

When you enable Calm, an additional 4 GB memory per node is added to the Prism Central small deployment profile and 8 GB of memory per node is added to the Prism Central large deployment profile.
The listed application and blueprint numbers include both running and deleted applications and blueprints. Data related to deleted applications and blueprints is cleaned up after 3 months.
All the listed VM numbers are for the VMs that are managed by Calm and not Prism Central overall.
These performance tests are done by using single-service blueprints and applications. Results might be lower when blueprints with multiple services are deployed.
Calm automatically archives the logs every 3 months to clean up the database and to free up the resources. You can also increase the memory (RAM) of your deployed Prism Central VM to increase the Calm capacity.

Calm Throughput

The maximum throughput on a large three-node (scale-out) deployment profile is 400 VMs per hour.

Note: For customized higher capacity Calm configurations, work with your Nutanix sales representative.

Port Information in Calm

For a list of required Calm ports, see Port Reference. The Port Reference section provides detailed port information for Nutanix products and services, including port sources and destinations, service descriptions, directionality, and protocol requirements.

Calm Enablement

Enabling and Accessing Calm

Calm is integrated into Prism Central and does not require you to deploy any additional VMs. To start using Calm, you only have to enable Calm from Prism Central.

Before you begin

Ensure that you have met the prerequisites to enable Calm. For more information, see Prerequisites to Enable Calm.

Note:

If the Prism web console is not registered from a Prism Central and the application blueprints have subnet, image, or VMs on the Prism web console, the Calm functionality is impacted.

Procedure

Log on to Prism Central with your local admin account.
For detailed information on how to install and log on to Prism Central, see the Prism Central Guide .
From the Prism Central UI, click Services > Calm .
Click Enable .

Note: The Enable option appears only when you log on to Prism Central with a local admin account.

When you enable Calm, an additional 4 GB memory per node is added to the Prism Central small deployment profile and 8 GB of memory per node is added to the Prism Central large deployment profile.
To access Calm, click Services > Calm from the entities menu.

What to do next

You can instantaneously launch your first application. For more information, see Launching a Blueprint Instantaneously.

Checking Calm Version

You can check the version of your Calm instance from the Calm user interface.

Procedure

From the Prism Central entities menu, click Services > Calm .
Click the icon on the bottom-left corner.
The About Nutanix Calm page appears displaying the version number of Calm. For example:
Figure. Version Number Click to enlarge

Calm VM Deployment

Calm VM is a standalone VM that you can deploy on AHV and ESXi hypervisors and leverage calm functionality without the Nutanix infrastructure.

You can deploy Calm using the image at the Nutanix Support Portal - Downloads page and manage your applications across a variety of cloud platforms. Calm VM deployment eliminates the need of the complete Nutanix infrastructure to use Calm features.

Note:

Calm VM currently supports Calm version 3.5.2.
Calm VM supports scale-out deployment. See Setting up Scale-Out Calm VM.
The supported ESXi versions are 6.0.0 and 6.7 (vCenter version 6.7).

You can deploy Calm VM on ESXi in one of the following ways:

Using the vSphere Web Client. See Deploying Calm VM using the vSphere Web Client
Using the vSphere CLI. See Deploying Calm VM using the vSphere CLI

For information on Calm VM deployment on AHV, see Deploying Calm VM on AHV.

Deploying Calm VM on AHV

This section describes the steps to deploy a Calm VM on AHV.

Before you begin

Ensure that you have the URL of the OVA file.

Procedure

From the Prism Central entities menu, click Compute & Storage > OVAs .
Click Upload OVA .
The Upload OVA page appears.
Under OVA Source, select the URL radio button and do the following.

Figure. Upload OVA Click to enlarge
1. Provide a name in the Name field.
2. Provide the URL of the OVA file of the Calm VM in the OVA URL field.
3. Click Upload .
On the OVAs page, select the uploaded OVA from the list.
From the Actions list, select Deploy as VM .

Figure. Deploy VM Click to enlarge
On the Deploy as VM page, do the following:

Figure. Deploy as VM - Configuration Click to enlarge
1. Under the VM Properties section, specify the values for CPU , Cores Per CPU , and Memory .
  The CPU and Memory requirements of the Calm VM Deployment is equivalent to the Calm single-node profile. For the benchmark values, see Calm Benchmarks.
2. Click Next .
3. To configure the networks, associate the required subnets for your Calm VM instance.
4. Click Next .
5. Click Create VM to start the deployment of the Calm VM instance.
From the Prism Central entities menu, go to Compute & Storage > VMs and do the following:

Figure. VM Power On Click to enlarge
1. Select the Calm VM instance that you deployed.
2. Click Actions and then click Power On to power on the Calm VM instance.
3. Wait for the Calm services to be up and running.

What to do next

To manage and administer your applications, use the Calm VM IP address and the following default credentials to log in to the Calm VM for the first time:

Username: admin
Password: Nutanix/4u

You can change the default credentials after you log in.

Deploying Calm VM using the vSphere Web Client

You must create a VM with a specific Open Virtualization Format (OVF) image to access the Calm UI.

Before you begin

Ensure that you have the URL of the OVF file, or you have saved the OVF file on your local machine.

Procedure

Log on to the vSphere web client.
Click the cluster on which you want to deploy the Calm VM.

Figure. vSphere Web Client - Deploying OVF Template Click to enlarge
Click Actions > Deploy OVF Template .

Figure. Deploy OVF Template - Window Click to enlarge
In the Deploy OVF Template window, do the following.
1. Click the Local File option to browse and upload the OVF file from your local machine.
  Go to Nutanix Support Portal - Downloads and download the OVF file.
2. Click Next and select the cluster where you want to deploy the Calm VM.
3. Click Next and configure the storage and networks for the VM. Then, click Finish .
The system starts importing and deploying the file on the selected VMware cluster. After the deployment is complete, the Calm VM needs to be powered on.
Note: Calm services takes around 30 min to start after the VM is powered on.

For more information, see Deploying OVA Template on VMware vSphere section in the VMware documentation .

What to do next

To manage and administer your applications, use the Calm VM IP address and the following default credentials to log in to the Calm VM for the first time:

Username: admin
Password: Nutanix/4u

You can change the default credentials after you log in.

Deploying Calm VM using the vSphere CLI

This section describes the steps to deploy a Calm VM by using the vSphere CLI (govc).

Before you begin

Ensure that you have installed all the libraries of the vSphere CLI client (govc). For more information, click here.

Procedure

Login to the SSH client.

Note: Ensure that you have installed the govc libraries.
Run the following command.
```
$ govc import.ova -name 5.17.1-prismcentral -3.0.0.1 http://endor.dyn.nutanix.com/GoldImages/calm-vm
```
If you have downloaded the OVF file on your system, replace http://endor.dyn.nutanix.com/GoldImages/calm-vm with the location of the OVF file.
Figure. vSphere CLI (govc) - Deploy Calm Click to enlarge

Running the command starts the uploading process. Once the uploading is complete, power on the Calm VM from the vSphere web client.

Note: Calm services takes around 30 min to start after the VM is powered on.

What to do next

To manage and administer your applications, use the Calm VM IP address and the following default credentials to access Calm VM for the first time:

Username: admin
Password: Nutanix/4u

You can change the default credentials after you log in.

Setting up Scale-Out Calm VM

Use the following procedure to set up Scale-out version of Calm VM.

Before you begin

Ensure that:

Your VMware vCenter version is later than 6.0.
You downloaded the Calm VM OVA file from the Downloads page.
You uploaded the Calm VM OVA file on ESXi using the vSphere CLI (govc) or vSphere Web Client and marked it as a template. See Deploying Calm VM using the vSphere Web Client and Deploying Calm VM using the vSphere CLI.
You uploaded the Calm VM OVA file on AHV using the Prism Central User Interface. See Deploying Calm VM on AHV.
You have taken a backup of Calm data in case you are planning to extend an existing Calm VM.

Procedure

Create three Calm VMs using the templates you uploaded.
Do one of the following:
- To assign static IP addresses to the VMs, see Launching Calm VM with a Static IP Address.
- If DHCP is enabled, continue to step 3.
SSH to the three Calm VMs and wait until all the cluster services, including Calm and Epsilon, are up and running.
Run the following commands on all three VMs.
```
cluster stop
```
```
cluster destroy
```
Note: Run these commands only after taking a backup of the Calm data in case you are extending an existing

Run the cluster create command on one of the three VMs.

To create a simple cluster, run the following command:

#cluster --cluster_function_list="multicluster" -s <ip1>,<ip2>,<ip3> create

For example:

cluster --cluster_function_list="multicluster" -s 10.46.141.71,10.46.138.20,10.46.138.26 create

To create an advanced cluster with cluster name and virtual IP, run the following command:

cluster --cluster_function_list="multicluster" --cluster_name "<Cluster Name>" -s <ip1>,<ip2>,<ip3> --cluster_external_ip=<vip> create

For example:

cluster --cluster_function_list="multicluster" --cluster_name "Demo" -s 10.46.141.71,10.46.138.20,10.46.138.26 --cluster_external_ip=10.46.141.70 --dns_servers 10.40.64.15,10.40.64.16 create

Run the following command on one of the three VMs.
```
cd /home/nutanix/bin
python enable_calm.py
```
Run the following command to verify epsilon and Calm services status:
```
cluster status
```
Enable policy engine for Calm VM. For more information, see Enabling Policy Engine for Calm VM.

Run the following command to set up policy engine on one of the VMs.

docker cp /home/nutanix/bin/set_policy_calmvm.pyc nucalm:/home
docker cp /home/nutanix/bin/set_policy.sh nucalm:/home
docker exec nucalm /bin/sh -c '/home/set_policy.sh <POLICY_VM_IP> <POLICy_VM_UUID>'

What to do next

To manage and administer your applications, use the Calm VM IP address and the following default credentials to log in to the Calm VM for the first time:

Username: admin
Password: Nutanix/4u

You can change the default credentials after you log in.

Enabling Policy Engine for Calm VM

Use the following steps to enable policy engine for Calm VM.

Before you begin

Ensure that you have the accounts configured. For more information, see Provider Account Settings in Calm.
Ensure that you have created a project for the blueprint. For more information, see Projects Overview.
The project to which you upload the blueprint must have the account in which you want to create the policy engine VM.

Procedure

To enable policy engine on a new deployment of Calm VM, do the following:
1. Download the blueprint from one of the following locations.
  - To download the blueprint for a single-node Calm VM, click here.
  - To download the blueprint for a scale-out Calm VM, click here.
2. Upload the downloaded blueprint to a project.
  
  Note: You can add any string in the credential password and save the blueprint to avoid any blueprint errors after the upload.
3. Set values for the following variables in the blueprint.
  - Desired policy engine IP address. This IP address must be in the same network as that of the Calm VM.
  - VIP of the Calm VM
  - Netmask of the Calm VM network
  - Gateway of the Calm VM network
  - DNS IP of the Calm VM
  - NTP IP of the Calm VM
  - Public key of CALM VM. For scale-out Calm VM, provide the public key of all VMs.
  - Disable check-login in case the check-login is enabled by default.
4. Launch the blueprint.
5. Wait for the application that you created by launching the blueprint to get into the running state.
6. SSH into the Calm VM as a Nutanix user and run the following command after making the required changes.
```
docker cp /home/nutanix/bin/set_policy_calmvm.py nucalm:/home
docker cp /home/nutanix/bin/set_policy.sh nucalm:/home
docker exec nucalm /bin/sh -c '/home/set_policy.sh <POLICY_VM_IP> <POLICY_VM_UUID>'
```
To upgrade the policy engine VM on an upgraded Calm VM, do the following:
1. SSH to the policy engine VM as a Nutanix user.
2. Wget the policy-engine.tar.gz file from the Downloads page on to the policy engine VM.
3. Untar (extract) the policy-engine.tar.gz file.
4. Locate and run upgrade.sh .
5. Run the docker ps command to check the status of policy containers, and wait for the containers to get healthy.
To enable the policy engine VM on an upgraded Calm VM where the older version did not have the Policy Engine VM enabled, do the following:
1. Download the set_policy_calmvm.py script from the Downloads page into the /home/nutanix/bin/ directory of your Calm VM and provide the execute permission.
2. Download the set_policy.sh script from the Downloads page into the /home/nutanix/bin/ directory of your Calm VM and provide the execute permission.
3. Perform Step 1 to enable the policy engine VM.

Launching Calm VM with a Static IP Address

By Default, Calm VM uses DHCP IP address. You can use the following procedure to launch Calm VM using a static IP address.

Procedure

Log on to vCenter.
In the Navigator pane, go to Home > Policies and Profiles > Customization Specification Manager .
Click Create a new specification and do the following:

Figure. Create New Specification Click to enlarge
1. In the Target VM Operating System drop-down menu, select Linux .
  
  Figure. Specify Properties Click to enlarge
2. In the Customization Spec Name field, enter a name for the specification.
3. (Optional) Add a description in the Description field.
4. Click Next .
On the Computer Name page, do the following.

Figure. Set Computer Name Click to enlarge
1. Select the Use the virtual machine name radio button.
2. Enter a domain name in the Domain name field.
3. Click Next .
On the Time Zone page, specify the time zone and then click Next .
On the Configure Network page, do the following:

Figure. Configure Network Click to enlarge
1. Select the Manually select custom settings radio button.
2. Click the Edit icon for the NIC to open the IP details page.
  
  Figure. IP Details Click to enlarge
3. On the IPv4 page, select the Prompt the user for an address when the specification is used radio button.
4. Enter the subnet mask in the Subnet Mask field.
5. Enter the default gateway in the Default Gateway field.
6. Click OK .
7. On the Configure Network page, click Next .
On the Enter DNS and Domain Settings page, enter the DNS and DNS search path details, and then click Next .
On the Ready to complete page, verify the details you entered, and then click Finish .
To launch the VM, do the following:
1. Click Actions and then select New VM from This Template... .
  Before you launch the VM, ensure that you have uploaded the Calm VM OVA file to vCenter and converted it as a template.
2. On the Select a name and folder page, enter a name for the VM, select the datacenter location for the VM, and then click Next .
  
  Figure. Name and Datacenter Click to enlarge
3. On the Select a compute resource page, select a cluster or node, and then click Next .
4. On the Select storage page, select the datastore and click Next .
5. On the Select clone options page, select the following check boxes.
  - Customize the operating System
  - Customize this virtual machine’s hardware
  - Power-on virtual machine after creation
6. On the Customize guest OS page, select the customization spec that you created.
  
  Figure. Customization Spec Click to enlarge
7. On the User Settings page, enter the IP address that you want to assign to the VM, and then click Next .
  The User Settings page appears because you selected the Prompt the user for an address when the specification is used radio button during the setup.
  
  Figure. User Settings Click to enlarge
8. On the Customize hardware page, update the CPU, memory, and network requirements, and then click Next .
9. On the Ready to complete page, verify the details you entered, and then click Finish .
Use these steps to launch other VMs in case of a scale-out Calm VM.

What to do next

To set up scale-out Calm VM, see Setting up Scale-Out Calm VM.

Getting Started with Calm

Calm Overview

The following table lists the different tabs in Calm, their icons, and their usage:

Table 1. Calm Tabs
Icons	Tab	Usage
	Marketplace tab	To instantly consume application blueprints to provision applications. See Marketplace Overview.
	Blueprint tab	To create, configure, publish, and launch single-VM or multi-VM blueprints. See Calm Blueprints Overview.
	Application tab	To view and manage applications that are launched from blueprints. See Applications Overview.
	Library tab	To create and use variable types and tasks. You use variables and tasks while configuring a blueprint. See Library Overview.
	Runbooks tab	To automate routine tasks and procedures that pan across multiple applications without involving any blueprints or applications. See Runbooks Overview.
	Endpoints tab	To create and manage target resources where the tasks defined in a runbook or in a blueprint can run. See Endpoints Overview.
	Settings tab	To enable or disable general settings. See General Settings in Calm. To configure and manage provider accounts. See Provider Account Settings in Calm. To configure and manage credential provider. See Configuring a Credential Provider.
	Policies tab	To schedule application actions and runbook executions. See Scheduler Overview.
	Marketplace Manager tab	To manage approval and publishing of application blueprints. See Marketplace Manager Overview.
	Projects tab	To create users or groups and assign permissions to use Calm. Projects tab also allows you to configure environment for your providers. See Projects Overview.

Exploring Calm

You can use the following procedure to explore Calm user interface and get an overview of the Calm components.

Procedure

Click the Tour icon on the bottom-left pane and click Explore Calm .
Do one of the following.
1. To navigate through the Calm components, click the right or left arrow.
2. To skip the tour, click Skip tour .

Accessing Calm REST API Explorer

You can use the following procedure to access the Calm REST API explorer console from the Calm user interface.

Procedure

Click the icon on the bottom-left corner.
The About Nutanix Calm page appears.
Click the Rest API Explorer link.
The Calm REST API explorer interface appears.

Role-Based Access Control in Calm

Calm manages the role-based access control using projects. Projects are logical groupings of user roles, accounts, VM templates, and credentials that are used to manage and launch blueprints and applications within your organization. For more information, see Projects Overview.

Users or groups are allowed to view, launch, or manage applications based on the roles that are assigned within the projects. Calm has the following roles for users or groups:

Project Admin
Project admins have full control of the project. They can perform reporting and user management, create blueprints, launch blueprints, and run actions on the applications.
Developer
Developers can create blueprints, launch blueprints, and run actions on the applications. They are, however, not allowed to perform reporting and user management.
Consumer
Consumers can launch new blueprints from the marketplace and run actions on the applications. They are, however, not allowed to create their own blueprints.
Operator
Operators have minimum access and are allowed only to run actions against existing applications. They are not allowed to launch new blueprints or edit any existing blueprints.

Note: A Prism Admin is a super user within Calm and within the rest of Prism Central who has full access to all the features and functionalities of Calm.

The following table details the roles and responsibilities in Calm:

Table 1. Roles and Responsibilities Matrix
		Prism Admin	Project Admin	Developer	Consumer	Operator
Marketplace	Enable and Disable	X
	Manage	X
	App publishing request	X	X	X
	Send App publishing request to the Administrator	X	X
	Clone and edit App blueprint	X	X	X
Blueprint	Create, update, delete, and duplicate	X	X	X
	Read-only	X	X	X	X
	Launch	X	X	X	X
Applications	Complete App summary	X	X	X	X	X
	Run functions	X	X	X	X	X
	App debug mode	X	X	X	X	X
	Function edit	X	X	X
	Create App (brownfield import)	X	X	X
	Delete App	X	X	X	X
Settings	CRUD	X
Task Library	View	X	X	X	X	X
	Create and Update	X	X	X
	Delete	X
	Sharing with Projects	X
Projects	Add project	X
	Update project	X	X
	Add VMs to projects	X
	Custom roles
Users	Add users to the system and change roles	X
	Add and remove users to or from a project	X	X
	Change user roles in a project	X	X
	Create Administrator	X
	Create Project Administrator	X	X
Runbooks	Create and Update	X	X	X
	View	X	X	X	X	X
	Delete	X	X	X
	Execute	X	X	X	X	X
Endpoints	Create and Update	X	X	X
	View	X	X	X	X	X
	Delete	X	X	X
Scheduler	Create, delete, and clone jobs	X	X	X	X
	Read job and view execution status	X	X	X	X	X
	Update job name, schedule, executable, and application action	X	X	X	X
	Edit operations on a blueprint launch	X	X	X	X
	Edit operations on runbook executions	X	X	X	X
	Edit operations on application actions	X	X	X	X
	Edit operations on Marketplace launch	X	X	X	X

Note: Scheduler does not support custom roles in this release.

Calm: Quick Start

Launching a Blueprint Instantaneously

When you enable Calm, you get an out-of-the-box blueprint, a default project, and a preconfigured application profile with your Nutanix account. You can use the blueprint, project, and application profile to instantaneously launch your first application.

About this task

Video: Launching a Blueprint Instantaneously

Procedure

Click the Tour icon in the bottom-left pane and click Launch Blueprint .
The Quick Launch a Blueprint page appears.
On the Select Blueprint tab, click Next .
The default selection for launch is ExpressLaunch.
On the Select Project tab, select a project and click Next .
Projects are logical groupings of user roles, providers, VM templates, and credentials used to manage and launch blueprints within your organization. For more information, see Projects Overview.
On the Select App Profile tab, click Next .
The default selection for launch is an application profile that is configured with your Nutanix account.

Application profiles are profiles for different datacenters or cloud services where you want to run your application. For more information, see Calm Blueprints Overview.
On the Preview and Launch tab, type a name for your application and click Launch and Create App .
The Preview and Launch tab displays the VM details of your application.

The blueprint application is created and provisioned.

What to do next

You can view the details of the blueprint application on the Applications tab. For more information, see Applications Overview.

Provisioning a Linux or Windows Infrastructure as a Service (IaaS)

To quickly provision a Linux or Windows Infrastructure as a Service (IaaS) for your end users, you can configure and launch a single-VM blueprint in Calm.

Before you begin

Ensure that you have enabled Calm from your Prism Central instance. For more information, see Enabling and Accessing Calm.
Ensure that you have configured the projects that you want to use to provision your IaaS. For more information, see Projects Overview.

About this task

Provisioning a Linux or Windows IaaS involves configuring the single-VM blueprint VM specifications and launching the blueprint.

Procedure

Log on to Prism Central.
From the Prism Central UI, click Services > Calm .
Click the Blueprint icon in the left pane.
Click + Create Blueprint > Single VM Blueprint .
On the Blueprint Settings tab, enter a name and description for your blueprint, and select a project and an environment.

Figure. Blueprint Settings Click to enlarge
On the VM Details tab, enter a VM name, and then select an account and an operating system.

Figure. VM Details Click to enlarge

If you have not configured any account, then keep the default Nutanix account selected. For detailed information about configuring provider accounts, see Provider Account Settings in Calm.

You can select Linux or Windows as the operating system of your IaaS.
On the VM Configuration tab, do the following:
1. Enter the number of vCPU, cores of each vCPU, and total memory to configure the processing unit of the VM.
2. Provide the guest customization, if required.
3. Based on the operating system you selected, select a Linux image or a Windows image from the image service under the Disks section.
4. Select a network configuration under the NICs section.
Figure. VM Configuration Click to enlarge

For detailed information about the VM configuration for different provider accounts, see VM Configuration.
Click Save to save the blueprint.
Click Launch to launch the blueprint.

Figure. Blueprint Launch Click to enlarge
Provide an application name, description, environment, and application profile, and then click Deploy .
If you have not configured any environment or application profile, keep the default environment and application profile selected.
Navigate to the Applications tab to view and access the application.

What to do next

You can publish the blueprint to the marketplace so that other project users can also launch the blueprint and use the IaaS. For more information, see Submitting a Blueprint for Approval.
You can create single-VM blueprints with different provider accounts and launch them. For more information, see Creating a Single-VM Blueprint.

General Settings in Calm

The Settings tab allows you to control the overall administrative functionalities of the Calm instances. You must be a Prism Central administrator to access the Settings tab.

You can use the Settings > General tab to control the following functionalities:

Enable the Default Landing Page option to make Calm as the default landing page in Prism Central.
Enable the availability of ready-to-use application blueprints in the marketplace manager. For more information, see Marketplace Manager Overview.
Enable showback to estimate the overall service cost of the applications running on your on-prem cloud. For more information, see Showback.
Enable the policy engine to enforce resource quota policy for the infrastructure resources (compute, memory, and storage) on Nutanix and VMware. For more information, see Policy Engine Overview.
Set up quota defaults for vCPU, memory, and disk so that they can populate automatically when you allocate quotas to your provider accounts. For more information, see Setting up Quota defaults.
Disable policy engine quota enforcement for your Calm instance in case the policy engine VM does not respond or encounters any connectivity issues. For more information, see Disabling Policy Enforcement.
Download application logs that are archived by the system periodically to clear resources. For more information, see Application Log Archive.

Enabling Nutanix Marketplace Applications

Enable Nutanix Marketplace Applications to view and launch ready-to-use application blueprints. These application blueprints appear on the Marketplace Manager tab for publishing. You can publish the blueprints to the marketplace after associating them with a project.

Procedure

Click the Settings icon in the left pane.
Under the General tab, click the Nutanix Marketplace Apps toggle button.
The application blueprints appear on the Marketplace Manager tab.

What to do next

You can associate the ready-to-use application blueprints with a project and publish them to the marketplace. For more information, see Approving and Publishing a Blueprint or Runbook.

Showback

Showback allows you to estimate the overall service cost of the applications running on your on-prem cloud. You can also view the graphical representation of the cost of the applications.

Calm supports showback for the following platforms.

Nutanix
VMware through vCenter

To enable and configure showback, see Enabling Showback.

Note: Starting with AOS 5.10 or NCC 3.6.3, Prism Central generates the following NCC alerts for showback:

Beam connectivity with Prism Central
Prism Central and Prism web console (also known as Prism Element) registration or de-registration

Enabling Showback

Enable Showback to configure the resource cost of your applications and monitor them while you configure a blueprint or manage an application. Showback is applicable only for the Nutanix platform and the VMware through vCenter platform.

About this task

Video: Enabling Showback

Procedure

Log into Prism Central as an administrator.
Click the Settings icon in the left pane.
Under the General tab, click the Enable Showback toggle button.
The Enable Showback window is displayed.
Click the supported provider for which you want to define the cost.
To configure the resource usage cost, click Edit for the selected provider, and configure the cost of the following resources.
1. In the vCPU field, enter the cost of vCPU consumption for each hour in dollars.
  The default value is $0.01 for each vCPU for each hour.
2. In the Memory field, enter the cost of memory consumption for each hour in dollars.
  The default value is $0.01 for each GB of usage for each hour.
3. In the Storage field, enter the cost of storage consumption for each hour in dollars.
  The default value is $0.0003 for each GB of usage for each hour.
Click Enable Showback .

Disabling Showback

Disable showback to stop monitoring the resources cost of your application blueprints.

Procedure

Log into Prism Central as an administrator.
Click the Settings icon in the left pane.
Under the General tab, click the Disable Showback toggle button.
The Disable Showback window is displayed.
To disable Showback, click Disable Showback .

Policy Engine Overview

The policy engine is a single-VM setup for the single or scale-out Prism Central. When you enable the policy engine for your Calm instance, a new VM is created and deployed for the policy engine. All you need is an available IP address that belongs to the same network as that of your Prism Central VM for the policy engine VM.

As an administrator, you can enable the policy engine to:

Enforce resource quota policy for the infrastructure resources (compute, memory, and storage) on Nutanix and VMware. The quota policy enforcement allows better governance on resources across infrastructures at the provider and project levels. See Quota Policy Overview.
Orchestrate applications through tunnels on a virtual private network (VPC) on Nutanix accounts. See Tunnels for Orchestration within a VPC.
Enforce approval policies to manage resources and control actions in your environment. See Approval Policy Overview.
Schedule application actions and runbook executions. See Scheduler Overview.

Enabling policy Engine

The policy engine is a single-VM setup for the single or scale-out Prism Central.

About this task

When you enable the policy engine for your Calm instance, a new VM is created and deployed for the policy engine. All you need is an available IP address that belongs to the same network as that of your Prism Central VM for the policy engine VM.

Note:

If your Prism Central is on ESXi, add the VMware provider account for the vCenter that manages the host where the Prism Central VM resides to your Calm.
For quota consumption of running applications, you can either wait for the next platform sync to happen or run platform sync manually after the policy engine enablement. For more information on how to run platform sync, see Synchronizing Platform Configuration Changes.
When you upgrade Calm to the latest version as part of the Prism Central upgrade and if the policy engine is enabled, then ensure to upgrade your policy engine to the latest version using LCM.
If an HTTP proxy is configured, ensure that the IP address you provide for the policy engine VM is added to the HTTP-proxy whitelist.

Procedure

Click the Settings icon in the left pane.
The Settings page appears.
On the Policies tab, enter the IP address in the IP Address for Policy Engine field.
The IP address must be an available IP address and must belong to the same network as that of your Prism Central VM.

Figure. Enable Policy Engine Click to enlarge
Click the Enable button.
Click the Confirm button to enable the policy engine.

What to do next

To get quota consumption of running applications for the first time after enabling the policy engine, you can wait for the platform sync to happen or run the platform sync manually. After the first update, all future updates will happen instantly. For information on how to run platform sync, see Synchronizing Platform Configuration Changes.
Allocate resource quotas to provider accounts. See Allocating Resource Quota to an Account.
Allocate resource quotas to projects. See Managing Quota Limits for Projects .
Create VPC tunnels on Nutanix accounts. See Creating VPC Tunnels.
Create approval policies for runbook executions, application launch, or application day-2 operations. See Creating an Approval Policy.
Schedule application actions and runbook executions. See Creating a Scheduler Job.

Enabling Policy Engine at a Dark Site

You can enable the policy engine at a dark site.

Before you begin

If your Prism Central is on ESXi, add the VMware provider account for the vCenter that manages the host where the Prism Central VM resides to your Calm.

Procedure

Download the policy engine image of the version that is compatible with your Calm version from the Downloads page of the Support & Insights Portal:
https://portal.nutanix.com/page/downloads?product=calm
Do one of the following:
- If your Prismr Central is on AHV, upload the image on Prism Central with the following name:
  <Calm version number>-CalmPolicyVM.qcow2
- If your Prism Central is on ESXi, manually upload the image as template on the vCenter host where the Prism Central VM resides with the following name:
  <Calm version number>-CalmPolicyVM.ova
After uploading the image, enable the policy engine on the Settings page. For more information on enabling the policy engine, see Enabling policy Engine.

Setting up Quota defaults

After you enable the policy engine, you can set up the default quota values for vCPU, memory, and disk. This step is optional.

About this task

Setting up quota defaults saves you from repeatedly entering vCPU, memory, and disk quota values for each cluster. After you set the quota defaults, the default quota values populate automatically when you allocate quotas to your provider accounts.

Note: The quota defaults are visible in the accounts only after the next platform sync. You can also run the platform sync manually. For information on how to run platform sync, see Synchronizing Platform Configuration Changes.

Before you begin

Ensure that you enabled the policy engine for your Calm instance. For information about enabling the policy engine, see Enabling policy Engine.

Procedure

Click the Settings iconic the left pane.
The Settings page appears.
On the Policies tab, click the Quotas tab in the left pane.
Select the Set Quota Defaults check box.
Specify the values for vCPU , Memory , and Disk .
Click the Save icon next to the fields.

Viewing Policy Engine VM Details

After you enable policy engine, review the policy engine VM configuration, network configuration, and cluster information on the Policies tab of your Setttings page. For example, you can view the power status, protection status, or cluster name of the policy engine VM.

Before you begin

Ensure that you have enabled the policy engine for your Calm instance. For information about enabling the policy engine, see Enabling policy Engine.

Procedure

Click the Settings icon in the left pane.
The Settings page appears.
On the Policies tab, click the Policy Settings tab in the left pane.
Expand the Policy Engine VM Details section to view the policy engine VM details.

Disabling Policy Enforcement

Disable the policy enforcement for your Calm instance if the policy engine VM encounters any connectivity issues or the policy engine VM is not responding.

About this task

When you disable policy enforcement, policies are not enforced for quota checks and approval policies.

Procedure

Click the Settings icon in the left pane.
The Settings page appears.
On the Policies tab, click the Policy Settings tab in the left pane.
Select the Skip Policy Checks check box to disable the policy enforcement.
Click the Confirm button.

Enabling Approvals

You can enable approvals for your Calm instance from the settings page.

About this task

Caution: This feature is currently in technical preview and is disabled by default. Do not use any technical preview features in a production environment.

When you enable approvals, events such as runbook executions, application launch, and application day-2 operations that match the conditions defined in the approval policy go through the approval process.

Procedure

Click the Settings icon in the left pane.
The Settings page appears.
On the Policies tab, click the Approvals tab in the left pane.
Use the Approvals toggle button to enable approvals.

Disabling Approvals

You can disable approvals for your Calm instance from the Settings page.

About this task

When you enable approvals, events such as runbook executions, application launch, and application day-2 operations do not go through the approval process even when they match the conditions defined in the approval policy.

Procedure

Click the Settings icon in the left pane.
The Settings page appears.
On the Policies tab, click the Approvals tab in the left pane.
Use the Approvals toggle button to disable approvals.

Viewing Approval Email Templates

You can view the configuration details and email template on the Policies tab of the Settings page.

Procedure

Click the Settings icon in the left pane.
The Settings page appears.
On the Policies tab, click the Approvals tab in the left pane.
Under the General Configuration section, view details such as the number of days after which a request expires and the frequency of the email sent to the approver and requester.
Under the Email Content section, click the For Approver or For Requester tabs to view the template of the emails that are sent with each request.

Figure. Email Template Click to enlarge
The content of the email templates for approver or requester can be modified only using the APIs. You can use the following supported email template variables.
- Approver
- Requester
- ConditionDetails
- Event
- EntityType
- EntityName
- State
- PCIP
- CreationTime
- ExpirationTime
- NutanixLogo
You can use these variables with the {{}} syntax. For example, {{.PCIP}} .

Application Protection Status

You can view the protection and recovery status of a Calm application when:

The VMs of the application running on a Nutanix platform are protected by a protection policy in Prism Central.
You enabled the option to show application protection status in Calm.

You can view the protection and recovery status of the application on the Application Overview page. For more information, see Overview Tab.

Note:

The option to show application protection status is available only when at least one VM of the application is protected by a protection policy in Prism Central.
You can view the protection and recovery status of the Calm applications if the versions of Prism Central and Prism Element are 5.17 or later.
If the target recovery location is set to another Prism Central, Calm still displays the correct protection status. However, the recovery is not tracked, and there is no recovery status available for the application. Calm application still points to the old VMs.

To enable the option to show application protection status, see Enabling Application Protection Status View.

Enabling Application Protection Status View

Enable the Show App Protection Status toggle button to view the protection and recovery status of a Calm application that is deployed on a Nutanix platform. You must be a Prism Central administrator to enable or disable the toggle button.

Before you begin

Ensure that the versions of Prism Central and Prism Element are 5.17 or above.
Ensure that at least one VM of the application is protected by a protection policy in Prism Central.

Procedure

Log on to Prism Central as an administrator.
From the Prism Central UI, click Services > Calm .
Click the Settings icon in the left pane.
Under the General tab, click the Show App Protection Status toggle button.

What to do next

You can view the protection and recovery status of the application in the application Overview page. For more details, see Overview Tab.

Application Log Archive

Calm automatically archives run logs of the deleted applications and custom actions that are older than three months. You can download the archives within 7 days from the time of archive creation.

For a running application, data is not archived for the system-generated Create actions.

You can get the following information for Start, Restart, Stop, Delete, and Soft Delete system-generated actions and user-created actions.

Started by
Run by
Status

Calm archives all action details of a deleted application.

Only an administrator can view and download the application log archive. For more information, see Downloading Application Log Archive.

Downloading Application Log Archive

Calm periodically archives application logs to clear resources. You can download the archived application logs from the Settings tab.

Procedure

Log into Prism Central as an administrator.
From the Prism Central UI, click Services > Calm .
Click the Settings icon in the left pane.
Under Application log archive is ready to download , click Download .
The tar.gz file is downloaded.

Provider Account Settings in Calm

Provider accounts are cloud services, baremetals, or existing machines that you can use to deploy, monitor, and govern your applications. You can configure multiple accounts of the same provider.

Use the Settings > Accounts tab to configure provider accounts. You configure provider accounts (by using the provider credentials) to enable Calm to manage applications by using your virtualization resources.

Calm supports the following provider accounts:

Table 1. Provider Accounts
Provider Accounts	Description
Nutanix	All the AHV clusters that are registered to the Prism Central instance are automatically added as providers. Note: If you want to add a remote Prism Central (PC) instance as a provider in a multi-PC setup, you must add the remote PC instance as an account in Calm. For more information, see Configuring a Remote Prism Central Account.
VMware	To configure a VMware account, see Configuring a VMware Account.
AWS	To configure an AWS account, see Configuring an AWS Account.
Azure	To configure an Azure account, see Configuring an Azure Account.
GCP	To configure a GCP account, see Configuring a GCP Account.
Kubernetes	To configure a Kubernetes account, see Configuring a Kubernetes Account.
Xi Cloud	To configure Xi Cloud as a provider, see Configuring a Xi Cloud Account.

Nutanix Account Configuration

All AHV clusters that are registered to your Prism Central instance are automatically added as provider accounts to Calm.

You can also configure any remote Prism Central (PC) as an account in Calm to deploy applications on the remote PC. For more information, see Support for Multi-PC Setup.

Support for Multi-PC Setup

In a multiple Prism Centrals (multi-PC) setup, a central Calm instance (called global Calm instance) runs only on one of the PCs (called host or parent PC) and all the other PCs are connected to the central Calm instance as the remote PCs.

The global Calm instance can now manage the applications deployed on the geographically distributed Prism Centrals (also called remote PCs) without the need of separate Calm instances for every PC. A remote PC is only used to provision the tasks for the deployed applications.

In a multi-PC environment, every remote PC is added as an account to the host PC and you can add the account to your project before creating and launching a blueprint.

For more information about adding a remote PC as an account, see Configuring a Remote Prism Central Account.

For more information about adding the account to a project, see Adding Accounts to a Project.

Configuring a Remote Prism Central Account

To deploy an application on a remote PC, you must configure the remote PC as an account in Calm.

About this task

You require the role of a Prism Admin to configure a remote PC account.

For more information about multiple Prism Central setup support, see Support for Multi-PC Setup.

Procedure

Click the Settings icon in the left pane.
Click the Account tab.
The account inspector panel appears.
Click +Add Account .
The Account settings page appears.
In the Name field, type a name for the PC account.
From the Provider list, select Nutanix .

Figure. Remote Prism Central Account Click to enlarge
In the PC IP field, type the IP address of the remote PC.
The application is provisioned in the remote PC IP address.
In the PC Port field, type the port number for the IP address.
In the User name field, type the administrator username of the remote PC.
In the Password field, type the administrator password of the remote PC.
In the Account Sync Interval field, specify the interval after which the platform sync must run for a cluster.
Calm uses platform sync to synchronize any configuration changes occur in Calm-managed resources, such as IP Address changes, disk resizing, and so on. Platform sync enables Calm to maintain accurate quota and Showback information.
Click Save .
The account list displays the account that you created.
To verify the credentials of the account, click Verify .
Calm adds the remote PC as a Nutanix account after credential authentication and account verification.

Tunnels for Orchestration within a VPC

Calm lets you use Virtual Private Clouds within the Flow Virtual Networking framework to network the VMs using overlay networks. A VPC is an independent and isolated IP address space that functions as a logically isolated virtual network. VMs that you create with VPC Subnets cannot communicate with a VM that is outside the VPC. Even the VMs outside the VPC cannot reach the VMs within the VPC.

In the absence of this direct communication, you can set up tunnels to communicate with the VMs within the VPC for orchestration activities and to run script-based tasks. You can set up the tunnel VM in any one of the subnets within the VPC.

To set up tunnels for your VPCs, you must:

Have Flow Virtual Networking enabled in the Prism Central that hosts the Calm instance (see Enabling Flow Networking). For more information on VPCs, see Virtual Private Cloud.
Enable the Advanced Network Controller.
Attach an external subnet (VLAN) to the VPC to enable the tunnel VM to reach the policy engine VM and establish a tunnel connection. An external subnet allows VMs inside the VPC to reach the VMs that are outside the VPC network.
Ensure that the VMs inside the VPC is able to ping the policy engine VM and Prism Central.
Permit traffic from the tunnel VM to the Policy Engine VM on port 2222 using TCP connections.
Allow connections on default 22 port for SSH script execution or default 5985 for Powershell script execution on the target VM.
Enable the policy engine in Calm to allow the tunnel VM to communicate with Calm.
Have 2 vCPUs, 2 GiB memory and 10 GiB disk space for the tunnel VM.

For more information on creating VPC tunnels, see Creating VPC Tunnels.

Creating VPC Tunnels

In your Nutanix account, you set up tunnels to get access to the VMs that are created within the VPCs.

About this task

The tunnels that you create enables you to perform check log-in and run script-based execution tasks on the VMs that use the overlay subnets of the VPC.

If tunnel is not configured for the selected VPC, you can only perform basic operations (such as VM provisioning) on the VPC.

Before you begin

Ensure that you have enabled the policy engine on the Settings page. For details about enabling the policy engine, see Enabling policy Engine. To know other requirements to set up the tunnel, see Tunnels for Orchestration within a VPC.

Procedure

Click the Settings icon in the left pane.
Click the Accounts tab.
Select the Nutanix account in the left pane.
The Account Settings page appears.
In the VPC Tunnels section, do the following to set up the tunnel.
1. Click Create Tunnel .
  The Create Tunnel for VPCs window appears.
  Figure. Create Tunnel Click to enlarge
2. From the Select VPC list, select the VPC on which you want to set up the tunnel.
3. From the Select VPC Subnet , select the subnet that must be used for the NIC of the tunnel VM.
4. Under Tunnel Configuration section, select the cluster on which you want to place the VM from the Select Cluster list.
5. In the Tunnel Name field, edit the name of the tunnel. This step is optional.
  The tunnel name is auto-generated to ensure uniqueness. You can only edit or append based on your requirement.
6. In the Tunnel VM Name field, edit the tunnel VM name. This step is optional.
  The tunnel VM name is auto-generated to ensure uniqueness. You can only edit or append based on your requirement.
7. Click Create .

Configuring a VMware Account

Configure your VMware account in Calm to manage applications on the VMware platform.

About this task

Note:

If you do not have an administrator user account in vCenter while configuring the account, then you can also use a user account with required permissions. See Permission Required in vCenter.
You cannot enable Calm with vSphere Essentials edition license because vSphere Essentials edition does not support hot-pluggable virtual hardware.
With VMware accounts, Calm also supports virtual switch (vSwitch) networks and VMware NSX-based networks.

To refer to the video about setting up VMware as provider, click here.

Procedure

Click the Settings icon in the left pane.
Click the Accounts tab.
The account inspector panel is displayed.
Click +Add Account .
The Account Settings page appears.
Figure. Account- VMware Click to enlarge
In the Name field, type a name for the account.

Note: The name you specify appears as the account name when you add the account to a project.
From the Provider list, select VMware .
In the Server field, type the server IP address of the vCenter server.
In the Username field, type the user name of the vCenter account.
If a domain is part of the username, then the username syntax must be <username>@<domain> .
In the Password field, type the password of the account.
In the Port field, type the port number as 443 .
Click Save .
From the Datacenter list, select the datacenter.
A VMware datacenter is the grouping of servers, storage networks, IP networks, and arrays. All the datacenters that are assigned to your vCenter account are available for your selection.
In the Account Sync Interval field, specify the interval after which the platform sync must run for a cluster.
Calm uses platform sync to synchronize any configuration changes occur in Calm-managed VMware resources, such as IP Address changes, disk resizing, and so on. Platform sync enables Calm to maintain accurate quota and Showback information.
To monitor the operating cost of your applications, configure the cost of the following resources. This step is optional.

Note: Ensure that you have enabled showback. For more information about enabling showback, see Enabling Showback.
- In the vCPU field, type the cost of vCPU consumption for each hour in dollars. The default value is $0.01 for each vCPU for each hour.
- In the Memory field, type the cost of memory consumption for each hour in dollars. The default value is $0.01 for each GB of usage for each hour.
- In the Storage field, type the cost of storage consumption for each hour in dollars. The default value is $0.0003 for each GB of usage for each hour.
Click Save .
To verify the credentials of the account, click Verify .
Calm lists the account as an active account after successful credential authentication and account verification.

What to do next

Create a project and configure a VMware environment, see Creating a Project and Configuring VMware Environment.

Permission Required in vCenter

The following table provides the complete list of permissions that you need to enable in vCenter before you configure your VMware account in Calm.

Table 1. Permissions required in vCenter
Entity	Permission
Datastore	Allocate space Browse datastore Low level file operation Update virtual machine files
Network	Assign Network Configure Move Network
Resource	Assign virtual machine to resource pool
vSphere Tagging	All
Virtual Machine > Change Configuration	Add existing disk Add new disk Add or remove device Change CPU count Change memory Modify device settings Configure raw device Rename Set annotation Change settings Upgrade virtual machine compatibility
Virtual Machine > Interaction	Configure CD media Connect devices Power On Power off Reset Install VMware tools
Virtual Machine > Edit Inventory	Create from existing Remove
Virtual Machine > Provisioning	Clone template Customize guest Deploy template Read customization specifications

You must define the custom role at the vCenter level instead of the Datacenter level. For information on how to enable permissions in vCenter, see the vSphere Users and Permissions section in the VMware documents.

Supported vSphere Versions

Calm supports the following versions of vSphere.

Configuring an AWS Account

Configure your AWS account in Calm to manage applications on the AWS platform.

Before you begin

Ensure that you have the following accounts and details.

An AWS account with valid credentials.
An IAM user account. For information on how to create an IAM user account, refer to AWS Documentation .
A user account with full EC2 access and IAM read-only access.
The access key ID and the secret access key for the IAM user account.

Note:

Ensure that you have configured the domain name server (DNS). To verify the DNS configuration, from the Prism Central UI, click Prism Central > Gear icon > Name Servers and run the following command.
```
nutanix@cvm$ ncli cluster get-name-servers
```
If you are configuring DNS now, then you must restart the Prism Central VM.

Procedure

Click the Settings icon in the left pane.
Click the Accounts tab.
The account inspector panel appears.
Click +Add Account .
The Account Settings page appears.
Figure. Account- AWS Click to enlarge
In the Name field, type a name for the account.
From the Provider list, select AWS .
In the Access Key ID field, type the access key ID of your AWS account.
In the Secret Access Key field, type the secret access key of your AWS account.
From the Regions list, select the geographical regions.
By default, Calm includes all regions except China and GovCloud in the account. You can remove a region from the account. You can also clear the All Regions check box and select regions from the Regions list.

Warning: Removing a region from an existing AWS account impacts the deployed VMs in that region.
In the Search Public Image field, search the public image applicable to your region, and select the public image. This step is optional.
You must authenticate the credentials before searching. You can select multiple public images and use any of the selected public images when you create a blueprint for AWS.
Click Save .
To verify the credentials of the account, click Verify .
Calm lists the account as an active account after successful credential authentication and account verification.

What to do next

Create a project and configure an AWS environment, see Creating a Project and Configuring AWS Environment.

Configuring AWS C2S Provider on Calm

GovCloud (US) is an isolated AWS region to help the United States government agencies and federal IT contractors host sensitive workloads into the cloud by addressing their specific regulatory and compliance requirements.

About this task

With AWS C2S support in Calm, you can configure your GovCloud authentication, and then create or manage your workload instances on AWS GovCloud region as done for other AWS regions. The AWS GovCloud provides the same high-level security as other AWS regions, however, the Commercial Cloud Services (C2S) and the C2S Access Portal (CAP) are used to grant controlled access to the C2S Management Console and C2S APIs for Government users and applications.

Note:

The AWS GovCloud (US) region supports the management of regulated data by restricting physical and logical administrative access to U.S. citizens only.

Before you begin

Ensure that you have the following accounts.

An AWS GovCloud (US) account with valid credentials.
A C2S account configured in AWS.

Procedure

Click the Settings icon in the left pane.
Click the Accounts tab.
The inspector panel appears.
Figure. Provider- AWS Click to enlarge
In the Name field, type the name of the account.
From the Type list, select AWS C2S .
In the C2S account address field, type the C2S account IP address.
In the Client Certificate field, type or upload the client certificate.
In the Client Key field, type or upload the client key.
In the Role field, type the required IAM role.
In the Mission field, type the mission.
In the Agency field, type the agency.
Select All GovCloud Regions check box to select all the GovCloud regions.
Click Save .
To verify the credentials of the account, click Verify .
Calm lists the account as an active account after successful credential authentication and account verification.

What to do next

You can use the configured AWS C2S provider while you create a blueprint.

Configuring AWS User Account with Minimum Privilege

To manage applications on the AWS platform using Calm, you must have a privileged AWS user account with an appropriate policy.

Before you begin

Ensure that you have an AWS administrator user account.

Procedure

Log on to the AWS console with your AWS administrator account.
Click Services > IAM .
To add a user, click Users > Add User .
On the Add User page, do the following.
1. In the User name field, type a user name.
2. In the Access Type area, select the check boxes next to the Programmatic access and AWS Management Console access fields, and then click Next: Permission .
  
  Note: Do not configure any fields on the Set Permission page.
3. Click Next: Tags .
4. To add a tag to a user, type the key and value pair in the Key and Value fields.
  For more information about IAM tags, see AWS Documents .
5. Click Next: Review .
6. Click Create User .
  An IAM user is created.
7. To display the credential of the user, click Show in the Access key ID , Secret access Key , and Password fields.
  
  Note: Copy the credentials in a file and save the file on to your local machine. You need the credentials when you configure AWS as an account in Calm to manage applications.
To assign permission to the user, click the user you created on the Users page.
The Summary page appears.
On the Permissions tab, click + Add inline policy .

On the Create Policy page, click the JSON tab and use the following JSON code in the code editor area.


{
	"Version": "2012-10-17",
	"Statement": [
    	{
        	"Effect": "Allow",
        	"Action": [
            	"iam:ListRoles",
            	"iam:ListSSHPublicKeys",
            	"iam:GetSSHPublicKey",
            	"iam:GetAccountPasswordPolicy",
            	"ec2:RunInstances",
            	"ec2:StartInstances",
            	"ec2:StopInstances",
            	"ec2:RebootInstances",
            	"ec2:CreateTags",
            	"ec2:CreateVolume",
            	"ec2:CreateSnapshot",
            	"ec2:CreateImage",
            	"ec2:ModifyImageAttribute",
            	"ec2:ModifyInstanceAttribute",
            	"ec2:AttachVolume",
            	"ec2:DetachVolume",
            	"ec2:ModifyVolume",
            	"ec2:AssociateIamInstanceProfile",
            	"ec2:ReplaceIamInstanceProfileAssociation",
            	"ec2:DisassociateIamInstanceProfile",
            	"ec2:RegisterImage",
            	"ec2:DeregisterImage",
            	"ec2:DeleteSnapshot",
            	"ec2:GetConsoleOutput",
            	"ec2:Describe*",
            	"ec2:DeleteTags",
            	"ec2:TerminateInstances"
        	],
        	"Resource": "*"
    	},
    	{
        	"Effect": "Allow",
        	"Action": ["iam:ListUserPolicies"],
        	"Resource": ["arn:aws:iam::*:user/${aws:username}"]
    	},
    	{
        	"Effect": "Allow",
        	"Action": ["iam:PassRole"],
        	"Resource": ["arn:aws:iam::*:role/*"]
    	}
	]
}

Click Review Policy .
On the Review Policy page, in the Name field, type a name for the policy and click Create policy .

What to do next

You can configure AWS as a provider on the Settings page. For more information, see Configuring an AWS Account. You can also assign different policy privileges to the user. For more information, see AWS Policy Privileges.

AWS Policy Privileges

The following table displays the list of user policy privileges and the corresponding JSON attributes that you can add in the JSON syntax to assign different privileges to a user.

Table 1. User Privileges and the JSON attributes
To create	JSON attributes
EC2 Instances	`ec2:RunInstances`
Volumes	`ec2:CreateVolume`
Snapshot	`ec2:CreateSnapshot`
Image(AMI)	`ec2:CreateImage`
To list or get	JSON attributes
SSH Public Keys for all users	`iam:ListSSHPublicKeys`
List IAM Roles	`iam:ListRoles`
EC2 attributes	`ec2:Describe*`
EC2 instance console output	`ec2:GetConsoleOutput`
IAM user policies for the user	`iam:ListUserPolicies`
To update	JSON attributes
Image(AMI) attributes	`ec2:ModifyImageAttribute`
To delete	JSON attributes
EC2 Instances	`ec2:TerminateInstances`
Instance Tags	`ec2:DeleteTags`
Snapshot	`ec2:DeleteSnapshot`
Images(deregister images)	`ec2:DeregisterImage`
Others	JSON attributes
Start/Stop/Restart Instances	`ec2:RunInstances, ec2:StartInstances, ec2:StopInstances, ec2:RebootInstances`
Pass and IAM role to service	`iam:PassRole`

Configuring a GCP Account

Configure your GCP account in Calm to manage applications on the GCP platform.

Before you begin

Ensure that you have the service account file of your GCP account in a JSON format saved on your local machine. To create a GCP service account file, see the GCP documentation .

Procedure

Click the Settings icon in the left pane.
Click the Accounts tab.
The account inspector panel is displayed.
Click +Add Account .
The Account Settings page appears.
Figure. Account- GCP Click to enlarge
In the Name field, type a name for the account.
From the Provider list, select GCP .
To import the service account file from your local machine, click Service Account File .
A service account file is a special Google account file that you can use to upload the details of your GCP account.

The values in the Project ID , Private Key , Client Email , and Token URI fields are auto-filled after you upload the file.
From the Regions list, select the geographical regions.
By default, Calm includes all regions in the account. You can remove a region from the account. You can also clear the All Regions check box and select regions from the Regions list.

Warning: Removing a region from an existing GCP account impacts the deployed VMs in that region.
Select the Enable GKE check box to enable Google Kubernetes Engine (GKE). This step is optional.
In the Server IP field, type the GKE leader IP address.
In the Port field, type the port number.
Click Save .
To verify the credentials of the account, click Verify .
Calm lists the account as an active account after successful credential authentication and account verification.

What to do next

To troubleshoot some common issues, see KB-5616. You can create a project and configure a GCP environment, see Creating a Project and Configuring GCP Environment.

Configuring an Azure Account

Configure your Azure account in Calm to manage applications on the Azure platform.

About this task

Note:

For detailed description of the required fields, refer to the Azure documentation .
Only authorized organizations can use restricted regions like Australia Central through Calm. For more information, refer to the Microsoft documentation .

Before you begin

Assign appropriate role to your application. For detailed information, refer to the Microsoft documentation .

Procedure

Click the Settings icon in the left pane.
Click the Accounts tab.
The account inspector panel appears.
Figure. Account- Azure Click to enlarge
In the Name field, type a name for the account.
From the Provider list, select Azure .
Do the following under the Service Principal Credentials section.
1. In the Directory/Tenant ID field, type the directory/tenant ID of your Azure application.
2. In the Application/Client ID field, type the application/client ID.
3. In the Client Key/Secret field, type the client key or secret.
From the Subscriptions list, select your Azure subscriptions.
The subscriptions you select provide access to the associated resource groups during blueprint configuration. The subscriptions allow you to launch VMs in the associated resource groups with a single account. When you do not select any subscriptions, Calm provides access to all the subscriptions available in the Azure service principal.
From the Default Subscription list, select a default subscription. This step is optional.
Specify the default subscription if the Azure VM configurations such as blueprints and marketplace items created in any earlier versions of Calm require any backward compatibility.
From the Cloud Environment list, select a cloud environment.
You can select Public Cloud , US Government Cloud , China Cloud , or German Cloud .
Click Save .
To verify the credentials of the account, click Verify .
Calm lists the account as an active account after successful credential authentication and account verification.

What to do next

Create a project and configure an Azure environment, see Creating a Project and Configuring Azure Environment.

Configuring Azure User Account with Minimum Privilege

You must have a privileged Azure user account to manage applications on an Azure platform using Calm.

About this task

To refer to a video about assigning minimum privilege to configure Azure account to work with Calm, click here.

Procedure

Log on to Azure portal with your administrator account.
Open https://shell.azure.com and select bash.

Create a .json file with the following content.

{
  "Name": "Calm Admin",
  "IsCustom": true,
  "Description": "For calm to manage VMs on azure provisioned from calm applications",
  "Actions": [
    "Microsoft.Storage/storageAccounts/read",
    "Microsoft.Storage/storageAccounts/write",
    "Microsoft.Storage/checknameavailability/read",
    "Microsoft.Storage/skus/read",
    "Microsoft.Network/virtualNetworks/subnets/*",
    "Microsoft.Network/virtualNetworks/read",
    "Microsoft.Network/networkSecurityGroups/*",
    "Microsoft.Network/networkInterfaces/*",
    "Microsoft.Network/publicIPAddresses/*",
    "Microsoft.Network/publicIPPrefixes/*",
    "Microsoft.Compute/availabilitySets/vmSizes/read",
    "Microsoft.Compute/availabilitySets/read",
    "Microsoft.Compute/availabilitySets/write",
    "Microsoft.Compute/disks/*",
    "Microsoft.Compute/images/read",
    "Microsoft.Compute/images/write",
    "Microsoft.Compute/locations/publishers/read",
    "Microsoft.Compute/locations/publishers/artifacttypes/offers/read",
    "Microsoft.Compute/locations/publishers/artifacttypes/offers/skus/read",
    "Microsoft.Compute/locations/publishers/artifacttypes/offers/skus/versions/read",
    "Microsoft.Compute/skus/read",
    "Microsoft.Compute/snapshots/*",
    "Microsoft.Compute/locations/vmSizes/read",
    "Microsoft.Compute/virtualMachines/*",
    "Microsoft.Resources/subscriptions/resourceGroups/read",
    "Microsoft.Resources/subscriptions/resourceGroups/write",
    "Microsoft.Resources/subscriptions/resourceGroups/delete",
    "Microsoft.GuestConfiguration/*/read",
    "Microsoft.GuestConfiguration/*/write",
    "Microsoft.GuestConfiguration/*/action",
    "Microsoft.Compute/galleries/read",
    "Microsoft.Compute/galleries/images/read",
    "Microsoft.Compute/galleries/images/versions/read",
    "Microsoft.KeyVault/vaults/read",
    "Microsoft.KeyVault/vaults/deploy/action"
  ],
  "NotActions": [],
  "AssignableScopes": [
    "/subscriptions/<subscription id>"
  ]
}

In the Azure cloud shell, run the following command.
```
az role definition create --role-definition <file>.json
```
Use the file you created in step 4 in place of <file>.json .

Calm Admin user role is created.
In the Azure cloud shell, run the following command to create an Azure Service Principal. The command returns all the information required to add the Azure account in Calm.
```
az ad sp create-for-rbac -n "CalmAccount" --role "Calm Admin"
```
Copy the values for appId , password , and tenant . You need these values to add the Azure account in Calm.

Configuring a Kubernetes Account

Configure your Kubernetes account in Calm to manage applications on the Kubernetes platform.

Before you begin

Ensure that you meet the following requirements.

You have a compatible version of Kubernetes. Calm is compatible with Kubernetes 1.16 and 1.17.
You have necessary RBAC permissions on the Kubernetes server.
You have the authentication mechanism enabled on the Kubernetes cluster.

Procedure

Click the Settings icon in the left pane.
Click the Accounts tab.
The account inspector panel is displayed.
Click +Add Account .
The Account Settings page appears.
Figure. Provider- Kubernetes Click to enlarge
In the Name field, type a name for the account.
From the Provider list, select Kubernetes .
From the Type list, select one of the following.
- Select Vanilla to self deploy the kubernetes clusters.
- Select Karbon to add Karbon as the provider type. Nutanix Karbon is a curated turnkey offering that provides simplified provisioning and operations of Kubernetes clusters.
If you have selected the kubernetes type as Vanilla , then do the following.
1. In the Server IP field, type the Kubernetes leader IP address.
2. In the Port field, type the port number of the Kubernetes server.
3. From the Auth Type list, select the authentication type.
  You can select one of the following authentication types.
  - Basic Auth : Basic authentication is a method for an HTTP user agent, for example, a web browser, to provide a user name and password when making a request.
  - Client Certificate : A client certificate is a digital certificate protected with a key for authentication.
  - CA Certificate : A client authentication certificate is a certificate that is used to authenticate clients during an SSL handshake. The certificate authenticates users who access a server by exchanging the client authentication certificate.
  - Service Account : A service account is an automatically enabled authenticator that uses signed bearer tokens to verify requests.
4. If you have selected Basic Auth , then do one of the following.
  - In the Username field, type the username. If the domain is a part of the username, then the username syntax should be <username>@<domain> .
  - In the Password field, type the password.
5. If you have selected Client Certificate , then do one of the following.
  - Under Client Certificate , upload the client certificate.
  - Under Client Key , upload the private key.
6. If you have selected CA Certificate , then do one of the following.
  - Under CA Certificate , upload the CA certificate.
  - Under Client Certificate , upload the client certificate.
  - Under Client Key , upload the private key.
7. If you selected Service Account , then do one of the following.
  - Under Token , upload the service account authentication token.
  - Under CA Certificate , upload the CA certificate.
If you have selected the kubernetes type as Karbon , then do the following.
1. In the Cluster list, select the respective kubernetes cluster that you want to add.
Click Save .
To verify the credentials of the account, click Verify .
Calm lists the account as an active account after successful credential authentication and account verification.

Configuring Amazon EKS, Azure Kubernetes Service, or Anthos

For Calm to manage workloads on Amazon EKS, Azure Kubernetes Service (AKS), or Anthos, enable the generic authentication mechanism and create a service account on the Kubernetes cluster. You can then use the service account to communicate with the cluster.

Procedure

Create a service account by running the following Kubernetes command:
kubectl create serviceaccount ntnx-calm

A service account is a user that the Kubernetes API manages. A service account is used to provide an identity for the processes that run in a pod.
Bind the cluster admin role to the Calm service account using the following command:
kubectl create clusterrolebinding ntnx-calm-admin --clusterrole cluster-admin --serviceaccount default:ntnx-calm
Get the service account secret name using the following command:
SECRET_NAME=$(kubectl get serviceaccount ntnx-calm -o jsonpath='{$.secrets[0].name}')

Secrets are objects that contain sensitive data such as a key, token, or password. Placing such information in a Secret allows better control and reduces the risk of exposure.
Get the service account token using the following command:
kubectl get secret ${SECRET_NAME} -o jsonpath='{$.data.token}' | base64 –decode
Get the CA certificate using the following command:
kubectl config view --minify --raw -o jsonpath='{.clusters[*].cluster.certificate-authority-data}' | base64 –decode

What to do next

After receiving the service token, you can add the account in Calm and use the token to communicate with the cluster. For more information on adding the account, see Configuring a Kubernetes Account.

Configuring a Xi Cloud Account

To manage workloads on Nutanix Xi Cloud, add your Xi Cloud as an account in Calm if your Prism Central is paired with a Xi cloud. Calm automatically discovers the availability zones of the Xi Cloud and allows you to add the Xi Cloud account as a provider account.

Before you begin

Ensure that you meet the following conditions.

You enabled Xi leap in Prism Central.
Your Prism Central is paired with Xi Cloud.
Your Prism Central and Xi Cloud are connected to a VPN.
You added the routes to Xi gateway in Prism Central.

Procedure

Click the Settings icon in the left pane.
Click the Accounts tab.
The account inspector panel appears.
Click +Add Account .
The Account Settings page appears.
In the Name field, type a name for the Xi cloud.
From the Provider list, select Xi .
Calm automatically add the paired availability zones in the Availability Zones field.
Click Save .
To verify the credentials of the account, click Verify .
Calm lists the account as an active account after successful credential authentication and account verification.

What to do next

You can use the configured Xi cloud to host blueprints and application by using Calm. For more information, see Calm Blueprints Overview.

Platform Sync for Provider Accounts

Calm automates the provisioning and management of infrastructure resources for both private and public clouds. When any configuration changes are made directly to the Calm-managed resources, Calm needs to sync up the changes to accurately calculate and display quotas and Showback information.

Platform sync enables Calm to synchronize any changes in the clusters that are managed by Calm on connected providers. These changes can be any IP Address changes, disk resizing, unavailability of VMs, and so on.

For example, when a VM is powered off externally or deleted, platform sync updates the VM status in Calm. Calm then adds the infrastructure resources consumed by the VM (memory and vCPU) to the total available quota.

You can specify an interval after which the platform sync must run for a cluster. For more information, see Configuring a Remote Prism Central Account and Configuring a VMware Account.

Note: Platform sync is supported for Nutanix, VMware, and AWS. Calm provides automatic platform sync for AWS with a predefined sync interval of 20 minutes. You can, however, sync up the configuration changes instantly for your Nutanix or VMware account. For more information, see Synchronizing Platform Configuration Changes.

Synchronizing Platform Configuration Changes

About this task

Note: Platform sync is supported for Nutanix, VMware, and AWS. Calm provides automatic platform sync for AWS with a predefined sync interval of 20 minutes. The following steps are applicable only to the Nutanix and VMware accounts.

Procedure

Click the Settings icon in the left pane.
The Settings page appears.
Click the Accounts tab.
Select the Nutanix or VMware account for which you want to sync up configuration changes in the left pane.
On the Account Settings page, click the Sync Now button.

Figure. Sync Now Click to enlarge

Allocating Resource Quota to an Account

Allocate resource quotas to your accounts to have a better control over the infrastructure resources (computer, memory, and storage) that are provisioned through Calm. Based on the resource quota you allocate, the policy engine enforces quota checks when applications are launched, scaled-out, or updated.

About this task

Note: You can allocate resource quotas to Nutanix and VMware accounts only.

Before you begin

Ensure that you configured your Nutanix or VMware account. For more details about configuring an account, see Provider Account Settings in Calm.
Ensure that you enabled the policy engine on the Settings page. For more details about enabling the policy engine, see Enabling policy Engine.

Procedure

Click the Settings icon in the left pane.
The Settings page appears.
Click the Accounts tab.
Select the Nutanix or VMware account in the left pane.
On the Account Settings page, select the Quotas check box.
If you have set up the quota defaults on the General tab of the Settings page, the default values populate automatically in the vCPU , Memory , and Disk fields of the discovered clusters.
Figure. Quota Definition Click to enlarge
Allocate required quota values to the discovered clusters.
The Physical Resources row below the quota fields shows the physical resource already used and the total physical resource of the cluster. You can use this information when you allocate resource quotas to the account.
Click Save .

Viewing Quota Utilization Report

Use the utilization report to analyze how the projects to which the cluster is assigned consumed the allocated resources of the cluster. For example, if a Nutanix cluster is assigned to three different projects, you can analyze how the assigned projects consumed the allocated resources of that cluster.

Before you begin

Ensure that you have enabled the policy engine on the Settings tab. For more details about enabling the policy engine, see Enabling policy Engine.
Ensure that you have allocated resource quotas to the provider. For more details, see Allocating Resource Quota to an Account.
Ensure that you have allocated resource quotas to projects. For more details, see Adding Accounts to a Project.

Procedure

Click the Settings icon in the left pane.
Click the Accounts tab.
Select the Nutanix or VMware account in the left pane.
The Account Settings page appears.
In the Quotas section, do the following to view the resources consumed for each cluster:
1. In the Quota Utilization | View Report row, hover your mouse over the status bar of a resource.
  The ToolTip displays the resources consumed and the resources allocated to the cluster.
  Figure. Quota Utilization Status Bar Click to enlarge
  
  Note: You can also use the status bar to view the overall status and percentage of resources consumed.
2. Click View Report .
  The Utilization Report window appears.
  Figure. Utilization Report Click to enlarge
3. View project-wise consumption of resources along with the amount of compute, memory, and storage that the projects used.

Credentials in Calm

Credentials help in abstracting identity settings while connecting to an external system. Credentials are used to authenticate a user to access various services in Calm. Calm supports key-based and password-based authentication method.

Credentials Overview

Credentials are used in multiple Calm entities and workflows.

Environment
Environment allows a Project Admin to add multiple credentials and configure VM default specifications for each of the selected providers as a part of project and environment configurations.

Project admins must configure an environment before launching an application from the marketplace. The recommendation is to have at least one credential of each secret type (SSH or password) to be defined under each environment in the project. These values get patched wherever the credential values are empty when you launch your marketplace items.
Blueprints and runbooks
Developers can add credentials to a blueprint. These credentials are referenced after the VM is provisioned. Credentials defined within an environment of a project have no significance or impact on the credentials you define within the blueprint.

Calm supports export and import of blueprints across different Prism Central or Calm instances along with the secrets. The developer uses a passphrase to encrypt credentials and then decrypts credentials in a different instance using the same passphrase to create a blueprint copy.
Marketplace
All global marketplace items have empty credentials values. However, locally published blueprints can have the credential values if the developer published the blueprint with the Publish with Secret s option enabled.

When you launch a marketplace item, credentials are patched wherever the value is empty. In case there are multiple credentials of a particular type configured within the environment of a project, you get the option to select a credential for the launch.
Applications
Owners can change the credential value of an application multiple times until the application is deleted. The latest value of a credential that is available at that point in the application instance is used when an action is triggered.

Any change in the credential value at the application level does not impact the credential value at the corresponding blueprint level.

Calm allows managing the following types of credentials:

Static Credentials
Static credentials in Calm are modelled to store secrets (password or SSH private key) in the credential objects that are contained in the blueprints that the applications copy.
Dynamic Credentials
Calm supports external credential store integration for dynamic credentials. A credential store holds username and password or key certificate combinations and enables applications to retrieve and use credentials for authentication to external services whenever required. As a developer, you can:
- Define credential attributes that you want to pass on to the credential provider from the blueprint during execution.
- Define variables that the credential provider must use. By default, Calm defines the secret variable when you configure your credential provider.
  Note: To use the credential in the blueprint, the variables in the credential and the blueprint must match.
- Define a runbook with eScript tasks in the dynamic credential provider definition. The tasks you define in the runbook can set the username, password, private key, or passphrase values for the credential.
For more information about configuring a credential provider, see Configuring a Credential Provider.

When a blueprint uses a dynamic credential, the secret (password or SSH private key) is not stored in the credential objects within the blueprint. The secret values are fetched on demand by executing the runbook within the credential provider that you configure in Calm and associate with the blueprint.
Note:
- You cannot add a dynamic credential when you configure an environment in our project. You can, however, allow the credential provider in the environment.
- You cannot use dynamic credentials for HTTP variables, such as profile variables, service variables, runbooks, and so on.
- You cannot use dynamic credentials for HTTP endpoints and Open Terminal in applications.
- For ready-to-use blueprints or blueprints that are published without secrets, the empty credential values are patched with the credential along with its associated runbook and variable values.

Configuring a Credential Provider

Calm supports external credential store integration for dynamic credentials.

About this task

As a developer, you can define variable, runbook, and attributes in a dynamic credential provider definition.

Procedure

Click the Settings icon in the left pane.
On the Credential Providers tab, click Add Credential Provider .

Figure. Add Credential Provider Click to enlarge
On the Credentials Provider Account Settings page, enter a name for the credential provider in the Name field.

Figure. Credential Provider Click to enlarge
Enter the server address of the credential provider in the Provider Server Address field.
Enter the secret for the account in the Provider Secret field. The secret for the provider can be a key, token, or password.
To add the credential attributes, click the + icon next to Credential Attributes and do the following:
1. Enter a name for the credential attribute in the Name field.
2. Select a data type for the credential attribute in the Data Type field.
3. Provide a value for the data type you selected in the Value field. You can select the Secret check box to hide the value of the credential attribute.
  Credential attributes are the variables that you pass on to the credential provider from the blueprint during execution. Developers require these attributes in blueprints and runbooks to use the credential provider.
To add variables, click the + icon in the Variables section and do the following:
1. Enter a name for the variable in the Name field.
2. Select a data type for the variable in the Data Type field.
3. Provide a value for the data type you selected in the Value field. You can select the Secret check box to hide the value of the variable.
  The variables that you add during the credential provider configuration are only used in the runbooks that you define for the credential provider.
  
  To use the credential in the blueprint, the variables in the credential and the blueprint must match.
Configure a runbook for the credential provider. For information on runbook configuration, see Runbooks Overview.
You can define a runbook with an eScript task. The tasks are used to set the username, password, private key, or passphrase values for the credential.
Note: When the runbook uses the eScript task, then do the following in the Set Variable eScript task to fetch SSH keys or multi-line secrets from the credential provider.
- Encode the secrets.
- Set the is_secret_encoded variable to True.
The runbook uses the variables you defined during the credential provider configuration. You can click Variable/Attributes button within the runbook to view, edit, or add variables. After your runbook is defined, you can click Test to test the runbook.
Click Save .

What to do next

You can add the credential provider to a project. For more information, see Adding Accounts to a Project.

Projects Overview

A project defines Active Directory users or groups to manage common set of requirements or functions. For example, a project can define a team collaborating on an engineering project. A project specifies roles to associate its members, select existing networks that the deployed VMs can use, and (optionally) set usage limits on infrastructure resources.

The refactored project provides a consistent experience when you access it from Prism Central or from Calm. However when Calm is enabled, you can also configure application management specific features in your projects.

For more information on the Project Summary view and Project Details view, see Project Summary View and Project Details View.

For more information on how to create a project, add users, add infrastructure, configure environments, and managing quota and snapshot policies, see Projects Overview in the Prism Central Guide.

Calm Blueprints Overview

A blueprint is the framework for every application that you model by using Calm. Blueprints are templates that describe all the steps that are required to provision, configure, and execute tasks on the services and applications that you create.

You create a blueprint to represent the architecture of your application and then run the blueprint repeatedly to create an instance, provision, and launch applications.

A blueprint also defines the lifecycle of an application and its underlying infrastructure; starting from the creation of the application to the actions that are carried out on a blueprint until the termination of the application.

You can use blueprints to model the applications of various complexities; from simply provisioning a single virtual machine to provisioning and managing a multi-node, multi-tier application.

Building Blocks of a Blueprint

Calm uses services, application profiles, packages, substrates, and actions as building blocks for a blueprint to define applications.

Services
An application is made up of multiple components (or services) working together. The architecture of an application is composed of compute, storage, network, and their connections and dependencies. Services are logical entities that are exposed by an IP address. End users and services communicate with each other over a network through their exposed IP addresses and ports. For more information, see Services Overview.
Application Profiles
Any useful blueprint requires infrastructure for instantiation. A blueprint can specify the exact infrastructure or can be completely left to the blueprint user to specify at the time of instantiation.

An application profile provides different combinations of the service, package, and VM (infrastructure choices) while configuring a blueprint. The application profile allows you to use the same set of services and packages on the different platforms. You select an application profile while launching your blueprint.

Application profiles determine where an application should run, for example, on a Nutanix provider account or on an Azure account. Application profiles also control the T-shirt sizing of an application. T-shirt sizing means that the value of a variable might change based on the selection of a small or a large instance of an application.

If Showback feature is enabled, the application profile also displays service cost of the resources used for an application.

Figure. Application Profile Click to enlarge
Package (Install and Uninstall)
Package Install and Uninstall are operations that are run when you first launch a blueprint or when you finally delete the entire application. In other words, these operations are run during the Create or Delete profile actions. Package Install and Uninstall are unique to each application profile, which means that the tasks or the task contents can vary depending upon the underlying cloud or the size.

Package install is commonly used for installing software packages. For example, installing PostgreSQL with sudo yum -y install postgresql-server postgresql-contrib .
Substrates
Substrates are a combination of the underlying cloud and the virtual machine instance. When you select the desired cloud, Calm displays all of the fields required for creating a virtual machine instance on that particular cloud. The combination of all these fields constitutes a substrate. Substrates are the infrastructure abstraction layer for Calm. Calm can quickly change where or how applications are deployed by simply changing the substrate.
Actions
Actions are runbooks to accomplish a particular task on your application. You can use actions to automate any process such as backup, upgrade, new user creation, or clean-up, and enforce an order of operations across services. For more information, see Actions Overview.

Other Configurational Components

Calm also has a few other components that you can use while configuring your blueprints.

Macros
Calm macros are part of a templating language for Calm scripts. These are evaluated by Calm's execution engine before the script is run. Macros help in making scripts generic and creating reusable workflows. For more information, see Macros Overview.
Variables
Variables are either user defined or added to the entities by Calm. Variables are always present within the context of a Calm entity and are accessible directly in scripts running on that entity or any of its child entities. For more information, see Variables Overview.
Categories
Categories (or tags) are metadata labels that you assign to your cloud resources to categorize them for cost allocation, reporting, compliance, security, and so on. Each category is a combination of key and values. For more information, see Categories Overview.
Dependencies
Dependencies are used to define the dependence of one service in your application on another service or multiple other services for properties such as IP addresses and DNS names. For example, if service 2 is dependent on service 1, then service 1 starts first and stops after service 2.

For information about how to define dependencies between services, see Setting up the Service Dependencies.

Figure. Dependencies Click to enlarge

Note: If there are no dependencies between tasks in a service, Calm runs the tasks in any order or even in parallel.

Blueprint Types

You can configure the following blueprint types in Calm.

Single-VM Blueprint
A single-VM blueprint is a framework that you can use to create and provision an instance and launch applications that require only one virtual machine. Single-VM blueprints enable you to quickly provide Infrastructure-as-a-Service (IaaS) to your end users. For more information, see Creating a Single-VM Blueprint.
Multi-VM Blueprint
A multi-VM blueprint is a framework that you can use to create an instance, provision, and launch applications requiring multiple VMs. You can define the underlying infrastructure of the VMs, application details, and actions that are carried out on a blueprint until the termination of the application. For more information, see Creating a Multi-VM Blueprint.

Blueprint Editor

The blueprint editor provides a graphical representation of various components that allow you to visualize and configure the components and their dependencies in your environment.

Use the Blueprints tab to perform actions, such as:

Create application blueprints for single-VM or multiple-VM architectures. For more information, see Creating a Single-VM Blueprint and Creating a Multi-VM Blueprint.
Add update configuration. For more information, see Update Configuration for VM.
Add configuration for snapshots and restore. For more information, see Blueprint Configuration for Snapshots and Restore.
Publish blueprints. For more information, see Submitting a Blueprint for Approval.
Launch blueprints. For more information, see Launching a Blueprint.
Upload existing blueprints from your local machine. For more information, see Uploading a Blueprint.
View details of your blueprints. For more information, see Viewing a Blueprint.
Edit details of an existing blueprint. For more information, see Editing a Blueprint.

Services Overview

Services are the virtual machine instances, existing machines or bare-metal machines, that you can provision and configure by using Calm. You can either provision a single service instance or multiple services based on the topology of your application. A service can only expose an IP address and ports on which the request is received. After a service is configured, you can clone or edit the service as required.

A service includes the following entities:

VM

A VM defines the configuration of the virtual machine instance, the platform on which the VM will be installed, and the connection information of the machine. For example, as shown in the following figure, you need to define the name, cloud, operating system, IP address, and the connection information for an existing machine.

Package

A package enables you to install and uninstall software on an existing machine or bare metal machine by using a script. You need to provide the credentials of the VM on which you need to run the script. A sample script is shown in the following figure. Package also defines the port number and the protocol that is used to access the service.

Service

A service enables you to create the variables that are used to define the service-level tasks and service-level actions. As part of the service, you can also define the number of replicas that you want to create of a service. The maximum number of replicas allowed is 300.

For information about how to configure a service, see Configuring Nutanix and Existing Machine VM, Package, and Service.

Macros Overview

Calm macros are part of a templating language for Calm scripts. These are evaluated by Calm's execution engine before the script is run.

Macros enable you to access the value of variables and properties that are set on entities. The variables can be user defined or system generated. For more information, see Variables Overview.

Macro Usage

Macros help in making scripts generic and creating reusable workflows. You can use macros in tasks within the blueprints or in the configuration of Calm entities, such as the VM name.

Macro Syntax

Macros require a set of delimiters for evaluation. These are @@{ and }@@ . Everything within these delimiters is parsed and evaluated. For example,

To concatenate the value of a path and a string variable, you can use cd "@@{path + '/data'}@@" in your script.
To access credentials, you can use the @@{cred_name.username}@@ and @@{cred_name.secret}@@ formats, where cred_name is the name of the credential with which the credential is created.

Supported Entities

Macros support the following entities.

Application
Deployment
Service
Package
Virtual machine
Runbooks

Supported Data Types

Macros support the following data types.

Table 1. Supported Data Types
Data Type	Usage
String	@@{"some string"}@@ or @@{'some string'}@@ Note: Newline or other such special characters are not supported. You can use \ to escape quotes.
Numbers	Supports integer and float. For example, @@{ 10 + 20.63 }@@ Note: All variables are treated as strings.

Supported Operations

Macros support the following operations.

Supports basic binary operations or numbers. For example, @@{(2 * calm_int(variable1) + 10 ) / 32 }@@.
Supports string concatenation. For example, @@{ foo + bar }@@.
Supports slicing for strings. For example, @@{foo[3:6]}@@.
Note: For a comma separated value, slicing splits the string on comma (,). For example, @@{"x,y,z"[1]}@@ results in y.

Macros of an Array Service

Calm allows you to access macros of an array service using a special macro which starts with calm_array . You can configure a VM with replicas and access the common macros of all the replicas. For example, you can:

Use the following syntax to retrieve the name of all the instances of VM separated by commas.
@@{calm_array_name}@@
Use the following syntax to retrieve the IP address of all the instances of VM separated by commas.
@@{calm_array_address}@@
Use the following syntax to retrieve the ID of all the instances of VM separated by commas.
@@{calm_array_id}@@

Built-in Macros

The following table lists the built-in macros that you can use to retrieve and display the entities.

Table 1. Built-in Macros
Macro	Usage
@@{calm_array_index}@@	Index of the entity within an array
@@{calm_blueprint_name}@@	Name of the blueprint from which the application was created
@@{calm_blueprint_uuid}@@	Universally unique identifier (UUID) of the blueprint from which the application was created
@@{calm_application_name}@@	Name of the application
@@{calm_application_uuid}@@	UUID of the application
@@{calm_uuid}@@	UUID of the entity within the application on which the current task is running
@@{calm_random}@@	A random number is generated each time this is used. This will be evaluated each time and should not be used in fields such as VM name.
@@{calm_unique}@@	A random number that is unique to this replica. This will be evaluated to the same value across runs.
@@{calm_jwt}@@	JWT for the currently logged in user for API authentication.
@@{calm_now}@@ @@{calm_today}@@	The current time stamp
@@{calm_time(“<format>”)}@@	The current time in the specified format
@@{calm_year(“YYYY”)}@@ @@{calm_year(“YY”)}@@	The current year in YYYY or YY format
@@{calm_month(“short”)}@@ @@{calm_month(“long”)}@@	Name of the current month in long or short format
@@{calm_day(“month”)}@@ @@{calm_day(“year”)}@@	Numeric day of the month or year
@@{calm_weeknumber}@@ @@{calm_weeknumber(“iso”)}@@	ISO Numeric week of the year
@@{calm_weekday(“number”)}@@ @@{calm_weekday(“name_short”)}@@ @@{calm_weekday(“name_long”)}@@	Day of the week in numeric or short name or long name
@@{calm_hour(“12”)}@@ @@{calm_hour(“24”)}@@ @@{calm_hour(“am_pm”)}@@	Numeric hour of the day in 12:00-hour or 24:00-hour format along with AM or PM
@@{calm_minute}@@	Numeric minute
@@{calm_second}@@	Numeric second
@@{calm_is_weekday}@@	Displays 1 if the current day is a weekday
@@{calm_is_long_weekday}@@	Displays 1 if the current day is a weekday from Monday to Saturday
@@{calm_is_within("time1", "time2")}@@	Displays 1 if the current time is within the time1 and time2 range
@@{calm_project_name}@@	Displays the project name
@@{calm_username + @nutanix.com}@@	Displays the username
@@{calm_float("32.65") * 2}@@ @@{calm_int(calm_array_index) + 1}@@	Typecast to integer. This is useful for binary operations.
@@{calm_string(256) + "-bit"}@@ @@{"xyz" + calm_string(42)}@@	Typecast to string. This is useful for string concatenation.
@@{calm_b64encode(api_response)}@@ @@{calm_b64encode("a,b,c")}@@	Base64 encode the data passed to this macro.
@@{calm_b64encode(b64_encoded_data)}@@ @@{calm_b64encode("YSxiLGM=")}@@	Base64 decode the data passed to this macro.

Platform Macros

You can access the properties of a VM by using the platform macros. The following section describes the macros to access the VM properties for different providers.

Table 1. AHV platform Macros
Macro	Usage
@@{platform}@@	To access all the properties of a VM.
@@{platform.status.cluster_reference.uuid}@@	To access the uuid of the cluster or the Prism element.
@@{platform.status.resources.nic_list[0].mac_address}@@	To access mac the address. Note: Use the nic_list index to access the mac address of a specific nic.
@@{platform.status.resources.nic_list[0].subnet_reference.name}@@	To access the NIC name.
@@{platform.status.resources.power_state}@@	To get the state of the VM.
@@{platform.status.num_sockets}@@	To access number of sockets of the VM.

Note: The @@{platform}@@ macro stores the GET response of the VM. You can access any VM information that is available through the GET API response.

Table 2. VMware platform Macros
Macro	Usage
@@{platform}@@	To access all the properties of a VM.
@@{platform.datastore[0].Name}@@	To access the datastore name.
@@{platform.num_sockets}@@	To access number of sockets of the VM.

Note: The @@{platform}@@ macro stores the GET response of the VM. You can access any VM information that is available through the GET API response.

Table 3. GCP platform Macros
Macro	Usage
@@{platform}@@	To access all the properties of a VM.
@@{platform.creationTimestamp}@@	To get the VM creation time stamp.
@@{platform.selfLink}@@	To access the self link of the VM.
@@{platform.networkInterfaces[0].subnetwork}@@	To access the network details of the VM.

Note: The @@{platform}@@ macro stores the GET response of the VM. You can access any VM information that is available through the GET API response.

Endpoint Macros

The following table lists the endpoint macros for HTTP, Linux, and Windows endpoint types.

Table 1. HTTP
Macro	Usage
@@{endpoint.name}@@	Name of the endpoint
@@{endpoint.type}@@	Type of the endpoint
@@{endpoint.length}@@	Number of IP Addresses in the endpoint
@@{endpoint.index}@@	Index of the IP address or VM in a given endpoint
@@{endpoint.base_url}@@	Base URL of the HTTP endpoint
@@{endpoint.connection_timeout}@@	Time interval in seconds after which the connection attempt to the endpoint stops
@@{endpoint.retry_count}@@	Number of attempts the system performs to create a task after each failure
@@{endpoint.retry_interval}@@	Time interval in seconds for each retry if the task fails
@@{endpoint.tls_verify}@@	Verification for the URL of the HTTP endpoint with a TLS certificate
@@{endpoint.proxy_type}@@	HTTP(s) proxy/SOCKS5 proxy to use
@@{endpoint.base_urls}@@	Base URLs of HTTP endpoints
@@{endpoint.authentication_type}@@	Authentication method to connect to an HTTP endpoint: Basic or None
@@{endpoint.credential.username}@@	User name in the credential to access the endpoint
@@{endpoint.credential.secret}@@	Credential secret type to access the endpoint: Passphrase or SSH Private Key

Table 2. Linux
Macro	Usage
@@{endpoint.name}@@	Name of the endpoint
@@{endpoint.type}@@	Type of the endpoint
@@{endpoint.length}@@	Number of IP Addresses in the endpoint
@@{endpoint.index}@@	Index of the IP address or VM in a given endpoint
@@{endpoint.address}@@	IP address to access the endpoint device
@@{endpoint.port}@@	Port number to access the endpoint
@@{endpoint.value_type}@@	Target type of the endpoint: IP address or VM
@@{endpoint.addresses}@@	IP addresses to access endpoint devices
@@{endpoint.credential.secret}@@	Credential secret type to access the endpoint: Passphrase or SSH Private Key
@@{endpoint.credential.username}@@	User name in the credential to access the endpoint

Table 3. Windows
Macro	Usage
@@{endpoint.name}@@	Name of the endpoint
@@{endpoint.type}@@	Type of the endpoint
@@{endpoint.length}@@	Number of IP Addresses in the endpoint
@@{endpoint.index}@@	Index of the IP address or VM in a given endpoint
@@{endpoint.address}@@	IP address to access the endpoint device
@@{endpoint.port}@@	Port number to access the endpoint
@@{endpoint.value_type}@@	Target type of the endpoint: IP address or VM
@@{endpoint.connection_protocol}@@	Connection protocol to access the endpoint: HTTP or HTTPS
@@{endpoint.addresses}@@	IP addresses to access endpoint devices
@@{endpoint.credential.secret}@@	Credential secret type to access the endpoint: Passphrase or SSH Private Key
@@{endpoint.credential.username}@@	User name in the credential to access the endpoint

Note: To call an endpoint variable from another object, replace endpoint with the other endpoint name.

Runbook Macros

The following table lists the runbook macros.

Table 1. Runbook Macros
Macro	Usage
@@{calm_runbook_name}@@	Name of the runbook
@@{calm_runbook_uuid}@@	Universally unique identifier (UUID) of the runbook

Virtual Machine Common Properties

The following table lists the common properties of the virtual machine that are available for usage.

Table 1. Virtual Machine Common Properties
Properties	Usage
@@{address}@@	IP address of the instance that is used by Calm to access the VM
@@{id}@@	ID of the platform identifier
@@{name}@@	Name of the VM or container
@@{mac_address}@@	Mac address of the VM
@@{platform}@@	Platform response for a GET query. This is the response in JSON format from provider.

Note: For an existing machine, only the address property is applicable.

Variables Overview

Macros provide a way to access the values of variables that you set on entities. Variables are either user defined or added to the entities by Calm. Variables are always present within the context of a Calm entity and are accessible directly in scripts running on that entity or any of its child entities.

Note: User defined variables in Calm cannot have macros in their values.

Variable Value Inheritance

The variable value of a parent entity can be accessed by the child entity unless the properties or the variables are overridden by another entity.

For example, if Variable1 is a variable that you defined on the application profile, then all child entity of the application profile can directly access the value of Variable1 in any task or script running on it as @@{variable1}@@ unless overridden by another entity.

Variable Access

Variables are directly accessed as @@{variable_name}@@ within any task on an entity where the variable is defined and all child entity that inherit this variable. This syntax only delivers the value for the corresponding replica in which the task is running. To get comma-separated values across replicas, you can use @@{calm_array_variable_name}@@ .

For example, on a service with 2 replicas, if you set a backup_dir variable through a set variable Escript task such as:

print "backup_dir=/tmp/backup_@@{calm_array_index}@@"

You get /tmp/backup_0 and /tmp/backup_1 values for replica 0 and 1 respectively.

When a task runs on this service with the echo "@@{backup_dir}@@" script, the script evaluates the following values in each replica of the service:

Replica 0
/tmp/backup_0
Replica 1
/tmp/backup_1

When you change the script to echo "@@{calm_array_backup_dir}@@" , the script evaluates to the following values in each replica of the service:

Replica 0
/tmp/backup_0,/tmp/backup_1
Replica 0
/tmp/backup_0,/tmp/backup_1

The syntax to access the value of variables or properties of other entities or dependencies is @@{<entity name>.<variable/attribute name>}@@ where entity name , is the name of the other entity or dependency and variable/attribute name is the name of the variable or attribute. For example:

Example 1: If a blueprint contains a service by the name of app_container , you can access the IP address of the app_container service in any other service using @@{app_container.address}@@ syntax.
Example 2: If you need addresses of a service (S1) in a task on another service (S2), you can use @@{S1.address}@@ in the script for the task running on S2. The script will evaluate to the value, such as 10.0.0.3,10.0.0.4,10.0.0.5 in case S1 has 3 replicas.

Action-Level Variables

Action-level variables are variables that are associated to an action and passed as an argument to the runlog when you run the action. Service action variables are unique for each service while the profile action variables are unique for each profile across all services and replicas. If you deploy five replicas, the service action variables will be the same across all replicas.

Action variables are used in the context of running an action and are defined at the action level. For example, if you have an action to install or uninstall a package on a particular VM, you can have the following action variables.

Type of action (in this case install or uninstall)
Name of the package

With multiple runs of this action, you can then install or uninstall multiple packages on the VM.

Nutanix Variables

The following table lists the Nutanix variables that are available for usage.

Table 1. Nutanix Variables
Variables	Usage
@@{address}@@	IP address of the instance that is used by Calm to access the VM
@@{id}@@	ID of the platform identifier
@@{name}@@	Name of the VM or container
@@{mac_address}@@	Mac address of the VM
@@{platform}@@	Platform response for a GET query. This is the response in JSON format from provider.

Note: For an existing machine, only the address property is applicable.

VMware Variables

The following table lists the built-in VMware macros that you can use to retrieve and display the entities.

Table 1. VMware Macros
Properties	Usage
@@{address}@@	IP address of the instance that is used by Calm to access the VM
@@{id}@@	ID of the platform identifier
@@{name}@@	Name of the VM or container
@@{mac_address}@@	Mac address of the VM
@@{platform}@@	Platform response for a GET query. This is the response in JSON format from provider.

Note: For an existing machine, only the address property is applicable.

AWS Variables

The following table lists the built-in AWS macros that you can use to retrieve and display the entities.

Table 1. AWS Macros
Macros	Usage
@@{address}@@	IP address of the instance that is used by Calm to access the VM. Note: The VM Name field does not support this macro.
@@{id}@@	Internal ID of the instance that is used within the Prism. Note: The VM Name field does not support this macro.
@@{name}@@	Name of the VM. Note: The VM Name field does not support this macro.
@@{aws_instance_id}@@	Instance ID of AWS
@@{private_ip_address}@@	Private IP address
@@{private_dns_name}@@	Private DNS name
@@{public_ip_address}@@	Public IP address
@@{public_dns_name}@@	Public DNS name
@@{vm_zone}@@	AWS zone of instance
@@{platform}@@	Platform response for a GET query. This is the response in JSON format from provider.

GCP Variables

The following table lists the built-in GCP macros that you can use to retrieve and display the entities.

Table 1. GCP Macros
Macros	Usage
@@{address}@@ @@{ip_address}@@ @@{public_ip_address}@@	IP address of the instance that is used by Calm to access the VM. Note: The VM Name field does not support this macro.
@@{id}@@	Internal ID of the instance that is used within the Prism. Note: The VM Name field does not support this macro.
@@{name}@@	Name of the VM. Note: The VM Name field does not support this macro.
@@{zone}@@	Zone in which the VM instance is created.
@@{platform_data}@@	Platform response for a GET query. This is the response in JSON format from provider.
@@{internal_ips}@@	List of all the private IP addresses.
@@{external_ips}@@	List of all the public IP addresses.

Azure Variables

The following table lists the built-in Azure macros that you can use to retrieve and display the entities.

Table 1. Azure Macros
Macros	Usage
@@{address}@@	IP address of the instance that is used by Calm to access the VM. Note: The VM Name field does not support this macro.
@@{id}@@	Internal ID of the instance that is used within the Prism. Note: The VM Name field does not support this macro.
@@{name}@@	Name of the VM. Note: The VM Name field does not support this macro.
@@{private_ip_address}@@	Private IP address
@@{public_ip_address}@@	Public IP address
@@{resource_group}@@	Resource group name in which the VM instance is created.
@@{platform_data}@@	Platform response for a GET query. This is the response in JSON format from provider.

Kubernetes Variables

The following table lists the Kubernetes variables that are available for usage.

Table 1. Kubernetes Variables
Properties	Usage
@@{K8sPublishedService.address}@@	IP address of the service.
@@{K8sPublishedService.name}@@	Name of the service.
@@{K8sPublishedService.ingress}@@	Load balancer IP for public service.
@@{K8sPublishedService.platform}@@	Platform data for the service.
@@{K8sDeployement.name}@@	Name of the deployment.
@@{K8sDeployement.platform}@@	Platform data for the deployment.

Note: Do not use deployment macros in publish service specs or publish macros in deployment service specs in the same calm deployment.

Runtime Variables Overview

Runtime variables are used to mark the attributes while creating the blueprint so that those attributes can be modified at the time of launching the application blueprint. This is useful for the users who cannot edit or create a blueprint such as consumers. For example, while creating a blueprint, if memory attribute is marked as a runtime variable then you can change its value before launching the application blueprint.

Note: Ensure that the attributes marked as runtime variable are not null or empty and an initial value is configured.

Categories Overview

Categories (or tags) are metadata labels that you assign to your cloud resources to categorize them for cost allocation, reporting, compliance, security, and so on. Each category is a combination of key and values.

Your providers impose a limit to the number of tags that you can use for cloud governance. The following table lists the category or tag limit imposed by each provider:

Table 1. Tag or Category Limit
Providers	Category or Tag Limit
Nutanix	30
AWS	50
VMware	No limit
GCP	15
Azure	15

Calm reserves 6 tags out of the total tags allowed by your provider and populates them automatically when you provision your VMs using Calm. For example, AWS allows a limit of 50 tags. When you provision your VM on AWS using Calm, 6 out of 50 tags are automatically populated with keys and values specific to Calm VM provisioning. You can use the remaining 46 tags to define other key-value pairs.

The following table lists the Calm-specific categories or tags and their availability for different providers:

Table 2. Calm-Specific Categories or Tags
Categories or Tags	Nutanix	AWS	VMware	GCP	Azure
account_uuid		X	X	X	X
CalmApplication	X	X	X	X	X
CalmService	X	X	X	X	X
CalmUsername	X	X	X	X	X
Calm Project		X	X	X	X
OSType	X	X	X	X	X

Single-VM Blueprints in Calm

A single-VM blueprint is a framework that you can use to create and provision an instance and launch applications that require only one virtual machine.

Creating a Single-VM Blueprint

Single-VM blueprints enable you to quickly provide Infrastructure-as-a-Service (IaaS) to your end users.

About this task

You can create single-VM blueprints with your Nutanix, VMware, AWS, GCP, or Azure accounts. Use these steps to create a single-VM blueprint with any of your provider accounts.

Before you begin

Ensure that the Prism web console (also known as Prism Element) is registered with your Prism Central.

Procedure

Set up your single-VM blueprint. In this step, you provide the name and description for the blueprint and select the project and environment for the blueprint. This step is common for all provider accounts. For more information, see Setting up a Single-VM Blueprint.
Add VM details to your blueprint. In this step, you provide a VM name and associate a provider account and an operating system to the blueprint. This step is also common for all provider accounts. For more information, see Adding VM Details to a Blueprint.
Configure the VM of your blueprint. This options available for VM configuration are derived from either the project or the environment that you selected while setting up the blueprint. For more information, see VM Configuration.
Configure advanced options. In this optional step, you add credentials, configure options to check the logon status of the VM after blueprint provisioning, add pre-create and post-delete tasks, or add packages. For more information, see Configuring Advanced Options for a Blueprint.

Setting up a Single-VM Blueprint

Perform the following steps to do the preliminary setup of your single-VM blueprint.

Before you begin

Ensure that you created a project and configured an environment for the provider account that you want to associate to your blueprint. For more information, see Creating a Project and Configuring Environments in a Project .

Procedure

Click the Blueprint icon in the left pane.
Click + Create Blueprint > Single VM Blueprint .
On the Blueprint Settings tab, enter a name and a description for your blueprint.
From the Project list, select a project.
From the Environment list, select an environment to configure your blueprint.
To save your blueprint setup, click Save .

What to do next

Click VM Details to provide a VM name and associate a provider account and an operating system to the blueprint. For more information, see Adding VM Details to a Blueprint.

Adding VM Details to a Blueprint

Perform the following steps to add VM details to your blueprint.

Before you begin

Ensure that you set up your single-VM blueprint. For more information, see Setting up a Single-VM Blueprint.

Procedure

On the VM Details tab, enter a name for the VM.
From the Account list, select the provider account that you want to associate to your blueprint.
If your provider account does not appear in the Account list, ensure that you selected the correct project on the Blueprint Settings tab. The project must have the required provider account configured.
From the Operating System list, select either Linux or Windows as the operating system for the VM.
To save the configurations, click Save .

What to do next

Click VM Configuration and configure the VM in your single-VM blueprint. For more information, see VM Configuration.

VM Configuration

Configuring the VM in your blueprint is specific to the provider account and the operating system you select for your blueprint. You can configure the VM in a blueprint with Nutanix, VMware, AWS, GCP, or Azure accounts.

Configuring VM for Nutanix Account

Perform the following steps to configure the VM in a single-VM blueprint for your Nutanix account.

Before you begin

Ensure that you set up your single-VM blueprint. For more information, see Setting up a Single-VM Blueprint.
Ensure that you added the VM details to your blueprint. For more information, see Adding VM Details to a Blueprint.

Procedure

If you have configured an environment during the project creation, then on the VM Configuration tab, click the Clone from environment button to autofill the VM configuration details. This step is optional.
The Clone from environment button appears only when you select a specific environment you configured for the account from the Environment list on the Blueprint Settings tab. The option does not appear if you select All Project Accounts as your environment.

You can also click the View Configuration option to review the configuration details before cloning the environment.
In the Cluster list, select the cluster that you want to associate to the blueprint.
The Cluster list displays the clusters that you allowed in the project.

The VLAN subnets have direct association with the cluster. When you select a VLAN subnet under the Network Adapters (NICs) section, the associated cluster is auto-populated in the Cluster list. However, if you intend to use overlay subnets, you must select the cluster in list.

If you mark the cluster as runtime editable, the selected subnets also become runtime editable.

Figure. General Configuration Click to enlarge
Edit the VM name in the VM Name field.
You can use Calm macros to provide a unique name to the VM. For example, vm-@@{calm_time}@@ . For more information on Calm macros, see Macros Overview.
Configure the processing unit of the VM by entering the number of vCPU, cores of each vCPU, and total memory in GB of the VM in the vCPU , cores per vCPU , and Memory (GiB) fields.
(Optional) If you want to customize the default OS properties of the VM, select the Guest Customization check box.
Guest customization allows you to modify the properties of the VM operating system. You can prevent conflicts that might result due to the deployment of virtual machines with identical settings, such as duplicate VM names or same SID. You can also change the computer name or network settings by using a custom script.
1. Select Cloud-init for Linux or SysPrep for Windows, and enter or upload the script in the Script panel.
  For Sysprep, you must use double back slash for all escape characters . For example, \\v.
2. For Sysprep script, click Join a Domain check box and configure the following fields.
  - Enter the domain name of the Windows server in the Domain Name field.
  - Select a credential for the Windows VM in the Credentials list. You can also add new credentials.
  - Enter the IP address of the DNS server in the DNS IP field.
  - Enter the DNS search path for the domain in the DNS Search Path field.
Under the Disks section, do the following:
1. To add a disk, click the + icon next to Disks .
2. Select the device from the Device Type list.
  You can select CD-ROM or DISK .
3. Select the device bus from the Device Bus list.
  You can select IDE or SATA for CD-ROM and SCSI , IDE , PCI , or SATA for DISK.
4. From the Operation list, select one of the following:
  - To allocate the disk memory from the storage container, select Allocate on Storage Container .
  - To clone an image from the disk, select Clone from Image Service .
5. If you selected Allocate on Storage Container , enter the disk size in GB in the Size (GiB) field.
6. If you selected Clone from Image Service , select the image you want to add to the disk in the Image field.
  All the images that you uploaded to Prism Central are available for selection. For more information about image configuration, see Image Management section in the Prism Central guide.
7. Select the Bootable check box for the image that you want to use to start the VM.
Note: You can add more than one disk and select the disk with which you want to boot up the VM.
Under the Boot Configuration section, select a firmware type to boot the VM.
- To boot the VM with legacy BIOS firmware, select Legacy BIOS .
- To boot the VM with UEFI firmware, select UEFI . UEFI firmware supports larger hard drives, faster boot time, and provides more security features.
- To boot the VM with the Secure Boot feature of UEFI, select Secure Boot . Secure Boot ensures a safe and secure start by preventing unauthorized software such as a malware to take control during the VM bootup.
(For GPU-enabled clusters only) To configure a vGPU, click the + icon under the vGPUs section and do the following:
1. From the Vendor list, select the GPU vendor.
2. From the Device ID list, select the device ID of the GPU.
3. From the Mode list, select the GPU mode.
Under the Categories section, select a category in the Key: Value list.
Use this option to tag your VM to a defined category in Prism Central. The list options are available based on your Prism Central configuration. If you want to protect your application by a protection policy, select the category defined for the policy in your Prism Central.
To add a network adapter, click the + icon next to the Network Adapters (NICS) field.

Figure. Network Adapters Click to enlarge

The NIC list shows all the VLAN and overlay subnets. The VLAN subnets have direct association with the cluster. Therefore, when you select a VLAN subnet, the associated cluster is auto-populated in the Cluster list.

The NICs of a VM can either use VLAN subnets or overlay subnets. For example, if you select an overlay subnet in NIC 1 and then add NIC 2, the NIC 2 list displays only the overlay subnets.

If you select a VLAN subnet in NIC 1, all subsequent VLAN subnets belong to the same cluster. Similarly, if you select an overlay subnet, all subsequent overlay subnets belong to the same VPC.
To add a serial port to the VM, click the + icon next to the Serial Ports field.
You can use serial ports to connect a physical port or a file on the VM.
To save the blueprint, click Save .

What to do next

You can optionally configure the advanced options in the blueprint. For more information, see Configuring Advanced Options for a Blueprint.
You can view the blueprint on the Blueprint tab. You can use the blueprint to model your application. For more information, see Blueprints Management in Calm.

Configuring VM for VMware Account

Perform the following steps to configure the VM in a single-VM blueprint for your VMware account.

Before you begin

Ensure that you set up your single-VM blueprint. For more information, see Setting up a Single-VM Blueprint.
Ensure that you added the VM details to your blueprint. For more information, see Adding VM Details to a Blueprint.

Procedure

(Optional) If you have configured an environment during the project creation, then on the VM Configuration tab, click Clone from environment to autofill the VM configuration details.
The Clone from environment option appears only when you select a specific environment you configured for the account from the Environment list on the Blueprint Settings tab. The option does not appear if you select All Project Accounts as your environment.

You can also click the View Configuration option to review the configuration details before cloning the environment.
Select the Compute DRS Mode check box to enable load sharing and automatic VM placement.
Distributed Resource Scheduler (DRS) is a utility that balances computing workloads with available resources in a virtualized environment. For more information about DRS mode, see the VMware documentation .
- If you selected Compute DRS Mode , then select the cluster where you want to host your VM from the Cluster list.
- If you have not selected Compute DRS Mode , then select the host name of the VM from the Host list.
Do one of the following:
- Select the VM Templates radio button and then select a template from the Template list.
  Templates allow you to create multiple virtual machines with the same characteristics, such as resources allocated to CPU and memory or the type of virtual hardware. Templates save time and avoid errors when configuring settings and other parameters to create VMs. The VM template retrieves the list options from the configured vCenter.
  Note:
  - Install the VMware Tools on the Windows templates. For Linux VMs, install Open-vm-tools or VMware-tools and configure the Vmtoolsd service for automatic start-up.
  - Support for Open-vm-tools is available. When using Open-vm-tools , install Perl for the template.
  - Do not use SysPrepped as the Windows template image.
  - If you select a template that has unsupported version of VMware Tools, then a warning appears stating VMware tool or version is unsupported and could lead to VM issues .
  - You can also edit the NIC type when you use a template.
  For more information, refer to VMware KB articles.
- Select the Content Library radio button, a content library in the Content Library list, and then select an OVF template or VM template from the content library.
  A content library stores and manages content (VMs, vApp templates, and other types of files) in the form of library items. A single library item can consist of one file or multiple files. For more information about the vCenter content library, see the VMware Documentation .
  
  Caution: Content Library support is currently a technical preview feature in Calm. Do not use any technical preview features in a production environment.
If you want to use the storage DRS mode, then select the Storage DRS Mode check box and a datastore cluster from the Datastore Cluster list.
The datastore clusters are referred as storage pod in vCenter. A datastore cluster is a collection of datastores with shared resources and a shared management interface.
If you do not want to use storage DRS mode, then do not select the Storage DRS Mode check box, and select a datastore from the Datastore list.
In the VM Location field, specify the location of the folder in which the VM must be created when you deploy the blueprint. Ensure that you specify a valid folder name already created in your VMware account.
To create a subfolder in the location you specified, select the Create a folder/directory structure here check box and specify a folder name in the Folder/Directory Name field.

Note: Calm gives preference to the VM location specified in the environment you select while launching an application. For example, you specify a subfolder structure as the VM location in the blueprint and the top-level folder in the environment. When you select this environment while launching your application, Calm considers the VM location you specified in the environment and creates the VM at the top-level folder.

Select the Delete empty folder check box to delete the subfolder created within the specified location, in case the folder does not contain any VM resources. This option helps you to keep a clean folder structure.
Enter the instance name of the VM in the Instance Name field.
This field is pre-populated with a macro as suffix to ensure name uniqueness. The service provider uses this name as the VM name.
Under Controllers , click the + icon to add the type of controller.
You can select either SCSI or SATA controller. You can add up to three SCSI and four SATA controllers.
Under the Disks section, click the + icon to add vDisks and do the following:
1. Select the device type from the Device Type list.
  You can either select CD-ROM or DISK .
2. Select the adapter type from the Adapter Type list.
  You can select IDE for CD-ROM.
  
  You can select SCSI , IDE , or SATA for DISK.
3. Enter the size of the disk in GiB.
4. In the Location field, select the disk location.
5. If you want to add a controller to the vDisk, select the type of controller in the Controller list to attach to the disk.
  
  Note: You can add either SCSI or SATA controllers. The available options depend on the adapter type.
6. In the Disk mode list, select the type of the disk mode. Your options are:
  - Dependent : Dependent disk mode is the default disk mode for the vDisk.
  - Independent - Persistent : Disks in persistent mode behave like conventional disks on your physical computer. All data written to a disk in persistent mode are written permanently to the disk.
  - Independent - Nonpersistent : Changes to disks in nonpersistent mode are discarded when you shut down or reset the virtual machine. With nonpersistent mode, you can restart the virtual machine with a virtual disk in the same state every time. Changes to the disk are written to and read from a redo log file that is deleted when you shut down or reset.
You can also mark the vDisks runtime editable so you can add, delete, or edit the vDisks while launching the blueprint. For more information about runtime editable attributes, see Runtime Variables Overview.
Under the Tags section, select tags from the Category: Tag pairs field.
You can assign tags to your VMs so you can view the objects associated with your VMs in your VMware account. For example, you can create a tag for a specific environment and assign the tag to multiple VMs. You can then view all the VMs that are associated with the tag.
(Optional) If you want to customize the default OS properties of the VM, then click the Enable check box under VM Guest Customization and select a customization from the Predefined Guest Customization list.
If you do not have any predefined customization available, select None .
Select Cloud-init or Custom Spec .
If you selected Cloud-init , enter or upload the script in the Script field.
If you have selected Custom Spec , enter the details for the VM in the following fields:
1. Enter the hostname in the Hostname field.
2. Enter the domain in the Domain field.
3. Select timezone from the Timezone list.
4. Select Hardware clock UTC check box to enable hardware clock UTC.
5. Click the + icon to add network settings.
  To automatically configure DHCP server, enable the Use DHCP check box and then skip to the DNS Setting section.
6. Enter a name for the network configuration you are adding to the VM in the Setting name field.
  Settings name is the saved configuration of your network that you want to connect to your VM.
7. Enter values in the IP Address , Subnet Mask , Default Gateway , and Alternative Gateway fields.
8. Under the DNS Settings section, enter the DNS primary, DNS secondary, DNS tertiary, and DNS search path name.
Note: You can launch a single-VM blueprint without a NIC or network adapter with your VMware account.
To save the blueprint, click Save .

What to do next

You can optionally configure the advanced options in the blueprint. For more information, see Configuring Advanced Options for a Blueprint.
You can view the blueprint on the Blueprint tab. You can use the blueprint to model your application. For more information, see Blueprints Management in Calm.

Configuring VM for GCP Account

Perform the following steps to configure the VM in a single-VM blueprint for your GCP account.

Before you begin

Ensure that you set up your single-VM blueprint. For more information, see Setting up a Single-VM Blueprint.
Ensure that you added the VM details to your blueprint. For more information, see Adding VM Details to a Blueprint.

Procedure

(Optional) If you have configured an environment during the project creation, then on the VM Configuration tab, click Clone from environment to autofill the VM configuration details.
The Clone from environment option appears only when you select a specific environment you configured for the account from the Environment list on the Blueprint Settings tab. The option does not appear if you select All Project Accounts as your environment.

You can also click the View Configuration option to review the configuration details before cloning the environment.
(Optional) Edit the VM name in the Instance Name field.
This field is pre-populated with a macro as suffix to ensure name uniqueness. The service provider uses this name as the VM name.
Select a zone from the Zone list.
A zone is a physical location where you can host the VM.
Select the type of machine from the Machine type list.
The machine types are available based on your zone. A machine type is a set of virtualized hardware resources available to a virtual machine (VM) instance, including the system memory size, virtual CPU (vCPU) count, and persistent disk limits. In Compute Engine, machine types are grouped and curated by families for different workloads.
Under the DISKS section, click the + icon to add a disk.
You can also mark the added vDisks runtime editable so you can add, delete, or edit the vDisks while launching the blueprint. For more information about runtime editable attributes, see Runtime Variables Overview.
To use an existing disk configuration, select the Use existing disk check box, and then select the persistent disk from the Disk list.
If you have not selected the Use existing disk check box, then do the following:
1. Select the type of storage from the Storage Type list. The available options are as follows.
  - pd-balanced : Use this option as an alternative to SSD persistent disks with a balanced performance and cost.
  - pd-extreme : Use this option to use SSD drives for high-end database workloads. This option has higher maximum IOPS and throughput and allows you to provision IOPS and capacity separately.
  - pd-ssd : Use this option to use SSD drives as your persistent disk.
  - pd-standard : Use this option to use HDD drives as your persistent disk.
  The persistent disk types are durable network storage devices that your instances can access like physical disks in a desktop or a server. The data on each disk is distributed across several physical disks.
2. Select the image source from the Source Image list.
  The images available for your selection are based on the selected zone.
3. Enter the size of the disk in GB in the Size in GB field.
4. To delete the disk configuration after the instance is deleted, select the Delete when instance is deleted check box under the Disks section.
To add a blank disk, click the + icon under the Blank Disks section and configure the blank disk.
To add networking details to the VM, click the + icon under the Networking section.
To configure a public IP address, select the Associate Public IP address check box and configure the following fields.
1. Select the network from the Network list and the sub network from the Subnetwork list.
2. Enter a name of the network in the Access configuration Name field and select the access configuration type from the Access configuration type list.
  These fields appear when you select the Associate public IP Address check box.
To configure a private IP address, clear the Associate Public IP address check box and select the network and sub network.
Under the SSH Key section, click the + icon and enter or upload the username key data in the Username field.
Select Block project-wide SSH Keys to enable blocking project-wide SSH keys.
Under the Management section, do the following:
1. Enter the metadata in the Metadata field.
2. Select the security group from the Network Tags list.
  Network tags are text attributes you can add to VM instances. These tags allow you to make firewall rules and routes applicable to specific VM instances.
3. Enter the key-value pair in the Labels field.
  A label is a key-value pair that helps you organize the VMs created with GCP as the provider. You can attach a label to each resource, then filter the resources based on their labels.
Under the API Access section, do the following:
1. Specify the service account in the Service Account field.
2. Under Scopes, select Default Access or Full Access .
To save the blueprint, click Save .

What to do next

You can optionally configure the advanced options in the blueprint. For more information, see Configuring Advanced Options for a Blueprint.
You can view the blueprint on the Blueprint tab. You can use the blueprint to model your application. For more information, see Blueprints Management in Calm.

Configuring VM for AWS Account

Perform the following steps to configure the VM in a single-VM blueprint for your AWS account.

Before you begin

Ensure that you set up your single-VM blueprint. For more information, see Setting up a Single-VM Blueprint.
Ensure that you added the VM details to your blueprint. For more information, see Adding VM Details to a Blueprint.

Procedure

(Optional) If you have configured an environment during the project creation, then on the VM Configuration tab, click Clone from environment to autofill the VM configuration details.
The Clone from environment option appears only when you select a specific environment you configured for the account from the Environment list on the Blueprint Settings tab. The option does not appear if you select All Project Accounts as your environment.

You can also click the View Configuration option to review the configuration details before cloning the environment.
Edit the VM name in the Instance Name field.
This field is pre-populated with a macro as suffix to ensure name uniqueness. The service provider uses this name as the VM name.
Select the Associate Public IP Address check box to associate a public IP address with your AWS instance.
If you do not select the Associate Public IP Address check box, ensure that the AWS account and Calm are on the same network for the scripts to run.
Select an AWS instance type from the Instance Type list.
Instance types include varying combinations of CPU, memory, storage, and networking capacity and give you the flexibility to select the appropriate mix of resources for your applications. Each instance type includes one or more instance sizes that allows you to scale your resources to the requirements of your target workload.

The list displays the instances that are available in the AWS account. For more information, see AWS documentation.
Select a region from the Region list and do the following:

Note: The list displays the regions that are selected while configuring the AWS setting.
1. Select an availability zone from the Availability Zone list.
  An availability zone is one or more discrete data centers with redundant power, networking, and connectivity in an AWS region. Availability zones allow you to operate production applications and databases that are more highly available, fault tolerant, and scalable than would be possible from a single data center.
2. Select a machine image from the Machine Image list.
  An Amazon Machine Image is a special type of virtual appliance that is used to create a virtual machine within the Amazon Elastic Compute Cloud. It serves as the basic unit of deployment for services delivered using EC2.
3. Select an IAM role from the IAM Role list.
  An IAM role is an AWS Identity and Access Management entity with permissions to make AWS service requests.
4. Select a key pair from the Key Pairs list.
  A key pair (consisting of a private key and a public key) is a set of security credentials that you use to prove your identity when connecting to an instance.
5. Select the VPC from the VPC list and do the following:
  Amazon Virtual Private Cloud (Amazon VPC) allows you to provision a logically isolated section of the AWS cloud where you can launch AWS resources in your defined virtual network.
  - Select the Include Classic Security Group check box to enable security group rules.
  - Select security groups from the Security Groups list.
  - Select a subnet from the Subnet list.
Enter or upload the AWS user data in the User Data field.
Enter AWS tags in the AWS Tags field.
AWS tags are key and value pair to manage, identify, organize, search for, and filter resources. You can create tags to categorize resources by purpose, owner, environment, or other criteria.
Under the Storage section, configure the following to boot the AWS instance with the selected image.
1. From the Device list, select the device to boot the AWS instance.
  The available options are based on the image you have selected.
2. In the Size(GiB) field, enter the required size for the bootable device.
3. From the Volume Type list, select the volume type. You can select either General Purpose SSD , Provisioned IOPS SSD , and EBS Magnetic HDD .
  For more information on the volume types, see AWS documentation.
4. Optionally, select the Delete on termination check box to delete the storage when the instance is terminated.
You can also add more secondary storages by clicking the + icon next to the Storage section.
To save the blueprint, click Save .

What to do next

You can optionally configure the advanced options in the blueprint. For more information, see Configuring Advanced Options for a Blueprint.
You can view the blueprint on the Blueprint tab. You can use the blueprint to model your application. For more information, see Blueprints Management in Calm.

Configuring VM for Azure Account

Perform the following steps to configure the VM in a single-VM blueprint for your Azure account.

Before you begin

Ensure that you set up your single-VM blueprint. For more information, see Setting up a Single-VM Blueprint.
Ensure that you added the VM details to your blueprint. For more information, see Adding VM Details to a Blueprint.

Procedure

(Optional) If you have configured an environment during the project creation, then on the VM Configuration tab, click Clone from environment to autofill the VM configuration details.
The Clone from environment option appears only when you select a specific environment you configured for the account from the Environment list on the Blueprint Settings tab. The option does not appear if you select All Project Accounts as your environment.

You can also click the View Configuration option to review the configuration details before cloning the environment.
Edit the VM name in the Instance Name field.
This field is pre-populated with a macro as suffix to ensure name uniqueness. The service provider uses this name as the VM name.
Select a resource group from the Resource Group list or select the Create Resource Group check box to create a resource group.
Each resource in Azure must belong to a resource group. A resource group is simply a logical construct that groups multiple resources together so you can manage the resources as a single entity. For example, you can create or delete resources as a group that share a similar life cycle, such as the resources for an n-tier application.

The Resource Group list displays the resource groups that are associated with the subscriptions you selected in your Azure account. In case you have not selected any subscriptions, Calm considers all the subscriptions that are available in the Azure service principal to display the resource groups. Each resource group in the list also displays the associated subscription.
If you selected a resource group from the Resource Group list, then do the following:
1. Select the geographical location of the datacenter from the Location list.
2. Select Availability Sets or Availability Zones from the Availability Option list.
  You can then select an availability set or availability zone. An availability set is a logical grouping capability to ensure that the VM resources are isolated from each other to provide High Availability if deployed within an Azure datacenter. An availability zone allows you to deploy your VM into different datacenters within the same region.
3. Select the hardware profile as per your hardware requirements from the Hardware Profile list.
  The number of data disks and NICs depends upon the selected hardware profile. For information about the sizes of Windows and Linux VMs, see Windows and Linux Documentation.
If you selected the Create Resource Group check box to create a resource group, then do the following:
1. Select a subscription associated to your Azure account in the Subscription field.
2. Enter a unique name for the resource group in the Name field.
3. Select the geographical location of the datacenter that you want to add to the resource group in the Location list.
4. Under Tags , enter a key and value pair in the Key and Value fields respectively.
  Tags are key and value pairs that enable you to categorize resources. You can apply a tag to multiple resource groups.
5. If you want to automatically delete a resource group that has empty resources while deleting an application, click the Delete Empty Resource Group check box.
6. Specify the location and hardware profile.
Under the Secrets section, click the + icon and do the following:
1. Enter a unique vault ID in the Vault ID field.
2. Under Certificates , click the + icon.
3. Enter the URL of the configuration certificate in the URL field.
  The URL of the certificate is uploaded to the key vault as a secret.
Under the Admin Credentials section, do the following:
1. Enter the username in the Username field.
2. Select a secret type from the Secret Type list.
  You can either select Password or SSH Private Key.
3. Do one of the following.
  - If you selected password, then enter the password in the Password field.
  - If you selected SSH Private Key, then enter or upload the SSH Private Key in the SSH Private Key field.
  - You can use the selected or default credential as the default credential for the VM.
  - You cannot use key-based credential for Windows VMs.
  - Username and password must adhere to the complexity requirements of Azure.
(For Windows) Select the Provision Windows Guest Agent check box.
This option indicates whether or not to provision the virtual machine agent on the virtual machine. When this property is not specified in the request body, the default behavior is to set it to true. This ensures that the VM Agent is installed on the VM, and the extensions can be added to the VM later.
(For Windows) To indicate that the VM is enabled for automatic updates, select the Automatic OS Upgrades check box.
Under the Additional Unattended Content section, click the + icon and do the following:
1. Select a setting from the Setting Name list.
  You can select Auto Logon or First Logon Commands .
  Note: Guest customization is applicable only on images that allows or support guest customization.
2. Enter or upload the xml content. See Sample Auto Logon and First Logon Scripts.
Under the WinRM Listeners section, click the + icon and do the following:
1. Select the protocol from the Protocol list.
  You can select HTTP or HTTPS .
2. If you selected HTTPS, then select the certificate URL from the Certificate URL list.
Under the Storage Profile section, select the Use Custom Image check box to use a custom VM image created in your subscription.
You can then select a custom image or publisher-offer-SKU-version from the Custom Image list.
Under the VM Image Details section, select an image type in the Source Image Type list.
You can select Marketplace , Subscription , or Shared Image Gallery .
- If you selected Marketplace , then specify the publisher, offer, SKU, and version for the image.
- If you selected Subscription , then select the custom image.
- If you selected Shared Image Gallery , then select the gallery and the image.
Under the OS Disk Details section, do the following:
1. Select the storage type from the Storage Type list.
  You can select Standard HDD , Standard SSD , or Premium SSD .
2. Select a disk storage account from the Disk Storage list.
  This field is available only when the Use Custom Image check box is enabled.
3. Select disk caching type from the Disk Caching Type list.
  You can select None , Read-only , or Read write .
4. Select disk create option from the Disk Create Option list.
  You can select Attach , Empty , or From Image .
Under the Data Disk section, do the following:
1. Select the storage type from the Storage Type list.
  You can select Standard HDD , Standard SSD , or Premium SSD .
2. Select disk caching type from the Disk Caching Type list.
  You can select None , Read-only , or Read write .
3. Enter the size in GB in the Size field.
4. Enter disk logical unit number (LUN) in the Disk LUN field.
  
  Note: The LUN value should be unique across data disk list.
Under the Network Profile section, add NICs as per your requirement and do the following for each NIC:
1. Select a security group from the Security Group list.
2. Select a virtual network from the Virtual Network list.
3. Under Public IP Config , enter a name and select an allocation method.
4. Under Private IP Config , select an allocation method.
  If you selected Static as the allocation method, then enter the private IP address in the IP Address field.
Enter tags in the Tags field.
To save the blueprint, click Save .

What to do next

You can optionally configure the advanced options in the blueprint. For more information, see Configuring Advanced Options for a Blueprint.
You can view the blueprint on the Blueprint tab. You can use the blueprint to model your application. For more information, see Blueprints Management in Calm.

Configuring VM for Xi Cloud Account

Perform the following steps to configure the VM in a single-VM blueprint for your Xi Cloud account.

Before you begin

Ensure that you set up your single-VM blueprint. For more information, see Setting up a Single-VM Blueprint.
Ensure that you added the VM details to your blueprint. For more information, see Adding VM Details to a Blueprint.

Procedure

On the VM Configuration tab, edit the VM name in the VM Name field.
You can use Calm macros to provide a unique name to the VM. For example, vm-@@{calm_time}@@ . For more information on Calm macros, see Macros Overview.
Configure the processing unit of the VM by entering the number of vCPU, cores of each vCPU, and total memory in GB of the VM in the vCPU , cores per vCPU , and Memory fields.
If you want to customize the default OS properties of the VM, select the Guest Customization check box.
Guest customization allows you to modify the properties of the VM operating system. You can prevent conflicts that might result due to the deployment of virtual machines with identical settings, such as duplicate VM names or same SID. You can also change the computer name or network settings by using a custom script.
Select Cloud-init for Linux or SysPrep for Windows, and enter or upload the script in the Script panel.
For Sysprep, you must use double back slash for all escape characters . For example, \\v.
For Sysprep script, click Join a Domain check box and configure the following fields.
- Enter the domain name of the Windows server in the Domain Name field.
- Select a credential for the Windows VM in the Credentials list. You can also add new credentials.
- Enter the IP address of the DNS server in the DNS IP field.
- Enter the DNS search path for the domain in the DNS Search Path field.
Select the image from the Image list.
The list displays the images that are available in the cluster. You can add more than one image by clicking the + icon.

All the images that you uploaded to Prism Central are available for selection. For more information about image configuration, see Image Management section in the Prism Central guide.
Select the device from the Device Type list.
You can select CD-ROM or Disk .
Select the device bus from the Device Bus list.
You can select IDE or SATA for CD-ROM and SCSI , IDE , PCI , or SATA for DISK.
Select the Bootable check box for the image that you want to use to start the VM.
To add a vDisk, click the + icon and specify the device type, device bus, and disk size.
You can also mark the vDisks runtime editable so you can add, delete, or edit the vDisks while launching the blueprint. For more information about runtime editable attributes, see Runtime Variables Overview.
Under Categories , select a category in the list.
Use this option to tag your VM to a defined category in Prism Central. The list options are available based on your Prism Central configuration. If you want to protect your application by a protection policy, select the category defined for the policy in your Prism Central.
Under the Network section, select the VPC from the VPC list. For more information about VPC, see Xi Infrastructure Service Admininistration Guide .
To save the blueprint, click Save .

What to do next

You can optionally configure the advanced options in the blueprint. For more information, see Configuring Advanced Options for a Blueprint.
You can view the blueprint on the Blueprint tab. You can use the blueprint to model your application. For more information, see Blueprints Management in Calm.

Configuring Advanced Options for a Blueprint

Perform the following steps to configure advanced options such as credentials, packages, pre-create and post-delete tasks. Configuring advanced options is optional for a blueprint.

Before you begin

Ensure that you set up your single-VM blueprint. For more information, see Setting up a Single-VM Blueprint.
Ensure that you added the VM details to your blueprint. For more information, see Adding VM Details to a Blueprint.
Ensure that you configured the VM in your blueprint. For more information, see VM Configuration.

Procedure

Add credentials to enable packages and actions. For more information, see Adding Credentials.
Configure the connection in your blueprint. For more information, see Configuring Check Log-In.
Configure pre-create or post-delete tasks and packages in the blueprint. For more information, see Configuring Tasks or Packages in a Blueprint.
Add an action. For more information, see Adding an Action to a Single-VM Blueprint.
Click Save .

What to do next

You can configure application variables in the blueprint. For more information, see Configuring Application Variables in a Blueprint.
You can view the blueprint on the Blueprint tab. You can use the blueprint to model your application. For more information, see Blueprints Management in Calm.

Configuring Tasks or Packages in a Blueprint

Perform the following steps to configure pre-create task, post-delete task, install package, or uninstall package in a single-VM blueprint.

Before you begin

Ensure that you set up your single-VM blueprint. For more information, see Setting up a Single-VM Blueprint.
Ensure that you added the VM details to your blueprint. For more information, see Adding VM Details to a Blueprint.
Ensure that you configured the VM in your blueprint. For more information, see VM Configuration.

Procedure

On the Advanced Options tab, do one of the following:
- To configure a pre-create or post-delete task, click Edit next to the Pre VM create tasks or Post VM delete tasks field under the PreCreate & PostDelete section.
- To configure an install or uninstall package, click the Edit button next to the Package Install or Package Uninstall field under the Packages section.
Click + Add Task .
Click the Task button.
Enter the task name in the Task Name field.
Select the type of tasks from the Type list.
The available options are:
- Execute : Use this task type to run eScripts on the VM. For more information, see Creating an Execute Task.
- Set Variable : Use this task to change variables in a blueprint. For more information, see Creating a Set Variable Task.
- Delay : Use this task type to set a time interval between two tasks or actions. For more information, see Creating a Delay Task.
- HTTP Task : Use this task type to query REST calls from a URL. An HTTP task supports GET, PUT, POST, and DELETE methods. For more information, see Creating an HTTP Task.
To add another task or package, do one of the following:
- To add another pre-create or post-delete task, click the Pre create or Pre delete button and repeat steps 3 to 5.
- To add another task for package install or uninstall, click the Package Install or Package Uninstall button.
To establish a connection between tasks, click Add Connector and use the arrow to create the connection.
To delete a task, click the Delete button next to the task.
To add variables, do one of the following:
- To add a pre-create or post-delete variable, click the Pre create Variables or Post delete Variables tab.
- To add a package install or uninstall variable, click the Package Install Variables or Package Uninstall Variables tab.
Click the + icon next to Variables .
In the Name field, enter a name for the variable.
From the Data Type list, select one of the base type variables or import a custom library variable type.
If you selected a base type variable, configure all the variable parameters. For more information about configuring variable parameters, see Creating Variable Types.

If you imported a custom variable type, all the variable parameters are auto filled.
If you want to hide the variable value, select the Secret check box.
Click Done .

Configuring Application Variables in a Blueprint

Perform the following steps to configure application variables in your blueprint.

Procedure

On the blueprint page, click App variables .
Click + Add Variable .
In the Name field, enter a name for the variable.
From the Data Types list, select one of the base type variables or import a custom library variable type. Your options are:
- String
- Integer
- Multi-line string
- Date
- Time
- Date Time
If you selected a base type variable, then configure all the variable parameters. For more information about configuring variable parameters, see Creating Variable Types.

If you have imported a custom variable type, all the variable parameters are auto filled.
Enter a value for the selected data type in the Value field.
You can select the Secret check box to hide the variable value.
Click Show Additional Options .
In the Input Type field, select one of the following input types:
- Simple : Use this option for default value.
- Predefined : Use this option to assign static values.
- eScript : Use this option to attach a script that you run to retrieve values dynamically at runtime. Script can return single or multiple values depending on the selected base data type.
- HTTP : Use this option to retrieve values dynamically from the defined HTTP end point. Result is processed and assigned to the variable based on the selected base data type.
If you selected Simple , then enter the value for the variable in the Value field.
If you selected Predefined , then enter the value for the variable in the Option field.
To add multiple values for the variable, click + Add Option , and enter values in the Option field.

Note: To make any value as default, select Default for the option.
If you selected eScript , enter the eScript in the field.
You can upload the script from the library or from your computer by clicking the upload icon.

You can also publish the script to the library by clicking the publish button.
Note:
- You cannot add macros to eScripts.
- If you have selected Multiple Input (Array) check box with input type as eScript, then ensure that the script returns a list of values separated by comma. For example, CentOS, Ubuntu, Windows.
If you selected HTTP , then configure the following fields.
1. In the Request URL field, enter the URL of the server that you want to run the methods on.
2. In the Request Method list, select one of the following request methods.
  - Use the GET method to retrieve data from a specified resource.
  - Use the PUT method to send data to a server to update a resource.
  - Use the POST method to send data to a server to create a resource.
  - Use the DELETE method to send data to a server to delete a resource.
  In the Request Body field, enter the PUT, POST, or DELETE request. You can also upload the request by clicking the upload icon.
3. In the Content Type list, select the type of the output format.
  The available options are XML , JSON , and HTML .
4. In the Connection Timeout (sec) field, enter the timeout interval in seconds.
5. (Optional) In the Authentication field, select Basic and do the following:
  - In the Username field, enter the user name.
  - In the Password field, enter the password.
6. If you want to verify the TLS certificate for the task, select the Verify TLS Certificate check box.
7. If you want to use a proxy server that you configured in Prism Central, select the Use PC Proxy configuration check box.
  
  Note: Ensure that the Prism Central has the appropriate HTTP proxy configuration.
8. In the Retry Count field, enter the number of attempts the system must perform to create a task after each failure.
  By default, the retry count is zero. It implies that the task creation procedure stops after the first attempt.
9. In the Retry Interval field, enter the time interval in seconds for each retry if the task fails.
10. Under the Headers section, enter the HTTP header key and value in the Key and Value fields respectively.
  If you want to publish the HTTP header key and value pair as secret, select the Secrets check box.
11. Under the Expected Response Options section, enter the details for the following fields:
  - In the Response Code field, enter the response code.
  - From the Response Status list, select either Success or Failure as the response status for the task.
12. In the Set Response Path for Variable field, enter the variables from the specified response path.
  The example of json format is $.x.y and xml format is //x/y. For example, if the response path for variable is $.[*].display for response.
```
[
    {
        "display": "HTML Tutorial",
        "url": "https://www.w3schools.com/html/default.asp"
    },
    {
        "display": "CSS Tutorial",
        "url": "https://www.w3schools.com/css/default.asp"
    },
    {
        "display": "JavaScript Tutorial",
        "url": "https://www.w3schools.com/js/default.asp"
    },
    {
        "display": "jQuery Tutorial",
        "url": "https://www.w3schools.com/jquery/default.asp"
    },
    {
        "display": "SQL Tutorial",
        "url": "https://www.w3schools.com/sql/default.asp"
    },
    {
        "display": "PHP Tutorial",
        "url": "https://www.w3schools.com/php/default.asp"
    },
    {
        "display": "XML Tutorial",
        "url": "https://www.w3schools.com/xml/default.asp"
    }
]
```
  Then, during the launch time the list options are ["HTML Tutorial","CSS Tutorial","JavaScript Tutorial","jQuery Tutorial","SQL Tutorial","PHP Tutorial","XML Tutorial"].
(Optional) Enter a label and description for the variable.
(Optional) Set variable options.
- Select the Mark this variable private check box to make the variable private. Private variables are not shown during the blueprint launch or in the application.
- Select the Mark this variable mandatory check box to make the variable a requisite for application launch.
- Select the Validate with Regular Expression check box if you want to test the Regex values. Click Test Regex , provide the value for the Regex, and test or save the Regex. You can enter regex values in PCRE format. For more details, see from http://pcre.org/.
Click Done .

Multi-VM Blueprints in Calm

A multi-VM blueprint is a framework that you can use to create an instance, provision, and launch applications that require multiple VMs.

Creating a Multi-VM Blueprint

In a Multi-VM blueprint, you can define the underlying infrastructure of the VMs, application details, and actions that are carried out on a blueprint until the termination of the application.

About this task

You can create and configure multi-VM blueprints with your Nutanix, VMware, AWS, GCP, or Azure accounts.

Before you begin

Ensure that you have configured an account and a project for your blueprint.

Procedure

Add a service. For more information, see Adding a Service.
Configure VM, package, and service for your provider account. For more information, see Configure Multi-VM, Package, and Service.
Set the service dependencies. For more information, see Setting up the Service Dependencies.
Add and configure an application profile. For more information, see Adding and Configuring an Application Profile.
(Optional) Add and configure Scale Out and Scale In. For more information, see Adding and Configuring Scale Out and Scale In.
Create an action. For more information, see Adding an Action to a Multi-VM Blueprint.

Adding a Service

Services are the virtual machine instances, existing machines or bare-metal machines, that you can provision and configure by using Calm. A service exposes the IP address and ports on which the request is received. You can either provision a single-service instance or multiple services based on the topology of your application.

About this task

For more information about services in Calm, see Services Overview.

Procedure

Click the Blueprint icon in the left pane.
The Blueprint page is displayed.
From the + Create Blueprint list, select Multi VM/Pod Blueprint .
The Blueprint Setup window appears.
Enter the name of the blueprint in the Name field.
Optionally, provide a description about the blueprint in the Description field.
Select a project from the Project list.

Note: The available account options depend on the selected project.
Click Proceed .
The Multi-VM Blueprint Editor page appears.
Figure. Multi-VM Blueprint Editor Click to enlarge
To add a service, click the + icon next to Service in the Overview Panel.
The service inspector appears in the Blueprint Canvas.
Figure. Service Inspector Click to enlarge

What to do next

Configure the VM, package, and service. For more information, see Configure Multi-VM, Package, and Service.

Configure Multi-VM, Package, and Service

You can define and configure the underlying infrastructure of the VM, application details, and actions that are carried out on a blueprint until the termination of the application for a service provider.

Configuring Nutanix and Existing Machine VM, Package, and Service

You can define the underlying infrastructure of the VM, application details, and actions that are carried out on a blueprint until the termination of the application on a Nutanix platform.

Before you begin

Ensure that you have completed the pre-configuration requirements. For more information, see Creating a Multi-VM Blueprint.
Ensure that you have created a project and configured an environment for Nutanix. For more information, see Creating a Project and Configuring Nutanix Environment.

Procedure

Perform the basic blueprint setup, and add a service. For more information, see Adding a Service.

Figure. Blueprint Configuration Click to enlarge
Enter a name of the service in the Service Name field.
On the VM tab, in the Name field, enter a name for the VM.
Select the provider account from the Account list.
You can select Existing Machine or a Nutanix account.

Note: The account options depend on the project you selected while setting up your blueprint.
If you selected Existing Machine , then do the following:
1. Select Windows or Linux from the Operating System list.
2. In the Configuration section, enter the IP address of the existing machine in the IP Address field
3. In the Select tunnel to connect with list, select a tunnel that you want to use to connect with this VM if the VM is within the VPC. This step is optional.
4. Configure the connection in your blueprint. For more information, see Configuring Check Log-In.
Figure. Existing Machine Click to enlarge
If you selected a Nutanix account, then select Windows or Linux from the Operating System list.
If you have configured an environment during the project creation, then under the Preset VM Config section, click the Clone from environment button to autofill the VM configuration details. This step is optional.
The Clone from environment button appears only when you select a specific environment you configured for the account from the Environment list in the application profile. The option does not appear if you select All Project Accounts as your environment.

You can also click the View Configuration option to review the configuration details before cloning the environment.
In the Cluster list, select the cluster you want to associate to the service.
The Cluster list displays the clusters that you allowed in the project.

The VLAN subnets have direct association with the cluster. When you select a VLAN subnet under the Network Adapters (NICs) section, the associated cluster is auto-populated in the Cluster list. However, if you intend to use overlay subnets, you must select the cluster in list.

If you mark the cluster as runtime editable, the selected subnets also become runtime editable.
Under the VM Configuration section, enter the name of the VM in the VM Name field.
You can use Calm macros to provide a unique name to the VM. For example, vm-@@{calm_array_index}@@-@@{calm_time}@@ . For more information on Calm macros, see Macros Overview.
Configure the processing unit of the VM by entering the number of vCPU, cores of each vCPU, and total memory in GB of the VM in the vCPU , cores per vCPU , and Memory (GiB) fields.
(Optional) If you want to customize the default OS properties of the VM, select the Guest Customization check box.
Guest customization allows you to modify the properties of the VM operating system. You can prevent conflicts that might result due to the deployment of virtual machines with identical settings, such as duplicate VM names or same SID. You can also change the computer name or network settings by using a custom script.
1. Select Cloud-init for Linux or SysPrep for Windows, and enter or upload the script in the Script panel.
  For Sysprep, you must use double back slash for all escape characters . For example, \\v.
2. For Sysprep script, click Join a Domain check box and configure the following fields.
  - Enter the domain name of the Windows server in the Domain Name field.
  - Select a credential for the Windows VM in the Credentials list. You can also add new credentials.
  - Enter the IP address of the DNS server in the DNS IP field.
  - Enter the DNS search path for the domain in the DNS Search Path field.
Under the DISKS section, do the following:
1. To add a disk, click the + icon next to DISKS .
2. Select the device from the Device Type list.
  You can select CD-ROM or DISK .
3. Select the device bus from the Device Bus list.
  You can select IDE or SATA for CD-ROM and SCSI , IDE , PCI , or SATA for DISK.
4. From the Operation list, select one of the following:
  - To allocate the disk memory from the storage container, select Allocate on Storage Container .
  - To clone an image from the disk, select Clone from Image Service .
5. If you selected Allocate on Storage Container , enter the disk size in GB in the Size (GiB) field.
6. If you selected Clone from Image Service , select the image you want to add to the disk in the Image field.
  All the images that you uploaded to Prism Central are available for selection. For more information about image configuration, see Image Management section in the Prism Central guide.
7. Select the Bootable check box for the image that you want to use to start the VM.
Note: You can add more than one disk and select the disk with which you want to boot up the VM.
Select one of the following firmwares to boot the VM.
- Legacy BIOS : Select legacy BIOS to boot the VM with legacy BIOS firmware.
- UEFI : Select UEFI to boot the VM with UEFI firmware. UEFI firmware supports larger hard drives, faster boot time, and provides more security features.
- To boot the VM with the Secure Boot feature of UEFI, select Secure Boot . Secure Boot ensures a safe and secure start by preventing unauthorized software such as a malware to take control during the VM bootup.
Under the Categories section, select a category in the Key: Value list.
Use this option to tag your VM to a defined category in Prism Central. The list options are available based on your Prism Central configuration. If you want to protect your application by a protection policy, select the category defined for the policy in your Prism Central.
To add a network adapter, click the + icon next to the Network Adapters (NICS) field and select the subnet from the NIC list.
The NIC list shows all the VLAN and overlay subnets. The VLAN subnets have direct association with the cluster. Therefore, when you select a VLAN subnet, the associated cluster is auto-populated in the Cluster list.

Figure. Network Adapter Click to enlarge

The NICs of a VM can either use VLAN subnets or overlay subnets. For example, if you select an overlay subnet in NIC 1 and then add NIC 2, the NIC 2 list displays only the overlay subnets.

If you select a VLAN subnet in NIC 1, all subsequent VLAN subnets belong to the same cluster. Similarly, if you select an overlay subnet, all subsequent overlay subnets belong to the same VPC.
To add a serial port to the VM, click the + icon next to the Serial Ports field.
You can use serial ports to connect a physical port or a file on the VM.
Configure the connection in your blueprint. For more information, see Configuring Check Log-In.
On the Package tab, enter the package name in the Package Name field.
1. Click one of the following:
  - To create a task to install a package, click Configure install .
  - To create a task to uninstall a package, click Configure uninstall .
2. In the Blueprint Canvas, click + Task .
  
  Figure. Package Click to enlarge
3. Enter the task name in the Task Name field.
To create a task, select the type of task from the Type list.
The available options are:
- Execute : To create the Execute task type, see Creating an Execute Task.
- Set Variable : To create the Set Variable task type, see Creating a Set Variable Task.
- HTTP : To create the HTTP type, see Creating an HTTP Task.
- Delay : To create the Delay task type, see Creating a Delay Task.
For Execute and Set Variable tasks, you can use endpoints as targets for script execution. For more information, see Endpoints Overview.
To reuse a task from the task library, do the following.
1. Click Browse Library .
2. Select the task from the task library.
  When you select a task, the task inspector panel displays the selected task details.
3. Click Select .
4. Optionally, edit the variable or macro names as per your blueprint.
  The variable or macro names used in the task can be generic, you can update them with corresponding variable or macro names as per your blueprint.
5. To update the variable or macro names, click Apply .
6. To copy the task, click Copy .
On the Service tab, do the following:
1. Under Deployment Config , enter the number of default, minimum and maximum service replicas that you want to create in the Default , Min , and Max fields respectively.
  The Min and Max fields define the scale-in and scale-out actions. The scale-in and scale-out actions cannot scale beyond the defined minimum and maximum numbers. The default field defines the number of default replicas the service creates.
  
  If there is an array of three VMs, define the minimum number as three.
2. In the Variables section, click the + icon to add variable types to your blueprint.
3. In the Name field, enter a name for the variable.
4. From the Data Type list, select one of the base type variables or import a custom library variable type.
5. If you have selected a base type variable, configure all the variable parameters. For more information about configuring variable parameters, see Creating Variable Types.
6. If you have imported a custom variable type, all the variable parameters are auto filled.
7. Select the Secret check box if you want to hide the value of the variable.
Add credentials to the blueprint. For more information, see Adding Credentials.
Click Save on the Blueprint Editor page.
The blueprint is saved and listed on the Blueprints page.

What to do next

Define the service dependencies. See Setting up the Service Dependencies.

Configuring AWS VM, Package, and Service

You can define the underlying infrastructure of the VM, application details, and actions that are carried out on a blueprint until the termination of the application on an AWS platform.

Before you begin

Ensure that you have completed the pre-configuration requirements. See Creating a Multi-VM Blueprint.
Ensure that you have created a project and configured an environment for AWS. For more information, See Creating a Project and Configuring AWS Environment.

Procedure

Perform the basic blueprint setup, and add a service. For more information, see Adding a Service.

Figure. Blueprint Configuration Click to enlarge
Enter a name of the service in the Service Name field.
On the VM tab, enter a name for the VM in the Name field.
Select the AWS account from the Account list.

Note: The account options depend on the project you selected while setting up your blueprint.
Select Windows or Linux from the Operating System list.
(Optional) If you have configured an environment during the project creation, then click Clone from environment to autofill the VM configuration details.
The Clone from environment option appears only when you select a specific environment you configured for the account from the Environment list in the application profile. The option does not appear if you select All Project Accounts as your environment.

You can also click the View Configuration option to review the configuration details before cloning the environment.
Edit the VM name in the Instance Name field.
This field is pre-populated with a macro as suffix to ensure name uniqueness. The service provider uses this name as the VM name.
Select the Associate Public IP Address check box to associate a public IP address with your AWS instance.
If you do not select the Associate Public IP Address check box, ensure that the AWS account and Calm are on the same network for the scripts to run.
Select an AWS instance type from the Instance Type list.
Instance types include varying combinations of CPU, memory, storage, and networking capacity and give you the flexibility to select the appropriate mix of resources for your applications. Each instance type includes one or more instance sizes that allows you to scale your resources to the requirements of your target workload.

The list displays the instances that are available in the AWS account. For more information, see AWS documentation.
Select a region from the Region list and do the following:

Note: The list displays the regions that are selected while configuring the AWS setting.
1. Select an availability zone from the Availability Zone list.
  An availability zone is one or more discrete data centers with redundant power, networking, and connectivity in an AWS region. Availability zones allow you to operate production applications and databases that are more highly available, fault tolerant, and scalable than would be possible from a single data center.
2. Select a machine image from the Machine Image list.
  An Amazon Machine Image is a special type of virtual appliance that is used to create a virtual machine within the Amazon Elastic Compute Cloud. It serves as the basic unit of deployment for services delivered using EC2.
3. Select an IAM role from the IAM Role list.
  An IAM role is an AWS Identity and Access Management entity with permissions to make AWS service requests.
4. Select a key pair from the Key Pairs list.
  A key pair (consisting of a private key and a public key) is a set of security credentials that you use to prove your identity when connecting to an instance.
5. Select the VPC from the VPC list and do the following:
  Amazon Virtual Private Cloud (Amazon VPC) allows you to provision a logically isolated section of the AWS cloud where you can launch AWS resources in your defined virtual network.
Enter AWS tags in the AWS Tags field.
AWS tags are key and value pair to manage, identify, organize, search for, and filter resources. You can create tags to categorize resources by purpose, owner, environment, or other criteria.
Under the Storage section, configure the following to boot the AWS instance with the selected image.
1. From the Device list, select the device to boot the AWS instance.
  The available options are based on the image you have selected.
2. In the Size(GiB) field, enter the required size for the bootable device.
3. From the Volume Type list, select the volume type. You can select either General Purpose SSD , Provisioned IOPS SSD , and EBS Magnetic HDD .
  For more information on the volume types, see AWS documentation.
4. Optionally, select the Delete on termination check box to delete the storage when the instance is terminated.
You can also add more secondary storages by clicking the + icon next to the Storage section.
Configure the connection in your blueprint. For more information, see Configuring Check Log-In.
On the Package tab, enter the package name in the Package Name field.
1. Click one of the following:
  - Configure install : To create a task to install a package.
  - Configure uninstall : To create a task to uninstall a package.
2. In the Blueprint Canvas, click + Task .
  
  Figure. Package Click to enlarge
3. Enter the task name in the Task Name field.
To create a task, select the type of task from the Type list.
The available options are:
- Execute : To create the execute type of task, see Creating an Execute Task.
- Set Variable : To create the set variable type of task, see Creating a Set Variable Task.
- HTTP : To create the HTTP Task type, see Creating an HTTP Task.
- Delay : To create the Delay task type, see Creating a Delay Task.
For Execute and Set Variable tasks, you can use endpoints as targets for script execution. For more information, see Endpoints Overview.
To reuse a task from the task library, do the following.
1. Click Browse Library .
2. Select the task from the task library.
  When you select a task, the task inspector panel displays the selected task details.
3. Click Select .
4. Optionally, edit the variable or macro names as per your blueprint.
  The variable or macro names used in the task can be generic, you can update them with corresponding variable or macro names as per your blueprint.
5. To update the variable or macro names, click Apply .
6. To copy the task, click Copy .
On the Service tab, configure the following.
1. In the Deployment Config pane, enter the number of default, minimum and maximum service replicas that you want to create in the Default , Min , and Max fields respectively.
  The Min and Max fields define the scale-in and scale-out actions. The scale-in and scale-out actions cannot scale beyond the defined minimum and maximum numbers. The default field defines the number of default replicas the service creates.
  
  If there is an array of three VMs, define the minimum number as three.
2. In the Variables section, click the + icon to add variable types to your blueprint.
3. In the Name field, enter a name for the variable.
4. From the Data Type list, select one of the base type variable or import a custom library variable type.
5. If you have selected a base type variable, configure all the variable parameters. For more information about configuring variable parameters, see Creating Variable Types.
6. If you have imported a custom variable type, all the variable parameters are auto filled.
7. Select the Secret check box if you want to hide the value of the variable.
Add credentials to the blueprint. For more information, see Adding Credentials.
Click Save on the Blueprint Editor page.
The blueprint is saved and listed on the Blueprints page.

What to do next

Define the service dependencies. See Setting up the Service Dependencies.

Configuring VMware VM, Package, and Service

You can define the underlying infrastructure of the VM, application details, and actions that are carried out on a blueprint until the termination of the application on a VMware platform.

Before you begin

Ensure that you complete the pre-configuration requirements. See Creating a Multi-VM Blueprint.
Ensure that you have created a project and configured an environment for VMware. For more information, see Creating a Project and Configuring VMware Environment.
You need licenses for both Compute and Storage distributed resource scheduler (DRS) in order to use the VMware DRS mode.
Ensure that storage DRS is enabled and set to fully automated in vCenter.

Procedure

Perform the basic blueprint setup, and add a service. For more information, see Adding a Service.

Figure. Blueprint Configuration Click to enlarge
Enter a name of the service in the Service Name field.
On the VM tab, enter the name of the VM in the Name field.
Select VMware from the Account list.

Note: The account options depend on the project you selected while setting up the blueprint.
Select Windows or Linux from the Operating System list.
(Optional) If you have configured an environment during the project creation, then click Clone from environment to autofill the VM configuration details.
The Clone from environment option appears only when you select a specific environment you configured for the account from the Environment list in the application profile. The option does not appear if you select All Project Accounts as your environment.

You can also click the View Configuration option to review the configuration details before cloning the environment.
Select the Compute DRS Mode check box to enable load sharing and automatic VM placement.
Distributed Resource Scheduler (DRS) is a utility that balances computing workloads with available resources in a virtualized environment. For more information about DRS mode, see the VMware documentation .
- If you selected Compute DRS Mode , then select the cluster where you want to host your VM from the Cluster list.
- If you have not selected Compute DRS Mode , then select the host name of the VM from the Host list.
Do one of the following:
- Select the VM Templates radio button and then select a template from the Template list.
  Templates allow you to create multiple virtual machines with the same characteristics, such as resources allocated to CPU and memory or the type of virtual hardware. Templates save time and avoid errors when configuring settings and other parameters to create VMs. The VM template retrieves the list options from the configured vCenter.
  Note:
  - Install the VMware Tools on the Windows templates. For Linux VMs, install Open-vm-tools or VMware-tools and configure the Vmtoolsd service for automatic start-up.
  - Support for Open-vm-tools is available. When using Open-vm-tools , install Perl for the template.
  - Do not use SysPrepped as the Windows template image.
  - If you select a template that has unsupported version of VMware Tools, then a warning appears stating VMware tool or version is unsupported and could lead to VM issues .
  - You can also edit the NIC type when you use a template.
  For more information, refer to VMware KB articles.
- Select the Content Library radio button, a content library in the Content Library list, and then select an OVF template or VM template from the content library.
  A content library stores and manages content (VMs, vApp templates, and other types of files) in the form of library items. A single library item can consist of one file or multiple files. For more information about the vCenter content library, see the VMware Documentation .
  
  Caution: Content Library support is currently a technical preview feature in Calm. Do not use any technical preview features in a production environment.
If you want to use the storage DRS mode, then select the Storage DRS Mode check box and a datastore cluster from the Datastore Cluster list.
The datastore clusters are referred as storage pod in vCenter. A datastore cluster is a collection of datastores with shared resources and a shared management interface.
If you do not want to use storage DRS mode, then do not select the Storage DRS Mode check box, and select a datastore from the Datastore list.
In the VM Location field, specify the location of the folder in which the VM must be created when you deploy the blueprint. Ensure that you specify a valid folder name already created in your VMware account.
To create a subfolder in the location you specified, select the Create a folder/directory structure here check box and specify a folder name in the Folder/Directory Name field.

Note: Calm gives preference to the VM location specified in the environment you select while launching an application. For example, you specify a subfolder structure as the VM location in the blueprint and the top-level folder in the environment. When you select this environment while launching your application, Calm considers the VM location you specified in the environment and creates the VM at the top-level folder.

Select the Delete empty folder check box to delete the subfolder created within the specified location, in case the folder does not contain any VM resources. This option helps you to keep a clean folder structure.
Enter the instance name of the VM in the Instance Name field.
This field is pre-populated with a macro as suffix to ensure name uniqueness. The service provider uses this name as the VM name.
Under Controllers , click the + icon to add the type of controller.
You can select either SCSI or SATA controller. You can add up to three SCSI and four SATA controllers.
Under the Disks section, click the + icon to add vDisks and do the following:
1. Select the device type from the Device Type list.
  You can either select CD-ROM or DISK .
2. Select the adapter type from the Adapter Type list.
  You can select IDE for CD-ROM.
  
  You can select SCSI , IDE , or SATA for DISK.
3. Enter the size of the disk in GiB.
4. In the Location field, select the disk location.
5. If you want to add a controller to the vDisk, select the type of controller in the Controller list to attach to the disk.
  
  Note: You can add either SCSI or SATA controllers. The available options depend on the adapter type.
6. In the Disk mode list, select the type of the disk mode. Your options are:
  - Dependent : Dependent disk mode is the default disk mode for the vDisk.
  - Independent - Persistent : Disks in persistent mode behave like conventional disks on your physical computer. All data written to a disk in persistent mode are written permanently to the disk.
  - Independent - Nonpersistent : Changes to disks in nonpersistent mode are discarded when you shut down or reset the virtual machine. With nonpersistent mode, you can restart the virtual machine with a virtual disk in the same state every time. Changes to the disk are written to and read from a redo log file that is deleted when you shut down or reset.
You can also mark the vDisks runtime editable so you can add, delete, or edit the vDisks while launching the blueprint. For more information about runtime editable attributes, see Runtime Variables Overview.
Under the Tags section, select tags from the Category: Tag pairs field.
You can assign tags to your VMs so you can view the objects associated with your VMs in your VMware account. For example, you can create a tag for a specific environment and assign the tag to multiple VMs. You can then view all the VMs that are associated with the tag.
(Optional) If you want to customize the default OS properties of the VM, then click the Enable check box under VM Guest Customization and select a customization from the Predefined Guest Customization list.
If you do not have any predefined customization available, select None .
Select Cloud-init or Custom Spec .
If you selected Cloud-init , enter or upload the script in the Script field.
If you have selected Custom Spec , enter the details for the VM in the following fields:
1. Enter the hostname in the Hostname field.
2. Enter the domain in the Domain field.
3. Select timezone from the Timezone list.
4. Select Hardware clock UTC check box to enable hardware clock UTC.
5. Click the + icon to add network settings.
  To automatically configure DHCP server, enable the Use DHCP check box and then skip to the DNS Setting section.
6. Enter a name for the network configuration you are adding to the VM in the Setting name field.
  Settings name is the saved configuration of your network that you want to connect to your VM.
7. Enter values in the IP Address , Subnet Mask , Default Gateway , and Alternative Gateway fields.
8. Under the DNS Settings section, enter the DNS primary, DNS secondary, DNS tertiary, and DNS search path name.
Configure the connection in your blueprint. For more information, see Configuring Check Log-In.
On the Package tab, enter the package name in the Package Name field.
1. Click one of the following:
  - Configure install : To create a task to install a package.
  - Configure uninstall : To create a task to uninstall a package.
2. In the Blueprint Canvas, click + Task .
  
  Figure. Package Click to enlarge
3. Enter the task name in the Task Name field.
To create a task, select the type of task from the Type list.
The available options are:
- Execute : To create the Execute type of task, see Creating an Execute Task.
- Set Variable : To create the set variable type of task, see Creating a Set Variable Task.
- HTTP : To create the HTTP task type, see Creating an HTTP Task.
- Delay : To create the Delay task type, see Creating a Delay Task.
For Execute and Set Variable tasks, you can use endpoints as targets for script execution. For more information, see Endpoints Overview.
To reuse a task from the task library, do the following.
1. Click Browse Library .
2. Select the task from the task library.
  When you select a task, the task inspector panel displays the selected task details.
3. Click Select .
4. Optionally, edit the variable or macro names as per your blueprint.
  The variable or macro names used in the task can be generic, you can update them with corresponding variable or macro names as per your blueprint.
5. To update the variable or macro names, click Apply .
6. To copy the task, click Copy .
On the Service tab, configure the following.
1. In the Deployment Config pane, enter the number of default, minimum and maximum service replicas that you want to create in the Default , Min , and Max fields respectively.
  The Min and Max fields define the scale-in and scale-out actions. The scale-in and scale-out actions cannot scale beyond the defined minimum and maximum numbers. The default field defines the number of default replicas the service creates.
  
  If there is an array of three VMs, define the minimum number as three.
2. In the Variables section, click the + icon to add variable types to your blueprint.
3. In the Name field, enter a name for the variable.
4. From the Data Type list, select one of the base type variable or import a custom library variable type.
5. If you have selected a base type variable, configure all the variable parameters. For more information about configuring variable parameters, see Creating Variable Types.
6. If you have imported a custom variable type, all the variable parameters are automatically filled.
7. Select the Secret check box if you want to hide the value of the variable.
Add credentials to the blueprint. For more information, see Adding Credentials.
Click Save on the Blueprint Editor page.

What to do next

Define the service dependencies. See Setting up the Service Dependencies.

Supported VMware Guest Tools Versions

To know the supported VMware guest tools versions, see the

VMware Product Interoperability Matrices .

Configuring GCP VM, Package, and Service

You can define the underlying infrastructure of the VM, application details, and actions that are carried out on a blueprint until the termination of the application on a GCP platform.

Before you begin

Ensure that you complete the pre-configuration requirements. See Creating a Multi-VM Blueprint.
Ensure that you have created a project and configured an environment for AWS. For more information, see Creating a Project and Configuring GCP Environment.

Procedure

Perform the basic blueprint setup, and add a service. For more information, see Adding a Service.

Figure. Blueprint Configuration Click to enlarge
Enter a name of the service in the Service Name field.
On the VM tab, enter the name of the VM in the Name field.
Select a GCP account from the Account list.

Note: The account options depend on the selected project while setting up the blueprint.
Select Windows or Linux from the Operating System list.
(Optional) If you have configured an environment during the project creation, then click Clone from environment to autofill the VM configuration details.
The Clone from environment option appears only when you select a specific environment you configured for the account from the Environment list in the application profile. The option does not appear if you select All Project Accounts as your environment.

You can also click the View Configuration option to review the configuration details before cloning the environment.
(Optional) Edit the VM name in the Instance Name field.
This field is pre-populated with a macro as suffix to ensure name uniqueness. The service provider uses this name as the VM name.
Select a zone from the Zone list.
A zone is a physical location where you can host the VM.
Select the type of machine from the Machine type list.
The machine types are available based on your zone. A machine type is a set of virtualized hardware resources available to a virtual machine (VM) instance, including the system memory size, virtual CPU (vCPU) count, and persistent disk limits. In Compute Engine, machine types are grouped and curated by families for different workloads.
Under the DISKS section, click the + icon to add a disk.
You can also mark the added vDisks runtime editable so you can add, delete, or edit the vDisks while launching the blueprint. For more information about runtime editable attributes, see Runtime Variables Overview.
To use an existing disk configuration, select the Use existing disk check box, and then select the persistent disk from the Disk list.
If you have not selected the Use existing disk check box, then do the following:
1. Select the type of storage from the Storage Type list. The available options are as follows.
  - pd-balanced : Use this option as an alternative to SSD persistent disks with a balanced performance and cost.
  - pd-extreme : Use this option to use SSD drives for high-end database workloads. This option has higher maximum IOPS and throughput and allows you to provision IOPS and capacity separately.
  - pd-ssd : Use this option to use SSD drives as your persistent disk.
  - pd-standard : Use this option to use HDD drives as your persistent disk.
  The persistent disk types are durable network storage devices that your instances can access like physical disks in a desktop or a server. The data on each disk is distributed across several physical disks.
2. Select the image source from the Source Image list.
  The images available for your selection are based on the selected zone.
3. Enter the size of the disk in GB in the Size in GB field.
4. To delete the disk configuration after the instance is deleted, select the Delete when instance is deleted check box under the Disks section.
To add a blank disk, click the + icon under the Blank Disks section and configure the blank disk.
To add networking details to the VM, click the + icon under the Networking section.
To configure a public IP address, select the Associate Public IP address check box and configure the following fields.
1. Select the network from the Network list and the sub network from the Subnetwork list.
2. Enter a name of the network in the Access configuration Name field and select the access configuration type from the Access configuration type list.
  These fields appear when you select the Associate public IP Address check box.
To configure a private IP address, clear the Associate Public IP address check box and select the network and sub network.
Under the SSH Key section, click the + icon and enter or upload the username key data in the Username field.
Select Block project-wide SSH Keys to enable blocking project-wide SSH keys.
Under the Management section, do the following:
1. Enter the metadata in the Metadata field.
2. Select the security group from the Network Tags list.
  Network tags are text attributes you can add to VM instances. These tags allow you to make firewall rules and routes applicable to specific VM instances.
3. Enter the key-value pair in the Labels field.
  A label is a key-value pair that helps you organize the VMs created with GCP as the provider. You can attach a label to each resource, then filter the resources based on their labels.
Under the API Access section, do the following:
1. Specify the service account in the Service Account field.
2. Under Scopes, select Default Access or Full Access .
Configure the connection in your blueprint. For more information, see Configuring Check Log-In.
On the Package tab, enter the package name in the Name field.
1. Click one of the following:
  - Configure install : To create a task to install a package.
  - Configure uninstall : To create a task to uninstall a package.
2. In the Blueprint Canvas, click + Task .
  
  Figure. Package Click to enlarge
3. Enter the task name in the Task Name field.
To create a task, select the type of task from the Type list.
The available options are:
- Execute : To create the Execute task type, see Creating an Execute Task.
- Set Variable : To create the Set Variable task type, see Creating a Set Variable Task.
- HTTP : To create the HTTP Task type, see Creating an HTTP Task.
- Delay : To create the Delay task type, see Creating a Delay Task.
For Execute and Set Variable tasks, you can use endpoints as targets for script execution. For more information, see Endpoints Overview.
To reuse a task from the task library, do the following.
1. Click Browse Library .
2. Select the task from the task library.
  When you select a task, the task inspector panel displays the selected task details.
3. Click Select .
4. Optionally, edit the variable or macro names as per your blueprint.
  The variable or macro names used in the task can be generic, you can update them with corresponding variable or macro names as per your blueprint.
5. To update the variable or macro names, click Apply .
6. To copy the task, click Copy .
On the Service tab, configure the following.
1. In the Deployment Config pane, enter the number of default, minimum and maximum service replicas that you want to create in the Default , Min , and Max fields respectively.
  The Min and Max fields define the scale-in and scale-out actions. The scale-in and scale-out actions cannot scale beyond the defined minimum and maximum numbers. The default field defines the number of default replicas the service creates.
  
  If there is an array of three VMs, define the minimum number as three.
2. In the Variables section, click the + icon to add variable types to your blueprint.
3. In the Name field, enter a name for the variable.
4. From the Data Type list, select one of the base type variable or import a custom library variable type.
5. If you have selected a base type variable, configure all the variable parameters. For more information about configuring variable parameters, see Creating Variable Types.
6. If you have imported a custom variable type, all the variable parameters are auto filled.
7. Select the Secret check box if you want to hide the value of the variable.
Add credentials to the blueprint. For more information, see Adding Credentials.
Click Save on the Blueprint Editor page.
The blueprint is saved and listed under blueprints tab.

What to do next

Define the service dependencies. See Setting up the Service Dependencies.

Configuring Azure VM, Package, and Service

You can define the underlying infrastructure of the VM, application details, and actions that are carried out on a blueprint until the termination of the application on an Azure platform.

Before you begin

Ensure that you have configured the following entities in the Azure account.
- Resource Group
- Availability set
- Network Security Group
- Virtual Network
- Vault Certificates
Ensure that you complete the pre-configuration requirements. See Creating a Multi-VM Blueprint.
Ensure that you have created a project and configured an environment for Azure. For more information, see Creating a Project and Configuring Azure Environment.

Procedure

Perform the basic blueprint setup, and add a service. For more information, see Adding a Service.

Figure. Blueprint Configuration Click to enlarge
Enter a name of the service in the Service Name field.
Under the VM tab, enter the name of the VM in the Name field.
Select Azure from the Account list.

Note: The account options depend on the selected project while creating the blueprint.
Select Windows or Linux from the Operating System list.
(Optional) If you have configured an environment during the project creation, then click Clone from environment to autofill the VM configuration details.
The Clone from environment option appears only when you select a specific environment you configured for the account from the Environment list in the application profile. The option does not appear if you select All Project Accounts as your environment.

You can also click the View Configuration option to review the configuration details before cloning the environment.
Edit the VM name in the Instance Name field.
This field is pre-populated with a macro as suffix to ensure name uniqueness. The service provider uses this name as the VM name.
Select a resource group from the Resource Group list or select the Create Resource Group check box to create a resource group.
Each resource in Azure must belong to a resource group. A resource group is simply a logical construct that groups multiple resources together so you can manage the resources as a single entity. For example, you can create or delete resources as a group that share a similar life cycle, such as the resources for an n-tier application.

The Resource Group list displays the resource groups that are associated with the subscriptions you selected in your Azure account. In case you have not selected any subscriptions, Calm considers all the subscriptions that are available in the Azure service principal to display the resource groups. Each resource group in the list also displays the associated subscription.
If you selected a resource group from the Resource Group list, then do the following:
1. Select the geographical location of the datacenter from the Location list.
2. Select Availability Sets or Availability Zones from the Availability Option list.
  You can then select an availability set or availability zone. An availability set is a logical grouping capability to ensure that the VM resources are isolated from each other to provide High Availability if deployed within an Azure datacenter. An availability zone allows you to deploy your VM into different datacenters within the same region.
3. Select the hardware profile as per your hardware requirements from the Hardware Profile list.
  The number of data disks and NICs depends upon the selected hardware profile. For information about the sizes of Windows and Linux VMs, see Windows and Linux Documentation.
If you selected the Create Resource Group check box to create a resource group, then do the following:
1. Select a subscription associated to your Azure account in the Subscription field.
2. Enter a unique name for the resource group in the Name field.
3. Select the geographical location of the datacenter that you want to add to the resource group in the Location list.
4. Under Tags , enter a key and value pair in the Key and Value fields respectively.
  Tags are key and value pairs that enable you to categorize resources. You can apply a tag to multiple resource groups.
5. If you want to automatically delete a resource group that has empty resources while deleting an application, click the Delete Empty Resource Group check box.
6. Specify the location and hardware profile.
Under the Secrets section, click the + icon and do the following:
1. Enter a unique vault ID in the Vault ID field.
2. Under Certificates , click the + icon.
3. Enter the URL of the configuration certificate in the URL field.
  The URL of the certificate is uploaded to the key vault as a secret.
4. Enter store in the Store field.
  - For Windows VMs, the Store field specifies the certificate store on the virtual machine to which the certificate is added. The specified certificate store is implicitly created in the LocalMachine account.
  - For Linux VMs, the certificate file is placed under the /var/lib/waagent directory. The format of the file name is <UppercaseThumbprint>.crt for the X509 certificate and <UppercaseThumbpring>.prv for private key. Both of these files are .pem formatted.
(For Windows) Select the Provision Windows Guest Agent check box.
This option indicates whether or not to provision the virtual machine agent on the virtual machine. When this property is not specified in the request body, the default behavior is to set it to true. This ensures that the VM Agent is installed on the VM, and the extensions can be added to the VM later.
(For Windows) To indicate that the VM is enabled for automatic updates, select the Automatic OS Upgrades check box.
Under the Additional Unattended Content section, click the + icon and do the following:
1. Select a setting from the Setting Name list.
  You can select Auto Logon or First Logon Commands .
  Note: Guest customization is applicable only on images that allows or support guest customization.
2. Enter or upload the xml content. See Sample Auto Logon and First Logon Scripts.
Under the WinRM Listeners section, click the + icon and do the following:
1. Select the protocol from the Protocol list.
  You can select HTTP or HTTPS .
2. If you selected HTTPS, then select the certificate URL from the Certificate URL list.
Under the Storage Profile section, select the Use Custom Image check box to use a custom VM image created in your subscription.
You can then select a custom image or publisher-offer-SKU-version from the Custom Image list.
Under the VM Image Details section, select an image type in the Source Image Type list.
You can select Marketplace , Subscription , or Shared Image Gallery .
- If you selected Marketplace , then specify the publisher, offer, SKU, and version for the image.
- If you selected Subscription , then select the custom image.
- If you selected Shared Image Gallery , then select the gallery and the image.
Under the OS Disk Details section, do the following:
1. Select the storage type from the Storage Type list.
  You can select Standard HDD , Standard SSD , or Premium SSD .
2. Select a disk storage account from the Disk Storage list.
  This field is available only when the Use Custom Image check box is enabled.
3. Select disk caching type from the Disk Caching Type list.
  You can select None , Read-only , or Read write .
4. Select disk create option from the Disk Create Option list.
  You can select Attach , Empty , or From Image .
Under the Data Disk section, do the following:
1. Select the storage type from the Storage Type list.
  You can select Standard HDD , Standard SSD , or Premium SSD .
2. Select disk caching type from the Disk Caching Type list.
  You can select None , Read-only , or Read write .
3. Enter the size in GB in the Size field.
4. Enter disk logical unit number (LUN) in the Disk LUN field.
  
  Note: The LUN value should be unique across data disk list.
Under the Network Profile section, add NICs as per your requirement and do the following for each NIC:
1. Select a security group from the Security Group list.
2. Select a virtual network from the Virtual Network list.
3. Under Public IP Config , enter a name and select an allocation method.
4. Under Private IP Config , select an allocation method.
  If you selected Static as the allocation method, then enter the private IP address in the IP Address field.
Optionally, enter tags in the Tags field.
Configure the connection in your blueprint. For more information, see Configuring Check Log-In.
On the Package tab, enter the package name in the Name field.
1. Click one of the following:
  - Configure install : To create a task to install a package.
  - Configure uninstall : To create a task to uninstall a package.
2. In the Blueprint Canvas, click + Task .
  
  Figure. Package Click to enlarge
3. Enter the task name in the Task Name field.
To create a task, select the type of task from the Type list.
The available options are:
- Execute : To create the execute type of task, see Creating an Execute Task.
- Set Variable : To create the set variable type of task, see Creating a Set Variable Task.
- HTTP : To create the HTTP Task type, see Creating an HTTP Task.
- Delay : To create the Delay task type, see Creating a Delay Task.
For Execute and Set Variable tasks, you can use endpoints as targets for script execution. For more information, see Endpoints Overview.
Select the script from the Script Type list.
For shell, PowerShell, and eScript scripts, you can access the available list of macros by using @@{ .

Note: Azure library SDK support is available for eScripts.
To reuse a task from the library do the following.
1. Click Browse Library .
2. Select the task from the library.
  When you select a task, the task inspector panel displays the selected task details.
3. Click Select .
4. Optionally, edit the variable or macro names as per your blueprint.
  The variable or macro names used in the task can be generic, you can update them with corresponding variable or macro names as per your blueprint.
5. Click Apply to update the variable or macro names.
6. Click Copy to copy the task.
On the Service tab, configure the following.
1. In the Deployment Config pane, enter the number of default, minimum and maximum service replicas that you want to create in the Default , Min , and Max fields respectively.
  The Min and Max fields define the scale-in and scale-out actions. The scale-in and scale-out actions cannot scale beyond the defined minimum and maximum numbers. The default field defines the number of default replicas the service creates.
  
  If there is an array of three VMs, define the minimum number as three.
2. In the Variables section, click the + icon to add variable types to your blueprint.
3. In the Name field, enter a name for the variable.
4. From the Data Type list, select one of the base type variables or import a custom library variable type.
5. If you have selected a base type variable, configure all the variable parameters. For more information about configuring variable parameters, see Creating Variable Types.
6. If you have imported a custom variable type, all the variable parameters are automatically filled.
7. Select the Secret check box if you want to hide the value of the variable.
8. In the Port List pane, enter the name, protocol, and port number in the Name , Protocol , and Port fields.
Add credentials to the blueprint. For more information, see Adding Credentials.
Click Save on the Blueprint Editor page.
The blueprint is saved and listed under blueprints tab.

What to do next

Define the service dependencies. See Setting up the Service Dependencies.

Azure Troubleshooting

The following section describes Azure troubleshooting.

For settings save or verification failure, you can check the logs at the following location.
/home/calm/log/styx.log
For application blueprints save failure, you can check the logs at the following locations.
- /home/calm/log/hercules_*.log
- /home/calm/log/styx.log
For provisioning failure, you can check the logs at the following locations.
- Task logs on UI
- /home/epsilon/log/indra_*.log [Signature: Encountered ERROR]
- /home/epsilon/log/durga_*.log
- /home/epsilon/log/arjun_*.log
- /home/calm/log/hercules_*.log
- /home/calm/log/styx.log

Configuring Xi VM, Package, and Service

You can define the underlying infrastructure of the VM, application details, and actions that are carried out on a blueprint until the termination of the application on Xi cloud provider.

Before you begin

Ensure that you have configured DNS in the VPC section in the Xi Cloud dashboard in the Prism Central.

Procedure

Perform the basic blueprint setup, and add a service. For more information, see Adding a Service.
Enter a name of the service in the Service Name field.
On the VM tab, enter the name of the VM in the Name field.
Select Xi from the Account list.

Note: The account options depend on the project you selected while setting up the blueprint.

The Availability Zone field is automatically filled.
Select Windows or Linux from the Operating System list.
Under VM Configuration , enter the instance name of the VM in the VM Name field. This field displays the macro as suffix to ensure name uniqueness.
The service provider uses this name as the VM name.
In the vCPUs field, enter the required number of vCPUs for the VM.
In the Cores per vCPU field, enter the number of cores per vCPU for the VM.
In the Memory field, enter the required memory in GiB for the VM.
(Optional) If you want to customize the default OS properties of the VM, select the Guest Customization check box and do the following.
Guest customization allows you to upload custom scripts to modify the properties of the OS of the VM.
1. Select Cloud-init or SysPrep type and enter the script in the Script panel.
  Note:
  - Select Cloud-init for Linux and Sysprep for Windows. For Sysprep, you must use double back slash for all escape characters . For example, \\v.
  - You can also upload the script by clicking the upload icon.
2. For Sysprep script, click Join a Domain check box and configure the following fields.
  - Domain Name : Enter the domain name of the Windows server.
  - Credentials : From the Credentials list, enter a credential for the Windows VM. You can also create new credentials. For more information, see step 22.
  - DNS IP : Enter the IP address of the DNS server.
  - DNS Search Path : Enter the DNS search path for the domain.
To add a vDisk, click + vDisks and do the following.
1. Select the device type from the Device Type list.
  You can select CD-ROM or Disk .
2. Select the device bus from the Device Bus list.
  You can select IDE or SATA for CD-ROM .
  
  You can select SCSI , IDE , PCI , or SATA for Disk .
3. Enter the size of the vDisk in GiB.
You can also make the vDisks as runtime editable. If you have marked the vDisk attribute as runtime editable, you can add, delete, or edit vDisks while launching the blueprint. For more information about runtime editable attributes, see Runtime Variables Overview.
Select categories from the Categories list.

Note: Categories field allows you to tag your VM to a defined category in the Prism Central. Based on the Prism Central configuration, the list options are available.
Under Network , select the VPC from the VPC list. For more information about VPC, see Xi Infrastructure Service Admininistration Guide.
Configure the connection in your blueprint. For more information, see Configuring Check Log-In.
Under the Package tab, enter the package name in the Name field.
1. Click one of the following:
  - Configure install : To create a task to install a package.
  - Configure uninstall : To create a task to uninstall a package.
2. In the Blueprint Canvas, click + Task .
  
  Figure. Package Click to enlarge
3. Enter the task name in the Task Name field.
If you want to create a task, select the type of task from the Type list.
The available options are:
- Execute : To create the Execute task type, see Creating an Execute Task.
- Set Variable : To create the Set Variable task type, see Creating a Set Variable Task.
- HTTP : To create the HTTP Task type, see Creating an HTTP Task.
- Delay : To create the Delay task type, see Creating a Delay Task.
(Optional) To reuse a task from the task library, do the following.
1. Click Browse Library .
2. Select the task from the task library.
  When you select a task, the task inspector panel displays the selected task details.
3. Click Select .
4. (Optional) Edit the variable or macro names as per your blueprint.
  The variable or macro names used in the task can be generic, you can update them with corresponding variable or macro names as per your blueprint.
5. To update the variable or macro names, click Apply .
6. To copy the task, click Copy .
On the Service tab, configure the following.
1. In the Deployment Config pane, enter the number of default, minimum and maximum service replicas that you want to create in the Default , Min , and Max fields respectively.
  The Min and Max fields define the scale-in and scale-out actions. The scale-in and scale-out actions cannot scale beyond the defined minimum and maximum numbers. The default field defines the number of default replicas the service creates.
  
  If there is an array of three VMs, define the minimum number as three.
2. In the Variables section, click the + icon to add variable types to your blueprint.
3. In the Name field, enter a name for the variable.
4. From the Data Type list, select one of the base type variables or import a custom library variable type.
5. If you have selected a base type variable, configure all the variable parameters. For more information about configuring variable parameters, see Creating Variable Types.
6. If you have imported a custom variable type, all the variable parameters are auto filled.
7. Select the Secret check box if you want to hide the value of the variable.
Click Save on the Blueprint Editor page.
The blueprint is saved and listed under blueprints tab.

Configuring Kubernetes Deployment, Containers, and Service

Perform the following procedure to configure Kubernetes Deployment, Containers, and Service.

Before you begin

Ensure that you have completed the pre-configuration requirements. See Creating a Multi-VM Blueprint.
Ensure that the selected project has Kubernetes or GCP with GKE enabled or both as part of it.
Refer Kubernetes Documentation to get detailed information about the kubernetes attributes and configuration.

Procedure

To add a service to the blueprint, see Adding a Service.
To add a Pod, click + against the Pod .

A Pod is the basic execution unit of a Kubernetes application and the smallest and simplest unit in the Kubernetes object model that you create or deploy. A Pod represents processes running on your cluster.

The Pod service inspector panel appears.
Enter a name of the pod in the Pod Name field.
Under the Deployment tab, select the account from the Account list. All the accounts added to the project are available for selection.
Optionally, edit the Calm deployment name in the Calm Deployment Name field.
This filed is auto-populated.
Optionally, edit the K8s deployment name in the K8s Deployment Name field.
This filed is automatically populated.
Enter namespace in the Namespace field.
Namespace is a kubernetes field to use in environments with many users spread across multiple teams, or projects.
Enter the number of replicas in the Replica field.
Optionally, enter annotations in the Annotations field.
You can use kubernetes annotations to attach arbitrary non-identifying metadata to objects.
Enter selector in the Selectors field.
The selector field defines how the Deployment finds which pods to manage.
Enter label in the Label field.

Labels are key/value pairs that are attached to objects, such as pods. You can use Labels to specify identifying attributes of objects that are meaningful and relevant to users, but do not directly imply semantics to the core system. You can also use Labels to organize and to select subsets of objects. You can attach Labels to objects either at the creation time or later. Each object can have a set of key/value labels defined. Each key must be unique for a given object.
Optionally, you can edit the pod name in the K8s Pod Name field.
This field is auto-populated.
Enter value of image pull secrets in the Image Pull Secrets field.
You can provide the list of secret names (pre-configured in a Kubernetes cluster by using Kubernetes Docker secret object) to be use by Kubernetes cluster to pull the container images from registries that require authentication.
Select DNS policy from the DNS Policy list.
Under Containers tab, optionally edit the Calm service name in the Calm Service Name field.
Optionally, you can edit the K8s service name in the K8s Service Name field.
This field is auto-populated.
Enter arguments for the container in the Args field.
Enter Docker image in the Image field.
Select a value from the Image Pull Policy .
You can either select Never or Always or IfNotPresent (default).
Under Pre Stop Lifecycle , select an action.
You can select None (default) or Exec or HTTP Get Action or TCP Socket .

This hook is called immediately before a container is terminated. It is blocking, meaning it is synchronous, so it must complete before the call to delete the container can be sent. No parameters are passed to the handler.
Under Post Stop Lifecycle , select an action.
You can select None (default) or Exec or HTTP Get Action or TCP Socket .

This hook runs immediately after a container is created. However, there is no guarantee that the hook runs before the container ENTRYPOINT. No parameters are passed to the handler.
Under Container Port , enter the port number in the Port field.
1. Enter name of the port in the Name field.
2. Select protocol from the Protocol list.
  You can either select TCP or UDP .
Under Readiness Probe , enter command in the Command field.
The kubelet uses readiness probes to know when a Container is ready to start accepting traffic. A pod is ready after all of its Containers are ready. One use of this signal is to control the pods used as backends for Services. When a pod is not ready, it is removed from Service load balancers.
Under Resource Limit , enter the cores per CPU in the CPU field.
When you specify a pod, you can optionally specify how much CPU and memory (RAM) each Container needs. CPU and memory are each a resource type. A resource type has a base unit. You can specify CPU in units of cores and memory in bytes.
1. Enter the bytes of memory in the Memory field.
Under Resource Request , enter the termination message path in the Termination Message Path field.
Termination messages provide a way for containers to write information about fatal events to a location where you can easily retrieve and surface these events by tools like dashboards and monitoring software.
Under Service tab, optionally you can edit the Calm Published Service Name field.
Optionally, you can edit the K8s Service Name field.
Select a service type from the Service Type list. You can select one of the following.
- ClusterIP : Exposes the service on a cluster-internal IP. Choosing this value makes the Service only reachable from within the cluster.
- NodePort : Exposes the service on each node's IP at a static port (the NodePort ). A ClusterIP Service, to which the NodePort Service routes, is automatically created. You'll be able to contact the NodePort Service, from outside the cluster, by requesting <NodeIP>:<NodePort> .
- LoadBalancer : Exposes the service externally using a cloud provider's load balancer. NodePort and ClusterIP Services, to which the external load balancer routes, are automatically created.
Enter namespace in the Namespace field.
You can use Namespaces in environments with many users spread across multiple teams, or projects.
Enter label in the Label field.

Labels are key/value pairs that are attached to objects, such as pods. You can use Labels to specify identifying attributes of objects that are meaningful and relevant, but do not directly imply semantics to the core system. You can also use Labels to organize and select subsets of objects. You can attach Labels to objects at creation time and add or modify at any time. Each object can have a set of key/value labels defined. Each key must be unique for a given object.
Enter selector in the Selectors field.
The selector field defines how the Deployment finds which pods to manage.
Under Port List , enter the port name in the Port Name field.
1. Enter node port in the Node Port field.
2. Enter port number in the Port field.
3. Select protocol from the Protocol list.
  You can either select TCP or UDP .
4. Enter the target port in the Target Port field.
To upload the POD specification file in .JSON or .YAML format from your local machine, click against the icon next to the Pod Name field and upload the specification file.
You can also download the POD specification file in .JSON or .YAML format.
To edit the uploaded POD specification, click the Spec Editor toggle button and click Edit .
The Script Editor page is displayed. You can edit the specification file in .YAML or .JSON format.
To save the edited POD specification file, click Done .
Click Save .
The blueprint is saved and listed under blueprints tab.

What to do next

Define the service dependencies. See Setting up the Service Dependencies.

Setting up the Service Dependencies

Dependencies are used to define the order in which tasks must get executed. Perform the following procedure to set up the service dependency.

Before you begin

Ensure that at least more than one service must be available. See Adding a Service.
Ensure that you have completed the pre-configuration requirements. See Creating a Multi-VM Blueprint.

Procedure

Select the service.
Select the dependency icon and drag to the service on which you want to create the dependency.

Figure. Create Dependency Click to enlarge

What to do next

Configure the application profile. See Adding and Configuring an Application Profile.

Adding and Configuring an Application Profile

An application profile provides different combinations of the service, package, and VM while configuring a blueprint. You configure application profiles and use them while launching a blueprint.

Before you begin

Ensure that you have completed the pre-configuration requirements. See Creating a Multi-VM Blueprint.

Procedure

To create an application profile, click the + icon next to Application Profile in the Overview Panel.

Figure. Application Profile Click to enlarge
In the Inspector Panel, enter the name of the application profile in the Application Profile Name field.
Optionally, select an environment for the application profile from the Environment list.
The environment available for the selection in the Environment list depends on the project you selected in the Blueprint Setup window. If you selected a default environment while configuring your environments for the project, the default environment automatically appears in the Environment list. You can select a different environment if required.
Click the + icon next to Variables .
Enter a name for the variable in the Name field.
Select a data type from the Data Type list. You can select one of the following data type:
- String
- Integer
- Multi-line string
- Date
- Time
- Date Time
Enter a value for the selected data type in the Value field.
You can select the Secret check box to hide the variable value.
Click Show Additional Options .
In the Input Type field, select one of the following input type:
- Simple: Use this option for default value.
- Predefined: Use this option to assign static values.
- eScript: Use this option to attach a script that is run to retrieve values dynamically at runtime. Script can return single or multiple values depending on the selected base data type.
- HTTP: Use this option to retrieve values dynamically from the defined HTTP end point. Result is processed and assigned to the variable based on the selected base data type.
If you have selected Simple , enter the value for the variable in the Value field.
If you have selected Predefined , enter the value for the variable in the Option field.
1. To add multiple values for the variable, click + Add Option , and enter values in the Option field.
  
  Note: To make any value as default, select the Default radio button for the option.
If you have selected eScript , enter the eScript in the field.
You can also upload the script from the library or from the computer by clicking the upload icon.

You can also publish the script to the library by clicking the publish button.
Note:
- You cannot add macros to eScripts.
- If you have selected Multiple Input (Array) check box with input type as eScript, then ensure that the script returns a list of values separated by comma. For example, CentOS, Ubuntu, Windows.
If you have selected HTTP , configure the following fields.
- Request URL : In the Request URL field, enter the URL of the server that you want to run the methods on.
- Request Method : In the Request Method list, select one of the following request methods. The available options are GET, PUT, POST, and DELETE.
- Request Body : In the Request Body field, enter the PUT request. You can also upload the PUT request by clicking the upload icon.
- Content Type : In the Content Type list, select the type of the output format. The available options are XML , JSON, and HTML.
- Connection Timeout (sec) : In the Connection Timeout (sec) field, enter the timeout interval in seconds.
- Authentication : Optionally, if you have selected authentication type as BASIC, enter the user name and the password in the User name and Password fields respectively.
- SSL Certificate Verification : If you want to verify SSL certificate for the task, click the SSL Cerificate Verification field.
- Retry Count : Enter the number of attempts the system performs to create a task after each failure. By default, the retry count is zero. It implies that the task creation procedure stops after the first attempt.
- Retry Interval : Enter the time interval in seconds for each retry if the task fails.
- Headers : In the Header area, enter the HTTP header key and value in the Key and Value fields respectively. If you want to publish the HTTP header key and value pair as secret, click the Secrets fields.
- Response Code : Enter the response code for the selected response status.
- Response Status : Select either Success or Failure as the response status for the task.
- Set Response Path for Variable : Enter the variables from the specified response path. The example of json format is $.x.y and xml format is //x/y. For example, if the response path for variable is $.[*].display for response.
```
[
    {
        "display": "HTML Tutorial",
        "url": "https://www.w3schools.com/html/default.asp"
    },
    {
        "display": "CSS Tutorial",
        "url": "https://www.w3schools.com/css/default.asp"
    },
    {
        "display": "JavaScript Tutorial",
        "url": "https://www.w3schools.com/js/default.asp"
    },
    {
        "display": "jQuery Tutorial",
        "url": "https://www.w3schools.com/jquery/default.asp"
    },
    {
        "display": "SQL Tutorial",
        "url": "https://www.w3schools.com/sql/default.asp"
    },
    {
        "display": "PHP Tutorial",
        "url": "https://www.w3schools.com/php/default.asp"
    },
    {
        "display": "XML Tutorial",
        "url": "https://www.w3schools.com/xml/default.asp"
    }
]
```
  Then, during the launch time the list options are ["HTML Tutorial","CSS Tutorial","JavaScript Tutorial","jQuery Tutorial","SQL Tutorial","PHP Tutorial","XML Tutorial"].
Optionally, enter a label and description for the variable.
Optionally, do the following:
- Mark this variable private : Select this to make the variable private. Private variables are not shown at luanch or in the application.
- Mark this variable mandatory : Select this to make the variable a requisite for application launch.
- Validate with Regular Expression : Select this if you want to test the Regex values. Click Test Regex , provide the value for the Regex, and test or save the Regex. You can enter Regex values in PCRE format. For more details, see from http://pcre.org/.
Click Save on the Blueprint Editor page.

What to do next

After you added the application profile and its variables, you can create actions in the profile. For more information, see Adding an Action to a Multi-VM Blueprint.

Blueprint Configurations in Calm

Blueprint configuration involves adding tasks, actions, snapshot and restore configurations, and VM update configurations.

Configuring a Blueprint

Perform the following procedure to configure a blueprint.

Procedure

Click the Blueprint icon in the left pane.
The Blueprint page displays the list of all the available blueprints.
Click the blueprint that you want to configure.
The blueprint editor page is displayed.
Click Configuration .
The Blueprint Configuration window is displayed.
In the Blueprint Name field, enter a name of the blueprint.
In the Blueprint Description field, enter a brief description about the blueprint.
Click + against the Downloadable Image Configuration field and configure the following:
1. In the Package Name field, enter the name of the package.
2. In the Description field, enter a brief description about the package.
3. In the Image Name field, enter the name of the image.
4. In the Image Type list, select the type of image.
5. In the Architecture list, select the architecture.
6. In the Source URI field, enter the source URI to download the image.
In the Product Name field, enter the name of the product.
In the Product Version field, enter the version of the product.
Click one of the following:
- To save the configuration, click Save .
- To go back to the previous screen, click Back .

Adding Credentials

Credentials are used to authenticate a user to access various services in Calm. Calm supports static and dynamic credentials with key-based and password-based authentication methods.

Procedure

To add a credential, do one of the following:
- To add a credential in a single-VM blueprint, click Add/Edit Credentials on the Advanced Options tab and then click + Add Credentials .
- To add a credential in a multi-VM blueprint or a brownfield application, click Credentials on the Blueprint Editor page and then click Credentials + .
- To add a credential in a task, click Add New Credential in the Credential list.
In the Name field, type a name for the credential.
Under the Type section, select the type of credential that you want to add.
- Static : Credentials store keys and passwords in the credential objects that are contained in the blueprints.
- Dynamic : Credentials fetch keys and passwords from an external credential store that you integrate with Calm as the credential provider.
In the Username field, type the user name.
For dynamic credentials, specify the @@(username)@@ that you defined while configuring the credential provider.

Note: A dynamic credential provider definition requires username and secret. The secret variable is defined by default when you configure your credential provider. However, you must configure a runbook in the dynamic credential provider definition for the username variable before you use the variable in different entities.
Select either Password or SSH Private Key as the secret type.
Do one of the following to configure the secret type.
- If you selected Static as the credential type and Password as the secret type, then type the password in the Password field.
- If you selected Static as the credential type and SSH Private Key as the secret type, then enter or upload the key in the SSH Private Key field.
- If you selected Dynamic as the credential type and Password or SSH Private Key as the secret type, then select a credential provider in the Provider field. After you select the provider, verify or edit the attributes defined for the credential provider.
If the private key is password protected, click +Add Passphrase to provide the passphrase. For dynamic credentials, you must configure a runbook in the dynamic credential provider definition for the passphrase variable and then use the @@{passphrase}@@ variable.

The type of SSH key supported is RSA. For information on how to generate a private key, see Generating SSH Key on a Linux VM or Generating SSH Key on a Windows VM.
If you want this credential as your default credential, select the Use as default check box.
Click Done to add the credential.

Configuring Check Log-In

You configure a check log-in task to check whether you are able to SSH into the VM you create. Perform the following steps to configure check log-in.

Procedure

Under Connection , select the Check log-in upon create check box to check the log on status after creating the VM.
In the Credential list, select Add New Credential to add a new credential and do the following:
1. Enter a name for the credential in the Name field.
2. Select the type of credential you want to add under the Type section. Your options are:
  - Static : Credentials store keys and passwords in the credential objects that are contained in the blueprints.
  - Dynamic : Credentials fetch keys and passwords from an external credential store that you integrate with Calm as the credential provider.
3. Enter the user name in the Username field.
  For dynamic credentials, specify the @@(username)@@ that you defined while configuring the credential provider.
  
  Note: A dynamic credential provider definition requires username and secret. The secret variable is defined by default when you configure your credential provider. However, you must configure a runbook in the dynamic credential provider definition for the username variable to use in different entities.
4. Select either Password or SSH Private Key as the secret type.
5. Do one of the following to configure the secret type.
  - If you selected Static as the credential type and Password as the secret type, then type the password in the Password field.
  - If you selected Static as the credential type and SSH Private Key as the secret type, then enter or upload the key in the SSH Private Key field.
  - If you selected Dynamic as the credential type and Password or SSH Private Key as the secret type, then select a credential provider in the Provider field. After you select the provider, verify or edit the attributes defined for the credential provider.
  If the private key is password protected, click +Add Passphrase to provide the passphrase. For dynamic credentials, you must configure a runbook in the dynamic credential provider definition for the passphrase variable and then use the @@{passphrase}@@ variable.
  
  The type of SSH key supported is RSA. For information on how to generate a private key, see Generating SSH Key on a Linux VM or Generating SSH Key on a Windows VM.
6. If you want this credential as your default credential, select the Use as default check box.
7. Click Done .
Select address from the Address list.

You can either select the public IP address or private IP address of a NIC.
Select the connection from the Connection Type list.
Select SSH for Linux or Windows (Powershell) for Windows.

If you selected Windows (Powershell) , then select the protocol from the Connection Protocol list. You can select HTTP or HTTPS .

The Connection Port field is automatically populated depending upon the selected Connection Type . For SSH, the connection port is 22 and for PowerShell the connection port is 5985 for HTTP and 5986 for HTTPS.
Enter the delay in seconds in the Delay field.

Delay timer defines the time period when the check login script is run after the VM starts. It allows you to configure the delay time to allow guest customization script, IP, and all other services to come up before running the check login script.
In the Retries field, enter the number of log-on attempts the system must perform after each log on failure.
To save the blueprint, click Save .

Tasks Overview

Tasks are part of your deployment creation process and are run one after the other. The tasks are used to perform a variety of operations such as setting up your environment, installing a set of software on your service, and so on.

You have the following basic types of tasks.

Execute: Used to run eScripts on a VM. For more information, see Creating an Execute Task.
Set variable: Used to change variables in a task. For more information, see Creating a Set Variable Task.
HTTP: Used to query REST calls from a URL. For more information, see Creating an HTTP Task.
Delay: Used to set a time interval between two tasks or actions. For more information, see Creating a Delay Task.

Pre-reate and Post-delete Tasks

Pre-create tasks are actions that are performed before a service is provisioned in a blueprint. For example, if you want to assign static IP addresses to your VMs by using IPAM service, you can create and run a pre-create task to receive the IP addresses before the service is provisioned. The pre-create task helps to restrict the broadcast traffic to receive the IP addresses for those VMs during the service provision.

Post-delete tasks are actions that are performed after you delete a service in a blueprint. For example, if you want to delete the assigned IP addresses from your VMs, you can add a post-delete task to delete the IP addresses after the service is deleted. The post-delete task helps to restrict the broadcast traffic to delete the IP addresses for those VMs during the service provision.

Creating an Execute Task

You can create the Execute task type to run scripts on the VM.

About this task

Use this procedure to create an Execute task.

Procedure

In the Script Type list, select one of the following:
- Shell
- EScript
- Powershell
For Shell, PowerShell, and eScript scripts, you can access the available list of macros by using @@{ .

Note: You can use macro expansions for variables used for eScripts.

For sample eScripts , see Supported eScript Modules and Functions. For sample Powershell scripts, see Sample Powershell Script.
If you have selected the script type as Shell or Powershell , do the following:
1. In the Endpoint list, select an endpoint for the task or click Add New Endpoint to create an endpoint. For more information about creating an endpoint, see Creating an Endpoint.
2. In the Credential list, select an existing credential or click Add New Credential to add a credential. For more information about adding a credential, see Adding Credentials.
3. Enter the install or uninstall script in the Script panel.
  For example, see Sample Scripts for Installing and Uninstalling Services.
  
  You can also upload a script by clicking the upload icon.
4. If you want to test the script in Calm playground, click Test Script .
  Calm playground allows you to test a script by running and reviewing the output and making required changes.
  
  The Test Script page is displayed.
5. On the Authorization tab, enter the following fields:
  - IP Address : Enter the IP address of the test machine.
  - Port : Enter the port number of the test machine.
  - Select tunnel to connect with (Optional) : Select the tunnel to get access to the VMs within the VPC.
  - Credential : Select the credential from the list.
  - User name : Enter a user name.
  - Password : Enter a password.
6. Click Login and Test .
  The Test script page is displayed.
  
  You can also view your script in the Source Script field.
7. (Optional) You can edit your script in the Source Script field.
8. If you are using macros in your script, provide the variable values in the macro inspector panel and click Assign and Test .
9. Click Test .
  The test result is displayed in the Output field.
10. To go back to the previous screen, click Done .
If you have selected the script type as EScript , do the following:
1. In the Select tunnel to connect with list, select a tunnel to access VMs in the VPC. This step is optional.
2. In the Script field, enter the script.
  You can also upload a script by clicking the upload icon.
3. Click Test Script .
  The Test EScript page is displayed.
  
  You can also view your script in the Source Script field.
4. If you are using macros in your script, provide the variable values in the macro inspector panel and click Assign and Test .
5. To test the script, click Test .
  The test result is displayed in the Output field.
6. To go back to the previous screen, click Done .
To publish this task to the task library, click Publish to Library .
The task is published to the Library and you can browse and use the task while creating a blueprint.

Creating a Set Variable Task

You can create a Set Variable task type to change variables in a blueprint.

About this task

Use this procedure to create a Set Variable task.

Procedure

In the Script Type list, select one of the following:
- Shell
- Powershell
- EScript
For Shell, Powershell, and EScript scripts, you can access the available list of macros by using @@{ .

For sample Escripts , see Supported eScript Modules and Functions. For sample Powershell scripts, see Sample Powershell Script.
If you have selected the script type as Shell or Powershell , do the following:
1. In the Endpoint list, select an endpoint for the task or click Add New Endpoint to create an endpoint. For more information about creating an endpoint, see Creating an Endpoint.
2. In the Credential list, select an existing credential or click Add New Credential to add a credential. For more information about adding a credential, see Adding Credentials.
If you have selected the script type as EScript , then select a tunnel to access VMs in the VPC in the Select tunnel to connect with list. This step is optional.
Enter the install or uninstall script in the Script panel.
For example, see Sample Scripts for Installing and Uninstalling Services.
In the Output field, enter the name of the variable that you have defined through the set variable task.
If you are setting multiple variables, enter the variable name for each of the variables by clicking the Output field.
To publish this task to the task library, click Publish to Library .
The task is published to the Library and you can browse and use the task while creating a blueprint.

Creating an HTTP Task

You can create an HTTP task type to query REST calls from a URL. An HTTP task supports GET, PUT, POST, and DELETE methods.

About this task

Note: You can use macro expansions for variables used in an HTTP task.

Procedure

In the Request URL field, enter the URL of the server that you want to run the methods on.
In the Select tunnel to connect with list, select a tunnel to access VMs in the Virtual Private Cloud (VPC). This step is optional.
In the Request Method list, select one of the following request methods.
- GET : Use this method to retrieve data from a specified resource.
- PUT : Use this method to send data to a server to update a resource. In the Request Body field, enter the PUT request. You can also upload the put request by clicking the upload icon.
- POST : Use this method to send data to a server to create a resource. In the Request Body field, enter the POST request. You can also upload the post request by clicking the upload icon.
- DELETE : Use this method to send data to a server to delete a resource. In the Request Body field, enter the DELETE request. You can also upload the delete request by clicking the upload icon.
In the Content Type list, select the type of the output format.
The available options are XML , JSON , and HTML .
In the Header area, enter the HTTP header key and value in the Key and Value fields respectively.
If you want to publish the HTTP header key and value pair as secret, click the Secrets fields.
In the Connection Time Out field, enter the timeout interval in seconds.
Optionally, in the Authentication field, select Basic and do the following:
1. In the Username field, enter the user name.
2. In the Password field, enter the password.
If you want to verify SSL certificate for the task, click the SSL Cerificate Verification field.
If you want to use a proxy server as configured in the Prism Central, click the Use PC Proxy configuration .

Note: Ensure that the Prism Central has the appropriate HTTP proxy configuration.
In the Retry Count field, enter the number of attempts the system performs to create a task after each failure.
By default, the retry count is zero. It implies that the task creation procedure stops after the first attempt.
In the Retry Interval field, enter the time interval in seconds for each retry if the task fails.
In the Expected Response Options area, enter the details for the following fields:
- Response Status : Select either Success or Failure as the response status for the task.
- Response Code : Enter the response code for the selected response status.
Note: If the response code is not defined, then by default all the 2xx response codes are marked as success and any other response codes are marked as failure.
- Set Variables from response : Enter the variables from the specified response path. The example of json format is $.x.y and xml format is //x/y . For more information about json path syntax, see http://jsonpath.com.
  Note: To retrieve the output format in HTML format, add a * in the syntax.
If you want to test the script in Calm playground, click Test script .
Calm playground allows you to test a script by running and reviewing the output and making required changes.

The Test Script page is displayed. You can also edit the fields described from step 1–11.
Click Test .
The test result is displayed in the Output field .
To publish this task to the task library, click Publish to Library .
The task is published to the Library and you can browse and use the task while creating a blueprint.

Creating a Delay Task

You can create a Delay task type to set a time interval between two tasks or actions.

Procedure

In the Sleep Interval field, enter the sleep time interval in seconds for the task.

The delay task type is created. You can use the task type to set a time interval between two tasks or actions.

Adding a Pre-create or Post-delete Task

Pre-create tasks are actions that are performed before a service is provisioned in a blueprint. Post-delete tasks are actions that are performed after you delete a service in a blueprint.

Procedure

In the Overview Panel, under the service in which you want to add the task, expand VM , and then click Pre-create or Post-delete .

Figure. Pre-create or Post-delete Task Click to enlarge
In the Blueprint Canvas, click + Task for the pre-create or post-delete.
In the Inspector Panel, do the following:
1. Enter the task name in the Task Name field.
2. Select the type of tasks from the Type list.
  - Execute : Use this task type to run eScripts on the VM. To create the Execute task type, see Creating an Execute Task.
  - Set Variable : Use this task to change variables in a blueprint. To create the Set Variable task type, see Creating a Set Variable Task.
  - HTTP : Use this task type to query REST calls from a URL. An HTTP task supports GET, PUT, POST, and DELETE methods. To create the HTTP type, see Creating an HTTP Task.
  - Delay : Use this task type to set a time interval between two tasks or actions. To create the Delay task type, see Creating a Delay Task.
3. To use tasks from the library, click Browse Library , select the task in the Browse Task from Library page, and click Select . This step is optional.
4. Click Publish to Library to publish the task you configured to your task library. This step is optional.
Click Save .

Actions Overview

Actions are flows to accomplish a particular task on your application. You can use actions to automate any process such as backup, upgrade, new user creation, or clean-up and enforce an order of operations across services.

You can categorize actions into the following types.

Table 1. Action Types
Type	Description
Profile Actions	Application Profile Actions are a set of operations that you can run on your application. For example, when you launch a blueprint, the Create action is run. When you do not need the application for a period of time, you can run the Stop action to gracefully stop your application. When you are ready to resume your work, you can run Start action to bring the application back to the running state. You have the following types of profile actions. System-defined Profile Actions These actions are automatically created by Calm in every blueprint and the underlying application. Because these actions are system-defined, a blueprint developer cannot directly edit the tasks or the order of tasks within the action. Custom Profile Actions These actions are created by the blueprint developer and are added whenever the developer needs to expose a set of operations to the application user. Common custom profile actions are Upgrade, Scale In, and Scale Out. In these actions, individual tasks can be manually added in the desired order by the developer.
Service Actions	Service Actions are a set of operations that are run on an individual service. These actions cannot be run directly by the application user but can be run indirectly using either a profile actions or a package install or uninstall operation. Services span application profiles. For example, if you create a service action in the AHV profile, the same service action is available in the AWS profile as well. You have the following types of service actions. System-defined Service Actions These actions are automatically created by Calm in every blueprint and the underlying application. These actions cannot be run individually and are run only when the corresponding profile action is run. For example, any operations within the Stop service action are run when an application user runs the Stop profile action. Custom Service Actions These actions are created by the blueprint developer for any repeatable operations within the blueprint. For example, if the App service should fetch new code from git during both the Create and Upgrade profile actions, the blueprint developer can create a single custom service action. The developer can then reference the action in both the Create and Upgrade actions rather than maintaining two separate tasks that perform the same set of operations.

Custom Actions

The following are the most common custom actions that developers add to their blueprints:

Table 2. Custom Actions
Custom Action	Description
Scale In	The scale-in functionality enables you to decrease the number of replicas of a service deployment. The number of instances to be removed from a service for each scale-in action is defined in the blueprint while configuring the task in the profile level action. The scale count number must be less than or equals to the minimum number of replicas defined for the service. The VM that is created last is deleted first. For information on how to configure scale in, see Adding and Configuring Scale Out and Scale In.
Scale Out	The scale out functionality enables you to increase the number of replicas of a service deployment. The number of instances to be added to a service for each scale-out action is defined in the blueprint while configuring the task in the profile level action. The scale count number must be less than or equals to the maximum number of replicas defined for the service. For information on how to configure scale out, see Adding and Configuring Scale Out and Scale In.

For information about how to create an action, see Adding an Action to a Multi-VM Blueprint and Adding an Action to a Single-VM Blueprint.

Adding an Action to a Single-VM Blueprint

An action is a set of operations that you can run on your application that are created as a result of running a blueprint.

Before you begin

Ensure that you set up your single-VM blueprint. For more information, see Setting up a Single-VM Blueprint.
Ensure that you added the VM details to your blueprint. For more information, see Adding VM Details to a Blueprint.
Ensure that you configured the VM in your blueprint. For more information, see VM Configuration.
Ensure that you added credentials to enable packages and actions. For more information, see Adding Credentials.

Procedure

To add an action, click the + Add action next to Actions .

Figure. Blueprint Action Click to enlarge
To change the action name, click the edit icon on the Tasks tab.

Figure. Add Action Click to enlarge
Click the + Add Task button.
In the Blueprint Canvas, select the task and do the following in the Inspector Panel.
1. Enter the name of the task in the Task Name field.
2. Select the type of the task from the Type list.
  - Execute : Use this task type to run eScripts on the VM. To create the Execute task type, see Creating an Execute Task.
  - Set Variable : Use this task to change variables in a blueprint. To create the Set Variable task type, see Creating a Set Variable Task.
  - HTTP : Use this task type to query REST calls from a URL. An HTTP task supports GET, PUT, POST, and DELETE methods. To create the HTTP type, see Creating an HTTP Task.
  - Delay : Use this task type to set a time interval between two tasks or actions. To create the Delay task type, see Creating a Delay Task.
3. (Optional) To use tasks from the library, click Browse Library , select the task in the Browse Task from Library page, and click Select .
4. (Optional) Click Publish to Library to publish the task you configured to your task library.
Click Done .

Adding an Action to a Multi-VM Blueprint

An action is a set of operations that you can run on your application that are created as a result of running a blueprint.

Before you begin

Ensure that you have at least one service available. See Adding a Service.
Ensure that you have completed the pre-configuration requirements. See Creating a Multi-VM Blueprint.

Procedure

To add an action, click the + icon next to Actions in the Overview Panel.

Figure. Blueprint Action Click to enlarge
In the Blueprint Canvas, select + Action for the service, and do the following in the Inspector Panel.
1. Enter the task name in the Task Name field.
2. Select the action from the Service Actions list.
3. Click Save .
In the Blueprint Canvas, select + Task and do the following in the Inspector Panel.

Figure. Task Click to enlarge
1. Enter the name of the task in the Task Name field.
2. Select the type of the task from the Type list.
  You can select Execute or Set Variable .
3. Select the script from the Script Type list and enter the script in the Script field.
  You can select Shell , EScript , or Powershell .
  Note: To view the supported list of eScript modules and functions, refer to Supported eScript Modules and Functions.
  
  For the Shell and eScript scripts, you can access the available list of macros by using @@{ .
  
  When you select the Shell and Powershell script, you can optionally select or add an endpoint. You can also select or add credentials.
  
  You can click Publish to Library to publish the task you configured to your task library.
4. Enter the output of the script in the Output field.
5. Click Save on the Blueprint Editor page.

Adding and Configuring Scale Out and Scale In

Perform the following procedure to add and configure the Scale Out and Scale In task.

Procedure

Add a service. See Adding a Service.
Configure VM, Package and Service. See Configuring Nutanix and Existing Machine VM, Package, and Service.
Add an Application profile. See Adding and Configuring an Application Profile.
In the Overview Panel, under Application Profile , click the + icon next to Actions.

Figure. Scale In and Scale Out Click to enlarge
In the Blueprint Canvas, below the service inspector, click + Task .
In the Inspector Panel, enter the name of the task in the Task Name field.
Select Scale In or Scale Out from the Scaling Type list.
Enter the number in the Scaling Count field.
The Scaling out and Scaling in number should be less than the minimum and maximum number of replicas defined for the service.
Click Save .

What to do next

You can run the scale-in or scale-out tasks on the Applications page. To do that, you first have to launch the blueprint and then click the Applications icon to view the created application on the Application page. You can run the scale in or scale out on the Manage tab of the application.

Blueprint Configuration for Snapshots and Restore

The snapshot and restore feature allows you to create a snapshot of a virtual machine at a particular point in time and restore from the snapshot to recreate the application VM from that time. You can configure snapshot and restore for both single-VM and multi-VM applications on a Nutanix platform. All you need to do is to add the snapshot/restore configuration to the blueprint. Adding the configuration generates separate profile actions for snapshot and restore to which you can add further tasks and actions.

For VMware, AWS, and Azure platforms, the snapshot and restore feature is available by default only to the single-VM applications.

For more information on blueprint configuration for snapshots, see Configuring Single-VM Blueprints with Nutanix for Snapshots and Configuring Multi-VM Blueprints on Nutanix for Snapshots.

Configuring Single-VM Blueprints with Nutanix for Snapshots

The snapshot/restore action for single-VM applications with Nutanix is no longer available by default. To enable snapshot, you must add a snapshot/restore configuration to the single-VM blueprint. You can configure to create snapshots locally or on a remote cluster. Snapshot and restore is a paired action in a blueprint and are always managed together.

About this task

The snapshot/restore configuration generates separate application profile actions for snapshot and restore. These actions also allow you to add more tasks and actions as part of the snapshot and restore configuration. For example, shutting down the application and the VM before creating the snapshot or restarting the VM before a restore. You can access these actions from the Manage tab of the Applications page.

Before you begin

Ensure that you set up your single-VM blueprint. For more information, see Setting up a Single-VM Blueprint.
Ensure that you added the VM details to your blueprint. For more information, see Adding VM Details to a Blueprint.
Ensure that you configured the VM in your blueprint. For more information, see VM Configuration.
Ensure that you added credentials to enable packages and actions. For more information, see Adding Credentials.
Ensure that you created the required snapshot policy. You associate snapshot policies when you launch the blueprint configured for snapshot and restore. For more information about creating snapshot policy, see Creating a Snapshot Policy.

Procedure

On the Advanced Options tab, next to Snapshot/Restore, click the + Add Snapshot/ Restore Config option.

Figure. Snapshot Config Click to enlarge
In the Add Snapshot and Restore window, do the following:
1. Enter the suffix that you want to associate to the snapshot/restore profile action.
2. Enter a name for the snapshot in the Snapshot Name field.
  You can use Calm macros to provide a unique name to the snapshot whenever they are generated. For example, snapshot-@@{calm_array_index}@@-@@{calm_time}@@ .
3. Under the Snapshot Location section, select Local or Remote Cluster to specify whether this configuration should manage your snapshots locally or on a remote cluster.
4. Select the Delete older VM after restore check box to delete the older VM after the service is restored from the snapshot.
5. Click Save .
  Saving the configuration generates separate profile actions for snapshot and restore.
On the Advanced Options tab, click Edit next to the snapshot or restore action to edit the configuration or add tasks. For more information about adding a task, see Configuring Tasks or Packages in a Blueprint.

What to do next

You can launch the blueprint after associating snapshot policies and rules. For more information, see Launching a Blueprint.
You can access the create snapshots from the Manage tab on the Applications page. For more information, see Creating Snapshots on a Nutanix Platform.

Configuring Multi-VM Blueprints on Nutanix for Snapshots

You can configure the snapshot/restore action in a blueprint on Nutanix account to create snapshots locally or on a remote cluster. Snapshot/restore is a paired action for a particular service in a blueprint and are always managed together.

About this task

The snapshot/restore definition of a service generates snapshot configuration and its corresponding restore configuration. You can use these configurations to modify your snapshot and restore setup.

The snapshot/restore configuration generates separate application profile actions for snapshot and restore. These actions allow you to add more tasks and actions as part of the snapshot and restore configuration. For example, shutting down the application and the VM before creating the snapshot or restarting the VM or services before a restore. You can access these actions from the Manage tab of the Applications page to create or restore snapshots.

Before you begin

Ensure that you have completed the pre-configuration requirements. For more information, see Creating a Multi-VM Blueprint.
Ensure that you have at least one service available. For more information, see Adding a Service.
Ensure that you create the required snapshot policy. You associate snapshot policies when you launch the blueprint configured for snapshot and restore. For more information about creating snapshot policy, see Creating a Snapshot Policy.

Procedure

In the Overview Panel, expand the service to which you want to add the snapshot and restore action.
Click the + icon next to Snapshot/Restore .

Figure. Multi-VM Snapshot Click to enlarge
In the Add Snapshot and Restore window, do the following:

Figure. Multi-VM Snapshot Options Click to enlarge
1. Enter the suffix that you want to associate to the snapshot/restore profile action.
2. Enter a name for the snapshot in the Snapshot Name field.
  You can use Calm macros to provide a unique name to the snapshot whenever they are generated. For example, snapshot-@@{calm_array_index}@@-@@{calm_time}@@ .
3. Under the Snapshot Location section, select Local or Remote Cluster to specify whether this configuration should manage your snapshots locally or on a remote cluster.
4. In case of multiple replicas of the service, do one of the following:
  - Select Take snapshot of the first replica only to take snapshot of only the first replica.
  - Select Take snapshot of the entire replica set to take snapshot of the entire replica set.
5. Select the Delete older VM after restore check box to delete the older VM after the service is restored from the snapshot.
6. Click Save .
  Saving the configuration generates separate profile actions for snapshot and restore.
To view and edit the snapshot and restore configurations, expand the corresponding Snapshot/Restore under the service.
You can click the configuration to view the details in the Inspector Panel or make any changes to the configuration.
To view the profile actions for snapshot and restore or add more tasks and actions as part of snapshot and restore configuration, expand the Application Profile section.

What to do next

You can add more tasks and actions to the snapshot and restore application profiles. For more information, see Adding an Action to a Multi-VM Blueprint.
You can launch the blueprint after associating snapshot policies and rules. For more information, see Launching a Blueprint.
You can create snapshots from the Manage tab on the Applications page. For more information, see Creating Snapshots on a Nutanix Platform.

Update Configuration for VM

The update configuration feature allows you to update virtual machines of running applications on Nutanix to a higher or lower configuration. Using this feature, you can modify VM specifications such as the vCPU, memory, disks, networking, or categories (tags) of a running application with minimal downtime. You no longer have to create new blueprints or approach your IT administrator to modify VM resources.

To update configurations of a running application VM, you need to perform the following actions:

Add an update configuration to the application blueprint.
Launch the update configuration

Add Update Configuration in the Blueprint

As a blueprint developer, you can add update configurations for a service in the blueprint. These update configurations are at the parallel level of application profile actions and can be executed individually for a particular service. As part of the configuration, you can do the following:

Specify the change factor (increase, decrease, or provide a definitive value) for VM configurations (vCPU, cores per vCPU, and memory). You can provide a minimum or maximum limit for each component based on the change factor you select and allow blueprint consumers to edit components during updates.
For example, consider a case where the original vCPU value in the blueprint is 4. You then add a change factor to the update configuration to increase the vCPU by 1 with a maximum limit of 5. When this update is launched, you can run the action only once to increase the vCPU to 5. Once the VM is upgraded to 5 vCPU, you cannot add any more vCPUs to the VM.
Add disks with a minimum and maximum limit for each disk. You can allow blueprint users to edit the disk size during updates until the value reaches the maximum or minimum limit. You can also allow blueprint users to remove existing vdisks from the VM.
Add categories (tags) to the running VM.
Add NICs to the VM or allow blueprint consumers to remove NICs. You can only add those NICs that belong to the same cluster and remove only those NICs that are not used to provide the address. You can also allow consumers to choose the desired subnet during updates.

The update configuration generates the corresponding action where you can add tasks to define how you want to execute the update.

For more information about adding update configuration to a blueprint, see Adding an Update Configuration to Single-VM Blueprints and Adding an Update Configuration to Multi-VM Blueprints.

Launch Update Configuration

You can update VM specifications from the Manage tab of applications on Nutanix. For more information, see Update VM Configurations of Running Applications.

Adding an Update Configuration to Single-VM Blueprints

As a blueprint developer, you can add an update configuration to a single-VM application blueprint.

About this task

The update configuration feature allows you to update the virtual machine of a running single-VM application to a higher or lower configuration. For more information, see Update Configuration for VM.

Before you begin

Ensure that you set up your single-VM blueprint. For more information, see Setting up a Single-VM Blueprint.
Ensure that you added the VM details to your blueprint. For more information, see Adding VM Details to a Blueprint.
Ensure that you configured the VM in your blueprint. For more information, see VM Configuration.

Procedure

On the Advanced Options tab, next to Update Configs, click the + Add Config option.
On the Update Configs page, click the edit icon next to the update config name to change the name of the configuration.
Under the VM Configuration section, select a change factor for the attributes and specify the value for the selected factor. To do that:
1. View the current value of vCPUs, No. of Cores, and Memory (GiB) in the Current Value column.
2. Click Update for the attribute that you want to update.
  
  Figure. Single-VM Update Config Options Click to enlarge
3. Select a value in the Operation list for the attribute. You can select Increase , Decrease , or Equal .
  For example, if the original vCPU value in the blueprint is 4 and you want to increase the vCPU by 1, then select Increase in the Operation list.
  
  Note: The update value is relative to the current value when you select Increase or Decrease . The update value is absolute when you select Equal .
4. Specify an update value in the Update column based on the Operation value you selected.
  For example, if the original vCPU value in the blueprint is 4 and you want to increase the vCPU by 1, then enter 1 in the Update field.
5. Specify the limit value to which the configuration of an attribute can be updated in the Min Value or Max Value column.
  For example, if the original vCPU value in the blueprint is 4 and you want to increase the vCPU to a maximum limit of 6, then specify 2 in the Max Value column. THe vCPU of the VM can be updated until its value reaches 6vCPU. After the VM reaches 6 vCPU, more vCPUs cannot be added to the VM.
  
  You can also enable the Editable toggle button of an attribute to allow your users to change its value within the limits you specify in the Min Value or Max Value column during the launch of the update.
Under the Disks section, do the following:
1. To add vdisk to the update configuration, click the + icon next to Add/Edit vDisks to this VM .
2. Select the device type and the device bus.
3. To define the disk size, specify the value for the vdisk size in the Value field.
  You can enable the Editable toggle button and specify the Min Value and Max Value for the vdisk.
4. To allow your users to remove existing vdisks from the VM during the launch of the update, click Advanced Settings and select the Allow users to remove existing vDisks check box.
Under the Categories section, do the following:
1. To add to the update configuration, select the categories in the Key: Value list.
  
  Note: The categories you select must have the default SSH port (port 22) open in the security policies.
2. To allow your users to remove existing categories during the launch of the update, click Advanced Settings and select the Allow users to remove existing categories check box.
3. To allow your users to add new categories during the launch of the update, select the Allow users to add new categories check box.
Under the Network Adapters section, do the following:
1. To add more NICs to the update configuration, click the + icon next to Add/Edit NICs to this VM and select the NIC from the list.
  The NICs of a VM can either use VLAN subnets or overlay subnets. For example, if an overlay subnet is selected for NIC 1 and you want to add NIC 2, the NIC 2 list displays only the overlay subnets.
  
  If you selected a VLAN subnet in NIC 1, any subsequent VLAN subnets belong to the same cluster. Similarly, if you select an overlay subnet, all subsequent overlay subnets belong to the same VPC.
  
  You can enable the Editable toggle button to allow your users to choose the desired subnet during the launch of the update.
2. To allow your users to remove existing NICs during the launch of the update, click Advanced Settings and select the Allow users to remove existing NICs check box.
To add variables to the update configuration, click the Variables tab and then the + icon next to Variables .
Click Done to save the update configuration.
Saving the update config generates the Config component. The Config component lets you open the Update Config window to edit the update configuration.
On the Advanced Options tab, click Save to save the blueprint and to generate the corresponding action for the update configuration.
Click Edit next to the configuration to add more tasks to the update configuration.

Adding an Update Configuration to Multi-VM Blueprints

As a blueprint developer, you can add an update configuration for a service to a multi-VM application blueprint.

About this task

The update configuration feature allows you to update virtual machines of running multi-VM applications to a higher or lower configuration. For more information, see Update Configuration for VM.

Procedure

Click the Blueprint icon in the left pane.
The Blueprint page appears.
Do one of the following:
- To add an update configuration to a new blueprint, select Multi VM/Pod Blueprint from the + Create Blueprint list, and create a blueprint. For more information, see Creating a Multi-VM Blueprint.
- To add an update configuration to an existing blueprint, click the blueprint name to open the blueprint editor.
Ensure that you have added the service to which you want to add the update configuration. For more information about adding a service, see Adding a Service.
In the Overview Panel, click the + icon next to Update Config .

Figure. Multi-VM Blueprint Update Config Click to enlarge

The Update Config window appears.
From the Select Service to Update list, select the service to which you want to add the update configuration.

Figure. Update Config Options Click to enlarge
In the Name the update configuration field, specify a name for the configuration.
Under the VM Configuration section, select a change factor for the attributes and specify the value for the selected factor. To do that:
1. View the current value of vCPUs, No. of Cores, and Memory (GiB) in the Current Value column.
2. Click Update for the attribute that you want to update.
3. Select a value in the Operation list for the attribute. You can select Increase , Decrease , or Equal .
  For example, if the original vCPU value in the blueprint is 4 and you want to increase the vCPU by 1, then select Increase in the Operation list.
  
  Note: The update value is relative to the current value when you select Increase or Decrease . The update value is absolute when you select Equal .
4. Specify an update value in the Update column based on the Operation value you selected.
  For example, if the original vCPU value in the blueprint is 4 and you want to increase the vCPU by 1, then enter 1 in the Update field.
5. Specify the limit value to which the configuration of an attribute can be updated in the Min Value or Max Value column.
  For example, if the original vCPU value in the blueprint is 4 and you want to increase the vCPU to a maximum limit of 6, then specify 2 in the Max Value column. THe vCPU of the VM can be updated until its value reaches 6vCPU. After the VM reaches 6 vCPU, more vCPUs cannot be added to the VM.
  
  You can also enable the Editable toggle button of an attribute to allow your users to change its value within the limits you specify in the Min Value or Max Value column during the launch of the update.
Under the Disks section, do the following:
1. To add vdisk to the update configuration, click the + icon next to Add/Edit vDisks to this VM .
2. Select the device type and the device bus.
3. To define the disk size, specify the value for the vdisk size in the Value field.
  You can enable the Editable toggle button and specify the Min Value and Max Value for the vdisk.
4. To allow your users to remove existing vdisks from the VM during the launch of the update, click Advanced Settings and select the Allow users to remove existing vDisks check box.
Under the Categories section, do the following:
1. To add to the update configuration, select the categories in the Key: Value list.
  
  Note: The categories you select must have the default SSH port (port 22) open in the security policies.
2. To allow your users to remove existing categories during the launch of the update, click Advanced Settings and select the Allow users to remove existing categories check box.
3. To allow your users to add new categories during the launch of the update, select the Allow users to add new categories check box.
Under the Network Adapters section, do the following:
1. To add more NICs to the update configuration, click the + icon next to Add/Edit NICs to this VM and select the NIC from the list.
  You can enable the Editable toggle button to allow your users to choose the desired subnet during the launch of the update.
2. To allow your users to remove existing NICs during the launch of the update, click Advanced Settings and select the Allow users to remove existing NICs check box.
Click Done to save the update configuration.
Saving the update config generates the Config component. The Config component lets you open the Update Config window to edit the update configuration.
On the Blueprint Editor page, click Save to save the blueprint and generate the corresponding action for the update configuration.
Saving the blueprint generates the Action component. The auto-generated Action component performs the start and stop of the service. You can also add tasks and actions to the component to define how you want your users to launch the update.

Blueprints Management in Calm

After you configure a blueprint, you can publish, unpublish, launch, or delete a blueprint.

Blueprint Publishing

Publishing a blueprint allows you to make the blueprint available at Marketplace, so that other users can use the published blueprint. Unpublishing a blueprint allows you to remove the blueprint from the Marketplace. For more information, see Submitting a Blueprint for Approval.

Blueprint Launching

Launching a blueprint allows you to deploy your application on the blueprint and start using it.

The blueprint launch page provides the following views:

View as Consumer : This view of the blueprint launch page displays only the editable fields that consumers require to launch a blueprint. When you design your blueprint for consumers with minimum configurations at runtime, use this view to get an idea about the blueprint launching experience of your consumers.
Blueprints that are launched from the marketplace display only the fields that require inputs from consumers. Displaying only editable fields offers a simpler and easy launching experience for your consumers.
View as Developer : This view of the blueprint launch page displays all editable and noneditable fields that you configure for the blueprint. As a blueprint developer, you can switch between View as Consumer and View as Developer on the blueprint launch page.
You can switch to View as Developer after you develop your blueprints to verify how you configured different fields and the launching experience the configuration will provide to your consumers.

For more information, see Launching a Blueprint.

Submitting a Blueprint for Approval

After you configure a blueprint, you can submit the blueprint to get an approval from the administrator. The administrator approves the blueprint and then publishes the blueprint at the marketplace for consumption.

Procedure

Click the Blueprint icon in the left pane.
The Blueprint page displays the list of all the available blueprints.
Click the blueprint that you want to publish.
The blueprint editor page is displayed.
Click Publish .

Figure. Publish Blueprint window Click to enlarge

The Publish Blueprint window is displayed.
If the blueprint is getting published for the first time, select New marketplace item and do the following.
1. To publish the blueprint with secret variables, click the Publish with Secrets toggle-button.
1. Enter the version number in the Initial Version field.
  
  Note: Ensure that the version number is in the x.x.x format.
2. Enter the blueprint description in the Description field.
If you want to revise a published blueprint version, select New version of an existing marketplace item and do the following.
1. To publish the blueprint with secret variables, enable the Publish with Secrets button.
2. Select the already published blueprint from the Marketplace Item list.
3. Enter the version number in the Initial Version field.
  
  Note: Ensure that the version number is in the x.x.x format.
4. Enter the blueprint description in the Description field.
5. Enter the log changes in the Change Log field.
If you want to upload an icon for the blueprint, click Change .
1. Click Upload from computer to browse and select an image from your local machine.
2. Click Open .
3. Provide a name to the image in the Name of the Icon field.
4. Click the right icon.
5. Click Select & Continue .
Note: User with administrator role can only upload an icon.
Optionally, if you want to select an icon, already available in a blueprint, click the right icon.
Optionally, to delete an icon, click the delete icon.
Click Submit for Approval .
The blueprint is submitted to the marketplace manager for approval. Your administrator can find the submitted blueprint on the Approval Pending tab of the Marketplace Manager page.

What to do next

You can request your administrator to approve and publish the blueprint to the marketplace. For more information about blueprint approval and publishing, see Approving and Publishing a Blueprint or Runbook.

Launching a Blueprint

You launch a blueprint to deploy an application on the blueprint and start using the application.

Before you begin

For blueprints on a Nutanix platform, ensure that you have created the snapshot policy. For more information about snapshot policy creation, see Creating a Snapshot Policy.

Procedure

Click the Blueprint icon in the left pane.
The Blueprint page is displayed.
Click the blueprint that you want to launch.
The blueprint details page is displayed.
Click Launch .
The blueprint launch page is displayed.
Figure. Launch Blueprint Click to enlarge
Enter a name for the application in the Application Name field.
Enter a description for the application in the Application Description field.
Select the environment from the Environment list.
If you select an environment that is different from the account that you used for blueprint configuration, Calm updates all platform-dependant fields to match with the selected environment configuration.

For example, you created the application blueprint using an account with an environment (ENV1) so that the platform-dependant fields are similar to ENV1. While launching the application blueprint, if you select a different environment (ENV2), Calm updates all platform-dependant fields to match with the ENV2 configuration.
Select the application profile from the App Profile field.
In case, any of the fields are marked runtime while creating the blueprint, those fields are editable and displayed here. To view the runtime variables, expand the service under VM Configurations .
In the sections for the service configuration and credentials configuration, verify and edit the configuration requirements for your application services and credentials.

Figure. Blueprint Launch - Service Configuration Click to enlarge

Use the View as Developer option at the top of the blueprint launch page to view all configuration fields.

Note: The View as Consumer view displays only the editable fields while the View as Developer view displays all configuration fields for your services and credentials. As a developer, you can select the View as Developer to view the configuration details of all fields.
If the blueprint is configured with a Nutanix account, do the following:
1. Under Snapshot Configurations, select a snapshot policy in the Snapshot Policy list.
2. Based on the policy you select, select a rule in the Select Local Rule or Select Remote Rule list.
  The Select Local Rule or Select Remote Rule list appears based on the Snapshot Location you defined in your blueprint. For more information, see Blueprint Configuration for Snapshots and Restore. The values in the list appear based on the snapshot policy you defined in the project and selected in the Snapshot Policy list. For more information, see Creating a Snapshot Policy. The values also depend on the VM categories you configured in your blueprint.
The Snapshot Configuration section appears depending on the environment you select while launching the blueprint. If you select a specific environment, you must provide the snapshot policy and snapshot rule to launch the blueprint. The Snapshot Configuration section does not appear in case you select the environment with all project accounts for the launch.

Note: Ensure that you have a valid NIC in the blueprint.
Click Deploy .
The system validates the provided platform-specific data against the selected provider and if the validation fails, an error message appears. To know more about the validation error, see Platform Validation Errors.
If the validation is successful, the application is available under the Application tab.

Platform Validation Errors

When you enter the platform data that is invalid for a provider while creating a blueprint, you get a validation error. The following table details the invalid platform data for each provider.

Providers	Invalid Platform Data
Nutanix	Image, NIC List, and Categories.
GCP	Machine Type, Disk Type, Network, SubNetwork, Source, Image, Zone, and Blank Disk.
AWS	Vpc, Security Groups, and Subnets.
VMware	Network name, NIC Type, NIC settings mismatch, Host, Template, Datastore, Datacenter, Storage Pod, and cluster.
Azure	Image details (publisher, offer, sku, version), Custom image, Resource group, Availability Set Id, NIC List, Network Security group, Virtual Network Name, and Subnet Name.

The platform validation error message appears as displayed in the following image.

Uploading a Blueprint

You can also upload configured blueprints to the Blueprints tab. Perform the following procedure to upload a blueprint.

Procedure

Click the Blueprint icon in the left pane.
The Blueprint page displays the list of all the available blueprints.
Click Upload Blueprint .
The browser window is displayed.
Browse to the location of the saved blueprint and select the blueprint.
Do one of the following.
- Double-click the selected blueprint.
- Select and click Open .
Figure. Upload Blueprint Click to enlarge

The Upload Blueprint window is displayed.
Enter the name of the blueprint in the Blueprint Name field.
Select the project from the Project list.
Click Upload .
The blueprint is uploaded and available for use.
Note: You must provide the credentials password or key of the blueprint.

Downloading a Blueprint

You can also download a configured blueprint to your local machine and use it later. Perform the following procedure to download a blueprint.

Before you begin

Ensure that at least one blueprint must be available.

Procedure

Click the Blueprint icon in the left pane.
The Blueprint page displays the list of all the available blueprints.
Do one of the following.
- Click the blueprint that you want to download and click Download .
- Select the blueprint that you want to download and Action > Download .
The Download Blueprint dialog box appears.
Optionally, if you want to download the blueprint with the credentials and secrets used in the blueprint, click the check box in the Download Blueprint dialog box.
In the Enter Passphrase field, type a password.
The Enter Passphrase field is a mandatory field and is activated only after you have clicked the check box to download the blueprint with credentials and secrets.
Click Continue .
The blueprint is downloaded to your local machine.

Viewing a Blueprint

Perform the following procedure to view a blueprint.

Procedure

Click the Blueprint icon in the left pane.
The Blueprint page displays the list of all the available blueprints.
Click the blueprint that you want to view the details of.
The selected blueprints details are displayed.

Editing a Blueprint

You can edit a configured blueprint from the blueprints tab. Perform the following procedure to edit a blueprint.

Procedure

Click the Blueprint icon in the left pane.
The Blueprint page is displayed.
Click the blueprint that you want to edit.
The blueprint details page is displayed.
Make the necessary edits in the layers ( Services , Actions , and Application Profiles ).

Note: You cannot delete System level actions.
Click Save .
The updated blueprint is saved and listed in the blueprints tab.

Deleting a Blueprint

Perform the following procedure to delete a blueprint.

Procedure

Click the Blueprint icon in the left pane.
The Blueprint page is displayed.
Select the listed blueprint that you want to delete.
Click Actions > Delete .
Click Yes to confirm.
The blueprint is deleted.

Viewing Blueprint Error

If you have configured wrong details in your blueprint, you can view the error message while saving or publishing a blueprint. Perform the following procedure to view blueprint error message.

Procedure

Click the Blueprint icon in the left pane.
The Blueprint page displays the list of all the available blueprints.
Click the blueprint that you want to view the details.
The selected blueprint details are displayed. If there is any error in the blueprint, then the error is denoted by ! .
Click ! .

Figure. Blueprint Error Click to enlarge

The blueprint errors are displayed.

Recovering Deleted Blueprints

You can recover the deleted application blueprints within a time period of 90 days after you delete an application blueprint. This chapter describes the procedure to recover a deleted blueprint.

Procedure

Click the Blueprint icon in the left pane.
The Blueprint page displays the list of all the available blueprints.
In the search filter field, enter State:Deleted and press Enter.
You can view the list of all deleted blueprints based on the 90 days retention period.
Click the blueprint that you want to recover.
From the Action list, select Clone .
The Clone Blueprint page appears.
In the Blueprint Name field, enter a name for the blueprint and click Clone .
The name is used as the blueprint name after recovery.

A clone of the deleted blueprint is created and you can view the recovered blueprint in the blueprints page with the new name.

Marketplace in Calm

Marketplace Overview

The marketplace provides preconfigured application blueprints and runbooks for instant consumption. The marketplace is a common platform for both publishers and consumers.

The marketplace has banners to display featured applications. All listed applications display the icon of the platform that supports the application.

You can filter applications or runbooks based on their category and source. You can also search an application or runbook in the marketplace.

Note: The marketplace displays the application blueprints or runbooks that are approved and published using the Marketplace Manager. For more information on approving and publishing blueprints and runbooks, see Approving and Publishing a Blueprint or Runbook.

Before provisioning an application, you can view details such as application overview, changes made in different versions, and application-level actions.

Viewing Application Details

You can view application details such as licensing, installed resources, hardware requirements, operating systems, platforms, and limitations before you provision the application. You can also view the changes made in different versions and application-level actions.

About this task

Video: Viewing Application Details

Procedure

Click Marketplace icon in the left pane.
The Marketplace page is displayed.
To view the details of an application, click the Get button on the application blueprint.

Figure. Application Details Click to enlarge

The Application Details page is displayed.

Filtering Application Blueprints or Runbooks

Perform the following procedure to filter application blueprints or runbooks in the marketplace.

Procedure

Click Marketplace icon in the left pane.
The Marketplace page is displayed.
Click the Filters button.
The Filters pane appears.
Figure. Marketplace Filters Click to enlarge
Select a category, type, or source value to filter applications and runbooks.
The Marketplace page displays all available applications and runbooks based on the selected category, type, and source value.

Searching an Application Blueprint or Runbook

Perform the following procedure to search an application blueprint or runbook.

Procedure

Click Marketplace icon in the left pane.
The Marketplace page is displayed.
Enter the name of the application or runbook that you want to search in the Search marketplace field.
The Marketplace page shows the search results as you enter the name in the Search marketplace field.

Launching a Blueprint from the Marketplace

You can use the Marketplace tab to launch an application blueprint that is approved and published to the marketplace. The application launch page displays the fields that are editable by the consumer.

Procedure

Click the Marketplace icon in the left pane.
The Marketplace page is displayed.
Click the Get button for the application that you want to launch.
The Application Details page is displayed.
Click Launch .
The Launch page is displayed.
Figure. Launch Blueprint Click to enlarge
Enter a name for the application in the Application Name field.
Following are the rules for naming convention.
- The name of the blueprint can start with an alphanumeric character or an underscore.
- The name must have at least one character.
- Use only space, underscore, and dash as special characters.
- Do not end the name with a dash.
Enter a description for the application in the Application Description field.
Select the project from the Project list.
Select the environment from the Environment list.
If you select an environment that is different from the account that you used for blueprint configuration, Calm updates all platform-dependant fields to match with the selected environment configuration.

For example, you created the application blueprint using an account with an environment (ENV1) so that the platform-dependant fields are similar to ENV1. While launching the application blueprint, if you select a different environment (ENV2), Calm updates all platform-dependant fields to match with the ENV2 configuration.
Select an application profile in the App Profile field.
Application profile provides different combinations of the service, package, and VM while configuring a blueprint.
In the section for the service configuration, verify the VM, disk, boot configuration, and network configuration. You can edit the fields based on your application requirements.

Figure. Application Launch - Service Configuration Click to enlarge
If the blueprint is configured with a Nutanix account, do the following:
1. Under Snapshot Configurations, select a snapshot policy in the Snapshot Policy list.
2. Based on the policy you select, select a rule in the Select Local Rule or Select Remote Rule list.
  The Select Local Rule or Select Remote Rule list appears based on the Snapshot Location you defined in your blueprint. For more information, see Blueprint Configuration for Snapshots and Restore. The values in the list appear based on the snapshot policy you defined in the project and selected in the Snapshot Policy list. For more information, see Creating a Snapshot Policy. The values also depend on the VM categories you configured in your blueprint.
The Snapshot Configuration section appears depending on the environment you select while launching the blueprint. If you select a specific environment, you must provide the snapshot policy and snapshot rule to launch the blueprint. The Snapshot Configuration section does not appear in case you select the environment with all project accounts for the launch.

Note: Ensure that you have a valid NIC in the blueprint.
Click Deploy .
The application blueprint is displayed under the Application tab.

Environment Patching Behavior

VM configurations in blueprints and environments are associated with accounts. The environment patching depends on the account that you associate with the marketplace blueprint and the environment you configured.

To patch a cloud provider VM that has a specific OS type, Calm finds the corresponding match in the environment. In case there are no matches available, Calm displays a notification.

The following table lists the environment patching behavior for platform-dependent and platform-independent fields:

Table 1. Environment Patching
Fields	Condition	Patching Behavior
Platform-Dependent Fields	When different accounts are associated with the blueprint and environment	Values from the environment get preference for patching, irrespective of the values in the blueprint.
Platform-Dependent Fields	When the blueprint and the environment have the same account	Values from the environment are patched only when the fields do not have any value in the blueprint.
Platform-Independent Fields	When different accounts are associated with the blueprint and environment	Values from the environment are patched only when the fields do not have any value in the blueprint.
Platform-Independent Fields	When the blueprint and the environment have the same account	Values from the environment are patched only when the fields do not have any value in the blueprint.

The following table lists the platform-dependent fields for different platforms.

Table 2. Platform-Dependent Fields
Platform	Platform-Dependent Fields
Nutanix	Image, Categories, Cluster, and NIC
AWS	Machine Image, Key, Instance Profile Name, VPC ID, Subnet ID, and Security Group List
GCP	Machine Type, Zone, Network, Disk Type, Source Image, and Email
VMware	Host, Template, Datastore, Cluster, Storage Pod, Network Name, NIC Type, Disk Location, Disk ISO Path, Folder, and Tag List
Azure	Resource Group, Location, Availability Set ID, Resource Group Details, Resource Group Operation, Network Security Group Name, Network Name, Subnet Name, Network Security Group ID, Virtual Network ID, Subnet ID, Publisher, Offer, SKU, Version, Source Image Type, and Source Image ID

Environment Patching Behavior with Nutanix – Example-1

Assume that you have two Nutanix Prism Central accounts PC1 and PC2, and you added these accounts to your project (Project1). You then create two environments in the project with the following VM configuration:

Table 3. Environments
ENV1	ENV2
Account: PC1 NIC: PC1_Net1 Image: PC1_Image1 Categories: PC1_category1 and PC1_category2 Cluster: PC1_Cluster1 Operating System: Linux	Account: PC2 NIC: PC2_Net1 Image: PC2_Image1 Categories: PC2_category1 and PC2_category2 Cluster: PC2_Cluster1 Operating System: Linux

You then create a blueprint with a Nutanix service under Project1 having the following configuration:

Account: PC1
Image: PC1_Image2
Categories: PC1_category3
Cluster: PC1_Cluster2
NIC: PC1_Net2

When you publish this blueprint in the marketplace and launch the blueprint with a different environment, the environment patching happens as follows:

When you select Project1 and ENV2 for launching, the account in the blueprint is PC1, and the account in ENV2 is PC2.
Because different accounts are associated with the blueprint and environment, all platform-dependent field values are patched from the environment to the blueprint, irrespective of the values already available in the blueprint. The blueprint is launched with the following configuration.
- Image: PC2_Image1
- Categories: PC2_category1 and PC2_category2
- Cluster: PC2_Cluster1
- NIC: PC2_Net1
When you select Project1 and ENV1 for launching, the account in both the blueprint and ENV1 is PC1.
Because the account is same for both blueprint and environment and all the platform-dependent fields already have values, the patching does not happen. The blueprint is launched with the following configuration.
- Image: PC1_Image2
- Categories: PC1_category3
- Cluster: PC1_Cluster2
- NIC: PC1_Net2

Environment Patching Behavior with Nutanix – Example-2

Assume that you have a Prism Central account PC1 that is associated with two Prism Elements PE1 and PE2, and you add PC1 to your project (Project1).

Assume that the associated Prism Elements have the following networks.

PE1: PE1_Net1 and PE1_Net2
PE2: PE2_Net1 and PE2_Net2

You then create two environments with the following VM configuration:

Table 4. Environments
ENV1	ENV2
NIC: PE1_Net1 Image: PC1_Image1 Categories: PC1_category1 and PC1_category2 Operating System: Linux	NIC: PE2_Net1 Image: PC1_Image2 Categories: PC1_category3 and PC1_category4 Operating System: Linux

You then create a blueprint with a Nutanix service under Project1 having the following configuration:

NIC: PE1_Net2
Image: PC1_Image3
Categories: PC1_category5 and PC1_category6

When you publish this blueprint in the marketplace and launch the blueprint with a different environment, the environment patching happens as follows:

When you select Project1 and ENV2 for launching:
Prism Element accounts are derived from the NIC or subnet. The PE1_Net2 network used in the blueprint associates the blueprint to Prism Element PE1, and the PE2_Net1 network used in ENV2 associates the environment to Prism Element PE2.

Because these two networks are connected to two different Prism Element account_uuid , Calm considers this case as two different accounts associated with the blueprint and environment. All platform-dependent field values are, therefore, patched from the environment to the blueprint, irrespective of the values already available in the blueprint. The blueprint is launched with the following configuration.
- NIC: PE2_Net1
- Image: PC1_Image2
- Categories: PC1_category3 and PC1_category4
When you select Project1 and ENV1 for launching:
The PE1_Net2 network used in the blueprint and the PE1_Net1 network used in ENV belong to the same Prism Element account.

Because these two networks share the same Prism Element account_uuid , Calm considers this case as the same account associated with both the blueprint and environment. Platform-dependent fields in this case already have values, and the patching does not happen. The blueprint is launched with the following configuration.
- NIC: PE1_Net2
- Image: PC1_Image3
- Categories: PC1_category5 and PC1_category6

Credentials Patching

Patching of credentials happens only when you publish your blueprints in the marketplace without secrets.

For patching, the credentials of the marketplace blueprint are mapped with the environment using the associated provider account and operating system type. The password or the key value of the corresponding environment is then patched to the blueprint. The credential name and the credential username are never patched from the environment.

For example, if the blueprint and the environment have the following configurations:

Table 5. VM Configuration
Blueprint	Environment
Credential Name: BP_Credentials Username: BP_User1 Password: BP_Password Provider Account: Nutanix Operating System: Linux	Credential Name: ENV_Credentials Username: ENV_User1 Password: ENV_Password Provider Account: Nutanix Operating System: Linux

The credentials patching in the blueprint happens as follows:

Table 6. Credential Patching
When Blueprint is Published with Secrets	When Blueprint is Published without Secrets
Credential Name: BP_Credentials Username: BP_User1 Password: BP_Password	Credential Name: BP_Credentials Username: BP_User1 Password: ENV_Password

Patching for Clusters and Subnets

The Cluster field is platform dependent. The environment patching logic of a platform-dependent field depends on the account that you associate with the marketplace item and the VM configuration of the environment.

Table 1. Conditions for Cluster Patching
Condition	Patching Behavior
When the cluster reference in the blueprint and in the environment VM configuration is the same.	No patching happens. The cluster reference from the blueprint is used for the launch.
When the cluster reference in the blueprint and in the environment VM configuration is different.	Patching happens. The cluster value is patched from the environment for the launch.
When the cluster reference in the blueprint is a macro. Note: Cluster reference can be a macro only when all the subnets are overlay subnets or all the subnets are macros.	No patching happens. The cluster value will remain as a macro. When the reference is a macro, it is independent of the environment or the account that is being used for launch.

VLAN subnets are platform dependent. The environment patching logic of VLAN subnets depends on the cluster reference of the blueprint and the cluster reference of the associated environment VM configuration.

Overlay subnets are VPC dependent. The environment patching logic of these subnets depends on the VPC reference in the blueprint and the VPC reference of the associated environment VM configuration.

All subnets in the substrate of a blueprint can either have overlay subnets or VLAN subnets. If subnets are overlay subnets, then all the subnets in the substrate must belong to the same VPC.

Table 2. Conditions for Subnet Patching
Condition	Patching Behavior
When the VLAN subnets in the blueprint and in the environment VM configuration is the same.	No patching happens. VLAN subnets are platform dependent. The VLAN subnet values referred in the blueprint are used.
When the VLAN subnets in the blueprint and in the environment VM configuration is different.	Patching happens. VLAN subnets are platform dependent. The VLAN subnet values are patched from the environment.
When the VPC reference of the subnets (overlay subnets) in the blueprint and the environment VM configuration is the same.	No patching happens. The subnet values of the blueprint are used for the launch. Values from the environment is patched only if it is empty in the blueprint or not allowed in the destination environment.
When the VPC reference of the subnets (overlay subnets) in the blueprint and the environment VM configuration is different.	Patching happens. The subnet values are patched directly from the environment.
When the network type in the blueprint and the environment VM configuration are different (for example, overlay subnets in the blueprint and VLAN subnets in the environment).	Patching happens. The subnet values are patched directly from the environment.
When the subnet reference of the any of the NICs in the blueprint is a macro.	Patching follows the usual conditions. However, the macros are never patched.

Executing a Runbook from the Marketplace

You can execute a runbook an approved and published runbook using the Marketplace tab.

Before you begin

Ensure that the runbook that you want to execute is approved and published in the marketplace. For more information, see Approving and Publishing a Blueprint or Runbook.

Procedure

Click the Marketplace icon in the left pane.
The Marketplace page is displayed.
Click the Get button for the runbook that you want to execute.
The runbook overview page appears.
Figure. Runbooks Overview Click to enlarge
Click Execute .
The Execute Runbook window appears.
Figure. Execute Runbook Click to enlarge
Select the project for the runbook execution from the Project list.
Optionally, if you want to change the default endpoint for the execution, select an endpoint from the Default Endpoint list.

Note: If you have published runbook without endpoints, then you need to select the endpoint from the project in which you are executing the runbook.
Optionally, if you want to update the added variable in the runbook, click the respective variable field and edit the variable.

Note: You can update the variable only if the variable is marked as runtime editable while adding the variable in the runbook.
Click Execute .

Cloning an Application Blueprint or Runbook

You can clone an application blueprint or runbook from the marketplace.

Procedure

Click Marketplace icon in the left pane.
The Marketplace page is displayed.
Click the Get button for the application blueprint or runbook that you want to clone.
The Overview page for the application or runbook appears.
Figure. Blueprint Cloning Click to enlarge
Click Clone .
The Clone window appears.
Enter the name for the clone.
Select the project that you want to assign to the cloned application blueprint or runbook from the Project list.
Click Clone .
The cloned blueprint or runbook appears on their respective Blueprints or Runbooks tabs.

Marketplace Manager in Calm

Marketplace Manager Overview

Use Marketplace Manager to manage the list of custom blueprints, ready-to-use marketplace application blueprints, and runbooks. You can approve, reject, launch, publish, unpublish, assign a category, and select projects for a blueprint. You can also approve, reject, publish, unpublish, and execute runbooks.

The Approved tab on the Marketplace Manager page provide you a list of ready-to-use application blueprints and the custom blueprints or runbooks you approved. The Approval Pending tab provides a list of custom blueprints and runbooks that require your approval to be available in the Marketplace for consumption.

When you select a blueprint or runbook from the list on any tab, the inspector panel displays the operations you can perform on the selected blueprint or runbook. The inspector panel also displays a brief overview of the blueprint or runbook and allows you to assign projects to blueprint or runbook.

You can perform the following actions on blueprints or runbooks.

You can approve blueprints or runbooks and publish them to the marketplace for consumption. You can also publish the ready-to-use application blueprints to the marketplace. For more information, see Approving and Publishing a Blueprint or Runbook.
You can unpublish blueprints or runbooks to remove them from the marketplace. For more information, see Unpublishing a Blueprint or Runbook.
You can also delete an unpublished blueprint or runbook. For more information, see Deleting an Unpublished Blueprint or Runbook.

Marketplace Version

Marketplace version enables you to define the initial version number of the blueprint or runbook that is getting published to the marketplace. Marketplace version also enables you to revise the version of a blueprint or runbook that is already published to the marketplace. For information about how to define marketplace version, see Submitting a Blueprint for Approval or Submitting a Runbook for Publishing.

Approving and Publishing a Blueprint or Runbook

You can approve custom blueprints or runbooks that are submitted for approval on the Approval Pending tab. You can also publish the approved blueprints or runbooks to the marketplace after associating them with a project on the Approved tab.

About this task

The Approved tab also displays the ready-to-use application blueprints that are available after enabling the Nutanix Marketplace Apps toggle button on the Settings page. These application blueprints do not require approval and can be published directly to the marketplace after associating them with a project. For more information about enabling the ready-to-use applications, see Enabling Nutanix Marketplace Applications.

Before you begin

To publish a blueprint, ensure that you have configured a blueprint and submitted the blueprint for approval. For more information, see Calm Blueprints Overview and Submitting a Blueprint for Approval.
To publish a runbook, ensure that you have submitted a runbook for publishing. For more information, see Submitting a Runbook for Publishing.

Procedure

Click Marketplace Manager tab.
The Marketplace Manager page is displayed.
Click the Approval Pending tab to get the list of all unpublished blueprints and runbook requests.
A list of all the unpublished blueprint and runbook requests is displayed.
Figure. Marketplace Manager Approval Pending Click to enlarge
Select the blueprint or runbook that you want to approve and publish.
The inspector panel appears.
Click the check mark button to approve.
Click the Approved tab to get the list of all approved blueprints and runbooks.
A list of all the approved blueprints and runbooks is displayed.
Select the approved blueprint or runbook that you want to publish.

Note: You can also select a ready-to-use marketplace application blueprint on the Approved tab for publishing.
In the Inspector Panel, select the category from the Category list.
You can also add a new application category value and select the value for publishing. To add a new category value for applications, you need to add the value to the AppFamily category. To know how to add a value to a category, see the Category Management section in the Virtual Infrastructure (Cluster) Administration chapter of the Prism Central Guide .
Select one or more projects from the Projects Shared With list.
Click Apply .
Click Publish .
The blueprint or runbook will be published in the marketplace.

What to do next

Launch the published blueprint from the Marketplace tab. For more information, see Launching a Blueprint from the Marketplace.
Execute the published runbook from the Marketplace tab. For more information, see Executing a Runbook from the Marketplace.

Unpublishing a Blueprint or Runbook

You can unpublish a blueprint or runbook if you do not want to list it in the Marketplace. You can publish the blueprint or runbook again if required.

Procedure

Click the Marketplace Manager tab.
The Approved tab lists all the published blueprints and runbooks.
Select the blueprint or runbook that you want to unpublish.
The inspector panel is displayed.
Click Unpublish .
The blueprint or runbook is unpublished and does not appear in the marketplace.

Deleting an Unpublished Blueprint or Runbook

You can delete a blueprint or runbook that is not published in the marketplace. If you want to delete a published blueprint or runbook, you first have to unpublish it and then delete it.

Procedure

Click the Marketplace Manager tab.
Do one of the following:
- To delete a blueprint or runbook that is not yet approved, click the Approval Pending tab.
- To delete a blueprint or runbook that is approved and unpublished, click the Approved tab.
Select the blueprint or runbook that you want to delete.
The inspector panel appears.
Click the Delete icon.
The blueprint or runbook is deleted from the marketplace manager.

Calm Applications

Applications Overview

You create applications in Calm by creating and launching blueprints.

The Applications page displays the list of all published applications under the Applications tab and the list of brownfield applications under the Brownfield Applications tab.

The Applications page provides the following details about an application.

Name of the application.
Source blueprint of the application.
State of an application whether the application is in a running or in an error state.
Application creation time.
Name of the application owner.
Time duration when the application was created.
Date of the last update of the application.
The cost of an application for last 30 days.

Application-Level Actions

You have the following application-level actions.

Create
Start
Restart
Stop
Delete
Soft delete
Install NGT applications
Manage NGT applications
Uninstall NGT applications
Create, restore, and delete snapshots
Clone applications

You cannot perform the Create action after the blueprint is launched and the application is created. You can perform all other application-level actions according to the application state.

You can also perform advanced application actions such as creating or restoring snapshots, updating VM configuration, or cloning an application. See the Advanced Application Actions chapter in this guide for details.

Application State

The applications page displays the state of the application based on the actions you perform on the Manage tab.

Table 1. Application State
Application State	Description
Provisioning	When you start an application.
Running	When the application is deployed and running after the provisioning state.
Stopping	When you have initiated an operation to stop the application.
Stopped	When the application is stopped.
Restarting	When you have initiated an operation to restart the application after the application is stopped.
Deleting	When you have initiated an operation to delete the application.
Deleted	When the application is deleted.
Busy	When you have installed the NGT services on the VMs of an application.
Updating	When you are editing an application.
Error	When the application goes to error state due to any action you have performed in the Manage tab.
Failover-in-progress	When you have initiated a failover operation on Prism Central for the protected VMs of an application.
Failover-failed	When the failover operation for the VMs has failed. The failure state mainly occurs in the following conditions. If there is any error from the Prism Central side. If there is no NIC attached to the VM when you configure the recovery plan for the protected VM.

Note: The Failover-in-progress and Failover-failed states are only applicable for the applications that are running on the Nutanix platform.

Application Details

You can click an application name to get details about the application as shown in the following figure.

The application page consists of the following tabs.

Overview Tab

The Overview tab consists of the following panels.

Application Description
Variables
Cost Summary
App Summary
App Status
VM Info

Table 1. Overview Tab
Panel	Description
Application Description	Displays the application description.
Variables	Displays the variable list used to create the blueprint. You can click the copy icon next to the variable to copy the variable.
Cost Summary	Displays the total cost, current cost for each hour, and the cost incurred in a month for the resources that are running in the blueprint. The cost summary panel also displays a graphical representation of the incurred cost. Note: The Cost Summary panel is applicable for Nutanix and VMware providers.
App Summary	Displays the following application details. Application UUID : Displays a unique identification code for the application. UUID is automatically generated after the application is created and in running state. Blueprint : Displays the blueprint from which the application is created. Cloud : Displays the cloud provider icon that hosts the application. Project : Displays the project that is added to the application. Owner : Displays the role of the user. Created On : Displays the date and time when the application was created. Last Updated On : Displays the date and time when the application was last updated.
App Status	Displays the summary of virtual machines (VMs). The panel displays the number of VMs that are in the following state. On Busy Error Off
VM info	Displays the following VM details of the application. Name : Displays the VM name. IP Address : Displays the IP address of the VM. Image : Displays the image from which the VM is created. vCPUs : Displays the number of vCPU allocated to the VM. Cores : Displays the number of cores allocated to the VM. Memory : Displays the total memory allocated to the VM. Network Adapters : Displays the network adapters used in the VM. You can use the down arrow key to view the details of the network adapter. VPC : Displays the associated VPC and the connection status. Categories : Displays the categories added to the VMs. You can use the down arrow key to view the details of the network adapter.

Manage Tab

The Manage tab lists the system-generated and user-created actions that you can perform on the application. When you click any of the listed actions, the editor displays the action dependencies.

You can perform the following system-generated actions on an application.

Create : Creates an application. You cannot perform this action once the blueprint is launched and application is created.
Start : Starts an application.
Restart : Restarts an application.
Stop : Stops an application.
Delete : Deletes an application including the underlying VMs on the provider side.
Soft Delete : Deletes the application from the Calm environment but does not delete the VMs on the provider side.
Install NGT : Installs NGT service on your VM. To install NGT on your VM, see Installing NGT Apps.
Manage NGT : Manages NGT services for your application. You can enable or disable SSR or VSS services. The self-service restore (SSR) allows virtual machine administrators to do a self-service recovery from the Nutanix data protection snapshots with minimal administrator intervention. For more information, see Self-Service Restore section in the Prism Web Console Guide. Volume Shadow Copy Service (VSS; also known as Shadow Copy or Volume Snapshot Service) creates an application-consistent snapshot for a VM and is limited to consistency groups consisting of a single VM.
Uninstall NGT : Uninstalls NGT services from the VM. For more information, see Uninstalling NGT Apps.

Nutanix guest tools (NGT) is a software bundle that you can install in a guest virtual machine (Microsoft Windows or Linux) to enable the advanced functionalities provided by Nutanix. For more information on NGT, see the Nutanix Guest Tool section in the Prism Web Console Guide .

Note:

NGT services applies only to single VM applications running with Nutanix as the provider.
For Kubernetes, the start, stop, and restart actions are disabled.

The inspector panel also displays the action you perform on an application. To view the detailed course of the action, click Action .

Metrics Tab

The Metrics tab allows you to view performance metrics of the VM. The Metrics tab displays a section on the left with a list of metrics.

Note:

The Metrics tab applies only to single VM blueprint running with Nutanix as the provider.
The identified anomalies are based on VM behavioral machine-learning capabilities.

Clicking a metric displays a graph on the right. (Some metrics have multiple graphs.) The graph is a rolling time interval performance or usage monitor. The baseline range (based on the machine-learning algorithm) appears as a blue band in the graph. Placing the cursor anywhere on the horizontal axis displays the current value. To set the time interval (last 24 hours, last week, last 21 days), select the duration from the pull-down list on the right.
Note: The machine-learning algorithm uses 21 days of data to monitor performance. A graph does not appear for less than 21 days of data.
To create an alert for this VM based on either behavioral anomalies or status thresholds, click the Set Alerts link above the graph.

The following table describes the available metrics.

Table 1. Metrics Tab Fields
Metric	Description
CPU usage	Displays the percentage of CPU capacity currently the VM is using (0–100%).
CPU ready Time	Displays the current, high, and low percentage of CPU ready time (0–100%).
Memory usage	Displays the percentage of memory capacity currently the VM is using (0–100%).
I/O Bandwidth	Displays separate graphs for total, write (only), and read (only) I/O bandwidth used per second (Mbps or KBps) for physical disk requests by the VM.
I/O Latency	Displays separate graphs for total, write, and read average I/O latency (in milliseconds) for physical disk requests by the VM.
IOPS	Displays separate graphs for total, write, and read I/O operations per second (IOPS) for the VM.
Usage	Displays separate graphs for current, snapshot, and shared storage usage (in GiBs) by the VM.
Working set size	Displays separate graphs for total, write, and read storage usage (in GiBs) for the VM working set size.
Network packets dropped	Displays separate graphs for the number of transmitted and received packets dropped.
Network bytes	Displays separate graphs for the amount of transmitted and received bytes (in GiBs).

Recovery Points Tab

The Recovery Points tab allows you to view the captured snapshots, restore applications from snapshots, and delete the snapshots for an application.

Note:

The Recovery Points tab applies only to single VM blueprints running with Nutanix as the provider.

To create snapshots of the single-VM or multi-VM applications that are running on Nutanix platform, use the snapshot action on the Manage tab of the application.

Table 1. Recovery Points Tab Fields
Fields	Description
Name	Displays the name of the snapshots.
Creation Time	Displays the date and time of the snapshot creation.
Location	Displays the location where the snapshot was taken.
Expiration Time	Displays the expiration time of the snapshot.
Recovery Point Type	Displays whether the snapshot type is application-consistent or crash-consistent.

Snapshots Tab

The Snapshot tab allows you to view the captured snapshots, restore applications from snapshots, and delete the snapshots for an application. Use this tab to create snapshots of single-VM applications that are running on VMware or Azure.

Table 1. Snapshots Tab Fields
Fields	Description
ID	Displays the ID of the snapshots. Snapshot IDs are unique and automatically generated when you take a snapshot.
Name	Displays the name of the snapshot.
Description	Displays the description of the snapshot.
Parent	Displays the parent blueprint application from which the snapshot is taken.
Creation Time	Displays the date and time when the snapshot is taken.

AMIs Tab

The AMIs tab allows you to view the captured snapshots, restore applications from snapshots, and delete the snapshots for an application.

Note: This tab is only applicable for single VM blueprints running with AWS accounts.

Table 1. AMI Tab Fields
Fields	Description
ID	Displays the ID of the snapshots. Snapshot IDs are unique and automatically generated when you take a snapshot.
Name	Displays the name of the snapshot.
Description	Displays the description of the snapshot.
Creation Time	Displays the date and time when the snapshot is taken.

Services Tab

The Services tab lists the included services in the application as displayed in the following figure. You can select the service to view the configuration details in the service inspector panel.

Note: Service tab is only applicable for multi-VM applications.

Accessing Web SSH Console

Perform the following procedure to run shell commands on a web SSH console for a service.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application.
The Overview tab is displayed.
Under the Service tab, click the service.
Click Open Terminal .

Figure. Web SSH Console Click to enlarge

The web SSH console is displayed.

Audit Tab

The Audit tab lists the action or actions that are performed on an application as displayed in the following figure. To view the detailed course of the action, click action.

Brownfield Applications Overview

Brownfield applications are created to manage existing VMs that are currently not managed by Calm. To create a brownfield application, Calm must communicate with the VMs that are not managed by Calm. After the application is created, the application runs like any other Calm application.

Brownfield Applications - Key Points

The following are the key points you must consider before you create a brownfield application.

You need administrator privileges to create a brownfield application.
For the quota utilization check and VM update configuration to work accurately, you must either select a single VM per service or the VMs that have the same configuration.
In Calm, the update configuration is stored as a single element per service and applicable from the first VM instance. When you select multiple VMs with different configurations in a service and update the configuration, the update configuration applies to the first VM instance. The same configuration is then followed for all the remaining VM instances.

Let’s say you selected VM1 and VM2 for the service with a RAM of 4 GB and 8 GB respectively. If you define the update configuration to increase the RAM by 1 GB and run the action, the update applies to VM1 to increase the RAM to 5 GB. The same configuration is then followed for VM2 to change the RAM from 8 GB to 5 GB causing undesirable results in both the update configuration and quota utilization checks.
When you add credentials for the VMs, ensure that the credentials are same for all the VMs.
After a VM is created, the VM takes some time to be listed for brownfield import.
Brownfield applications do not support snapshot and restore.

For information on how to create a brownfield application, see Creating Brownfield Application.

Creating Brownfield Application

Brownfield applications are created to manage existing VMs that are currently not managed by Calm. Perform the following procedure to create brownfield application.

About this task

Video: Creating Brownfield Application

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the Brownfield Applications tab.
The Brownfield Application page is displayed.
Click + Create Brownfield Application .
The Brownfield Import window is displayed.
Enter the blueprint application name in the Name field.
Optionally, enter a description about the application in the Description field.
Select a project from the Project list.
Click Proceed .
The brownfield application editor page is displayed.
To add a service, click + next to the service.
Enter the service name in the Service Name field.
Select one of the following type of deployment.
- Select Greenfield if all the existing VMs are manged by Calm.
- Select Brownfield if the existing VMs are currently not managed by Calm.
If you have selected Brownfield , then do the following.
1. Select the VMs from the Select Machines list.
  
  Note: For the quota utilization check and VM update configuration to work accurately, ensure that you either select a single VM or the VMs that have the same configuration.
2. Configure the connection. For more information, see Configuring Check Log-In.
3. Add credentials. For more information, see Adding Credentials.
If you have selected Greenfield , then configure the VM, package, and service. To configure VM, package, and service refer to Configure Multi-VM, Package, and Service.
Click Save .
The brownfield application is created and listed under the Brownfield Application list.

What to do next

Launch the brownfield application from the Applications tab. For more information, see Launching Brownfield Application.

Launching Brownfield Application

You must launch the configured brownfield applications to be managed by Calm.

About this task

Video: Launching Brownfield Applications

Before you begin

Ensure that you have created the brownfield applications. For more information, see Creating Brownfield Application.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the Brownfield Applications tab.
The Brownfield Application page is displayed.
Click the brownfield application that you want to launch.
The blueprint details page is displayed.
Click Launch .
The brownfield application page is displayed and the application is listed under the Applications tab.

Advanced Calm Application Actions

Installing NGT Apps

Nutanix Guest Tools (NGT) is a software bundle that you can install in a guest virtual machine (Microsoft Windows or Linux) to enable the advanced functionality provided by Nutanix. For more information about NGT, see the Prism Central Guide . Perform the following procedure to install NGT services on your VM. NGT services are only applicable for AHV clusters.

About this task

Note: The Nutanix Guest Agent service is now upgraded to Python 3.6. For successful installation of NGT on Windows VMs, apply the Update for Universal C Runtime in Windows (Microsoft KB 2999226) to upgrade your Windows VMs to Python 3.6.

Before you begin

Ensure that NGT requirements and limitations are met. For more information, see the Prism Central Guide .
Ensure that you have configured the cluster virtual IP address.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application that you want to install NGT on.
The Overview tab is displayed.
Under Manage tab, click the Install NGT Apps play button.

Figure. Install NGT Click to enlarge

The Install NGT Apps screen appears.
To restore desired files from the VM, click the Enable Self Service Restore (SSR) check box. This step is optional.
The self-service restore (SSR) allows virtual machine administrators to do a self-service recovery from the Nutanix data protection snapshots with minimal administrator intervention. For more information, see the Prism Central Guide.

The Self-Service Restore feature is enabled for the VM.
To enable VSS, click the Enable Volume Snapshot Service (VSS) check box. This step is optional.
Volume Shadow Copy Service (VSS; also known as Shadow Copy or Volume Snapshot Service) creates an application-consistent snapshot for a VM and is limited to consistency groups consisting of a single VM. Enabling VSS allows you to take application-consistent snapshots.
Do one of the following:
1. To restart the VM after NGT installation, click Restart as soon as the install is completed .
2. To skip the restart of the VM after VM installation, click Skip restart .
Click Enter Credentials and do the following.
1. In the User name field, enter user name.
2. In the Password field, enter the password.
Do one of the following.
- To install NGT, click Done .
- To mount the NGT on the VM and install it later, click Skip and Mount .
- If NGT is already mounted on a VM, to unmount the NGT from the VM, click Unmount .
- To cancel NGT installation, click Cancel .

Managing NGT Apps

After you install NGT service on a VM, you can either enable or disable VSS and SSR services by using the Manage NGT Apps play button. To know more VSS and SSR services, see the Nutanix Guest Tools section in the Prism Web Console Guide .

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application on which you want to manage NGT services.
The Overview tab is displayed.
Under Manage tab, click the Manage NGT Apps play button.
The Manage NGT Apps screen appears.
Under the Manage NGT Apps scree, click the Enable or Disable button to enable or disable self-service restore or volume snapshot service respectively.
Click Confirm .
The changes are saved and you can use the NGT services based on your selection.

Uninstalling NGT Apps

If you do not want to recover application details after the host VM becomes unavailable, uninstall the NGT application. Perform the following procedure to uninstall NGT services for your application.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application that you want to install NGT on.
The Overview tab is displayed.
Under Uninstalling NGT tab, click the Uninstall NGT Apps play button.
A confirmation message appears to uninstall NGT.
Click Uninstall .
NGT Apps is uninstalled from the VM.

Snapshot and Restore

A snapshot preserves the state and data of an application virtual machine at a specific point in time. You can create a snapshot of a virtual machine at a particular point in time and restore from the snapshot to recreate the application from that time.

On a Nutanix platform, you can use the snapshot and restore feature in both single-VM and multi-VM applications. On VMware, AWS, and Azure platforms, you can use the snapshot and restore feature only in a single-VM application.

While the snapshot and restore feature is available by default for VMware, AWS, and Azure platforms, you need to add the snapshot/restore configuration to the single-VM or multi-VM blueprint on Nutanix. Adding the configuration to the blueprint generates separate profile actions for snapshot and restore. For more information, see Configuring Single-VM Blueprints with Nutanix for Snapshots and Configuring Multi-VM Blueprints on Nutanix for Snapshots.

Snapshot and Restore for Nutanix Platform

Snapshot and restore of an application VM that runs on a Nutanix platform involves the following configurations and actions:

Policy Definition for Snapshots
Blueprint Configuration for Snapshots
Application Launch with Snapshot Policy
Snapshot Creation
Snapshot Restore

Policy Definition for Snapshots

As a project admin, you define snapshot policies in a project. Snapshot policies help you define rules for taking snapshots of application VM. The policy determines the overall intent of the snapshot creation process and the duration of managing those snapshots. You can configure your snapshot policy to manage your snapshots on a local cluster, on a remote cluster, or both.

Local Snapshots: When you select local snapshots in the policy and use the policy for snapshots, the snapshots of the VMs reside on the same cluster as that of the VMs.
Figure. Local Snapshots Click to enlarge
Remote Snapshots: When you select remote snapshot in the policy and use the policy for snapshots, the snapshots of the VMs running on the primary cluster are stored on a remote cluster. The primary cluster and the remote cluster must be associated with the same Prism Central. When you restore the VMs, the snapshots are restored to the primary cluster to bring up the VMs.
Figure. Remote Snapshots Click to enlarge

Remote snapshots are particularly useful when your Prism Central has a computer-intensive cluster managing workloads and a storage-intensive cluster managing your data, snapshots, and so on.

For more information about creating a snapshot policy, see Creating a Snapshot Policy.

Blueprint Configuration for Snapshots

You define snapshot and restore configuration for each service in a blueprint. You can configure the service to create snapshots locally or on a remote cluster. In case your multi-VM blueprint has multiple replicas of the service, you can configure the action to take snapshot only for the first replica or the entire replica set.

The snapshot/restore definition of a service generates the snapshot configuration and its corresponding restore configuration. You can use these configurations to modify your snapshot and restore setup. The snapshot/restore definition also generates application profile actions that you can use to create or restore snapshots. You can add more tasks and actions as part of your snapshot and restore to define actions you might want to take on your services. For example, shutting down the application and the VM before taking the snapshot or restarting the VM or services before a restore.

Note: The snapshot and restore configurations in a service are integrated to each other and cannot be managed individually.

For more information on snapshot and restore configuration, see Blueprint Configuration for Snapshots and Restore.

Application Launch with Snapshot Policy

You associate a policy defined in a project when you launch the application. Depending on the snapshot configuration that you provide in the blueprint, you can select the policy and the cluster in which the snapshot will be stored.

If you defined remote snapshot in the blueprint, then you can view all the policies that allow you to take a remote snapshot. You can select a policy and the corresponding clusters before you launch the application.

For more information, see Launching a Blueprint.

Snapshot Creation

Like other profile actions, the profile actions for snapshot and restore appear on the Manage tab of an application. The snapshots created are listed under the Recovery Points tab of the application. When you create multiple snapshots as part of one action, they appear as a snapshot group. You can expand the group to view the snapshots, their corresponding services, and location. For more information, see Creating Snapshots on a Nutanix Platform.

Snapshot Restore

Restore follows the same configuration that the snapshot has. To restore, you specify the variables and select applicable recovery points depending on the VM. For more information, see Restoring VM Details from Snapshots on a Nutanix Platform.

Creating Snapshots on a Nutanix Platform

Perform the following procedure to create application-consistent or crash-consistent snapshots. Application-consistent or crash-consistent snapshots are used to capture and recover all of the VM and application level details. Application-consistent snapshots can also capture all data stored in the memory and transactions in process.

About this task

Note: Only crash-consistent snapshots are supported for multi-VM applications on a Nutanix platform.

Before you begin

Ensure that you have installed NGT Apps to take application-consistent snapshots. For more information, see Installing NGT Apps.

Procedure

Click the Applications icon in the left pane.
On the Applications page, click the application for which you want to create snapshots.
On the Manage tab, click the snapshot action you created for the application VM.
The Run Action: Snapshot window appears.
In the Snapshot Name field, enter a name for the snapshot.
You can use Calm macros to provide a unique name to the snapshot. For example, snapshot-@@{calm_array_index}@@-@@{calm_time}@@ .
For single-VM applications, select App consistent for application-consistent snapshots or Crash consistent for crash-consistent snapshots.
Note:
- You can create application-consistent snapshots after you have installed NGT Apps with VSS service enabled. For more information about snapshots, see the Nutanix Guest Tools section in the Prism Web Console Guide .
- For multi-VM application, the default snapshot type is Crash consistent .
Click Run .
The saved snapshots are available under Recovery Points tab.

What to do next

You can recover the VM details for an application from the created snapshots. For more information, see Restoring VM Details from Snapshots on a Nutanix Platform.

Restoring VM Details from Snapshots on a Nutanix Platform

You can restore the VM details of an application after the host VM becomes unavailable. Perform the following procedure to restore an application from the snapshots.

Before you begin

Ensure that you have captured the snapshots for an application. For more details, see Creating Snapshots on a Nutanix Platform.

Note:

A restored VM or a cloned VM does not have NGT service installed even if the snapshot or the source VM has NGT service installed.
Restore operation for a VM fails if the snapshot is configured with static IP address and IP pool is not configured.
When you perform a restore operation with a snapshot having static IP address configured, the restored VM comes up with a new IP address from the IP pool specified in IPAM. To ensure that the restored VM has the same static IP address as the old VM,remove the NIC that has this static IP address configured from the old VM, and attach the configuration to the new restored VM. If there is a failure during restore operation, perform an update operation on the VM to ensure that the VM is in valid state.

Procedure

Click the Applications icon in the left pane.
On the Applications page, click the application for which you want to restore the VM details from the snapshots.
On the Manage tab, click the restore action you created for the application.
The Run Action: Restore window appears.
Select a recovery point from the Select Recovery Point list.
The Select Recovery Point list shows all the snapshots taken for the application VM.
Click Run .
The application is restored from the snapshot in a new VM and the existing VM moves to power off state. If you selected the click the Delete older VM after restore check box while configuring the application blueprint, the existing VM is deleted after restoring the application VM.

Creating Snapshots on a VMware Platform

A snapshot preserves the state and data of a virtual machine at a specific point in time. You can create a snapshot of a virtual machine at any time and revert to that snapshot to recreate the application from that time. For more information, see the VMware Documentation . Perform the following procedure to create a snapshot.

Before you begin

Ensure that the VMware Tool is installed and the VM is in powered on state to create the quiesce snapshots.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application for which you want to create snapshots.
The Overview tab is displayed.
Click Snapshot .

Figure. Snapshot VMware Click to enlarge

The Snapshot screen appears.
In the Snapshot Name field, enter a name for the snapshot.
Optionally, in the Snapshot Description field, enter a brief description about the snapshot.
Optionally, click one of the following options.
- Snapshot VM's Memory : Use this option to capture the memory of the virtual machine and the power settings. Memory snapshots take longer to create, but allow reversion to a running virtual machine state as it was when the snapshot was created.
- Enable Snapshot Quiesce : Use this option to pause or alter the state of running processes on the virtual machine and take consistent and usable backup. When you quiesce a virtual machine, VMware Tools quiesce the file system in the virtual machine. The quiesce operation pauses or alters the state of running processes on the virtual machine, especially processes that might modify information stored on the disk during a restore operation.
By default, Snapshot VM's Memory is selected. If you do not select any option, a crash-consistent snapshot is created, which you can use to reboot the virtual machine. For more information, see the VMware Documentation .
Click Save .
The saved snapshots are available under Snapshots tab.

What to do next

You can recover the VM details for an application from the snapshots you created. For more information about recovering application level information, see Restoring VM Details from Snapshots on a Nutanix Platform.

Restoring VM Details from Snapshots on a VMware Platform

You can restore the VM details of an application after the host VM becomes unavailable. Perform the following procedure to restore an application VM details from a snapshot.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application for which you want to restore the VM details from the snapshot you created.
The Overview tab is displayed.
Click the Snapshots tab.
The Snapshots tab lists all the snapshots created for the application.
Click Restore next to a snapshot from which you want to restore the VM details.
A confirmation message appears to restore the VM details.
Click Confirm .
The application is restored from the snapshot in the same VM.

Creating Snapshots on an AWS Platform

About this task

You can back up the data on your Amazon EBS volumes to Amazon S3 by taking point-in-time snapshots. Snapshots are incremental backups, which means that only the blocks on the device that have changed after your most recent snapshot are saved. For more information, see AWS Documentation . Perform the following procedure to create a snapshot on a AWS platform.

Before you begin

Ensure that the you have an AWS account with the required privileges to create a snapshot. For more information, see Configuring AWS User Account with Minimum Privilege and AWS Policy Privileges sections.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application for which you want to create snapshots.
The Overview tab is displayed.
Click Snapshot .

Figure. Snapshot AWS Click to enlarge

The Save Snapshot screen appears.
In the AMI Name field, enter a name for the snapshot.
In the AMI Description field, enter a brief description about the snapshot. This step is optional.
Click the No Reboot check box to avoid shutting down the Amazon EC2 instance before creating the image. This step is optional.
Click Save .
The saved snapshots are available under the AMI tab.

Restoring VM Details from Snapshots on an AWS Platform

You can restore the VM details of an application after the host VM becomes unavailable. Perform the following procedure to restore an application VM details from a snapshot. Ensure that you have captured the snapshots for the application VM.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application for which you want to restore the VM details.
The Overview tab is displayed.
Click the AMIs tab.
The AMIs tab lists all the snapshots created for the application.
Click Restore next to a snapshot from which you want to restore the VM.
A confirmation message appears to restore the VM details.
Click Confirm Restore .
The restore action creates a new VM from the snapshot that has the same configuration as the source application with a different IP address.

Creating Snapshots on an Azure Platform

Creating a snapshot of an application virtual machine on the Azure platform creates a point-in-time copy of your operating system and data disks associated with the VM. The snapshots you create can then be used to create a new VM with the same configurations as the source application VM.

Before you begin

Ensure that you have an Azure account with the required privileges to create a snapshot. For more information, see Configuring Azure User Account with Minimum Privilege.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application for which you want to create snapshots.
The Overview tab is displayed.
Click Snapshot .

Figure. Snapshot Azure Click to enlarge

The Save Snapshot screen appears.
In the Snapshot Name field, enter a name for the snapshot.
Optionally, in the Snapshot Description field, enter a brief description about the snapshot.
From the Snapshot Type list, select the storage type to store your snapshot. Your options are:
- Standard HDD
- Premium SSD
- Zone-redundant
For more information about the storage type, refer to the Azure documentation.
Click Save .
You can track the progress of the snapshot creation process on the Audit tab. The snapshots are stored on the Snapshots tab.

Restoring VM Details from Snapshots on an Azure Platform

You can restore the VM details of an application after the host VM becomes unavailable. The VM snapshot that you create on an Azure platform consists of the snapshot of operating system and data disks. When you restore the VM details, a new VM is created using the snapshots of the disks.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application for which you want to restore the VM details.
The Overview tab is displayed.
Click the Snapshots tab.
The Snapshots tab lists all the snapshots created for the applications.
Click Restore next to the snapshot from which you want to restore the VM.
The Restore VM dialog box appears.
Enter the restore name for the application VM.
Optionally, select the Delete Previous VM to delete the original VM from which the snapshot was created.
Click Confirm Restore .
The restore action creates a new VM from the snapshot that has the same configuration as the source application.

Deleting Snapshots

Perform the following procedure to delete the snapshots created for the VM under an application.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application for which you want to delete snapshots.
The Overview tab is displayed.
Do one of the following.
- If your application is deployed on a Nutanix cluster, click the Recovery Points tab.
- If your application is deployed on a VMware platform, click the Snapshots tab.
- If your application is deployed on an AWS platform, click the AMI tab.
Click the Delete button next to the snapshot you want to delete.
Click Confirm .
The snapshot is deleted.

Update VM Configurations of Running Applications

The update configuration feature allows you to update the virtual machine of a running application to a higher or lower configuration. Using this feature, you can modify VM specifications such as the vCPU, memory, disks, networking, or categories (tags) of a running production application with minimal downtime.

The process to update VM configuration of a running application on Nutanix is different from other providers.

Note: Updating VM configuration of a running multi-VM application is supported only on a Nutanix platform.

Update VM Configuration of an Application on Nutanix

To update configurations of a running single-VM or multi-VM applications on Nutanix, you need to perform the following steps:

Add an update configuration to the application blueprint.
For more information, see Update Configuration for VM.
Run the corresponding action to update VM specifications.
You can update VM specifications from the Manage tab of the application. While launching the update, you can define the variables, verify the updates defined for the service by looking at the original value and updated value. You can also modify the values if the component is editable. You can also check the cost difference at the top of the page before applying the changes. For more information, see Updating the VM Configuration of an Application on Nutanix.

Update VM Configuration of an Application on Other Providers

The option to update VM configuration of a running single-VM application on VMware, AWS, or Azure is available by default on the Overview tab of the application. The attributes that you can update depends on the provider account you selected for the application.

For more information about updating VM configuration on a VMware platform, see Updating the VM Configuration of an Application on a VMware Platform.
For more information about updating VM configuration on a AWS platform, see Updating the VM Configuration of an Application on an AWS Platform.
For more information about updating VM configuration on a Azure platform, see Update the VM Configuration of an Application on an Azure Platform.

Updating the VM Configuration of an Application on Nutanix

You can run the update configuration to modify the VM specifications, such as the vCPU, memory, disks, networking, or categories of a single-VM or multi-VM application.

About this task

Note:

If you update configuration of an application after cloning from a source application, the update fails if the source application has static IP address configured.
When you update configuration of an application, the CD-ROM attached to mount NGT services is removed.

Before you begin

Ensure that your blueprint developer has added the update configuration before launching the application blueprint. For more informations, see Update Configuration for VM.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application that you want to edit.
On the Manage tab, click the action corresponding to the update configuration.
The Run Action window appears.
Under the VM Configuration section, enter the change factor value in the Updated field for the vCPUs , Core per vCPU , and Memory (GiB) .
The ability to edit a VM configuration attribute and the maximum or minimum value to which the attribute can be updated depend on the application blueprint configuration. You can update only those VM configuration attributes that your blueprint developer has enabled for editing. The Updated field does not allow you to enter a value that is beyond the minimum or maximum value configured for the attribute.
Under the Disks section, edit the following.
- Enter the value in the Updated field to increase the size of the existing disk.
  Note: You cannot decrease the size of an existing disk.
  
  You can click the delete icon to remove the existing disk.
- Enter the value in the Updated field to increase or decrease the size of any new disk. The updated value must be within the maximum or minimum value your blueprint developer has configured in the application blueprint.
  You can click the delete icon to remove any new disk if your blueprint developer has enabled it in the application blueprint.
Under the Categories section, delete any existing categories from the application if your blueprint developer has enabled it in the application blueprint configuration.
Under the Network Adapters section, delete any existing NICs from the application if your blueprint developer has enabled it in the application blueprint configuration.
To launch the update configuration, click Run .

Updating the VM Configuration of an Application on a VMware Platform

You can run the update configuration to modify parameters, such as VM configurations, controllers, disks, and network adapters of a single-VM application running on a VMware platform.

About this task

Note:

If there is a mismatch of the NICs or Network setting count after updating an application VM and you try to clone the application, the cloned application fails.
You cannot add or delete the application properties simultaneously.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application that you want to edit.
On the Manage tab, click Update VM Configuration .
The Update screen for the application VM is displayed.
In the VM Location field, specify the location of the folder in which the VM must reside when you update. Ensure that you specify a valid folder name already created in your VMware account.
To create a subfolder in the location you specified, select the Create a folder/directory structure here check box and specify a folder name in the Folder/Directory Name field.

Select the Delete empty folder check box to delete the subfolder created within the specified location, in case the folder does not contain any VM resources. This option helps you to keep a clean folder structure.
Select the CPU Hot Add check box if you want to increase the VCPU count of a running VM.
Support for CPU Hot Add depends on the Guest OS of the VM.

Note: With CPU Hot Add , you can only increase the vCPU count. If you decrease the vCPU count or update the Cores per vCPU, the VM will require a restart.
Update the vCPUs and Core per vCPU count.
Select the Memory Hot Plug check box if you want to increase the memory of a running VM.
Support for Memory Hot Plug depends on the Guest OS of the VM.

Note: With Memory Hot Plug , you can only increase the memory. If you decrease the memory, the VM will require a restart.
Update the memory in the Memory field.
Under the Controllers section, you can add or update the SCSI or SATA controllers.

Note: You cannot delete a controller if it is attached to a disk.
Under the Disks section, click the + icon to add vDisks and do the following:
1. Select the device type from the Device Type list.
  You can either select CD-ROM or DISK .
2. Select the adapter type from the Adapter Type list.
  You can select IDE for CD-ROM or SCSI , IDE , or SATA for DISK.
3. Enter the size of the disk in GiB.
4. In the Location field, select the disk location.
5. If you want to add a controller to the vDisk, select the type of controller in the Controller list to attach to the disk.
  
  Note: You can add either SCSI or SATA controllers. The available options depend on the adapter type.
6. In the Disk mode list, select the type of the disk mode. Your options are:
  - Dependent : Dependent disk mode is the default disk mode for the vDisk.
  - Independent - Persistent : Disks in persistent mode behave like conventional disks on your physical computer. All data written to a disk in persistent mode are written permanently to the disk.
  - Independent - Nonpersistent : Changes to disks in nonpersistent mode are discarded when you shut down or reset the virtual machine. With nonpersistent mode, you can restart the virtual machine with a virtual disk in the same state every time. Changes to the disk are written to and read from a redo log file that is deleted when you shut down or reset.
Note:
- You can also edit the disk size and disk mode. However, decreasing the disk size of a saved configuration is not allowed.
- You can delete a saved disk. However, you cannot add and delete the disks simultaneously.
Under the Network Adapter section, click the + icon to add an NIC and cofigure the Adapter Type and Networks fields.

Note: You can only update the Networks field of an existing NIC.
Under the Tags section, select tags from the Category: Tag pairs field.
You can assign tags to your VMs so you can view the objects associated with your VMs in your VMware account. For example, you can create a tag for a specific environment and assign the tag to multiple VMs. You can then view all the VMs that are associated with the tag.
Click Update to run the update configuration.
The application with updated VM configuration is saved on the Application tab.

Updating the VM Configuration of an Application on an AWS Platform

You can run the update configuration to modify parameters, such as instance type, IAM role, security groups, tags, and storage of a single-VM application running on an AWS platform.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application that you want to edit.
On the Manage tab, click Update VM Configuration .
The Update screen for the application VM is displayed.
Under the VM Configuration section, update the instance type from the Instance Type list.
The Region , Availability Zone , Machine Image , Key Pairs , and VPC fields are automatically selected. You cannot update these fields.
To update te IAM role, select the role from the IAM Role list.
An IAM role is an AWS Identity and Access Management entity with permissions to make AWS service requests.
To enable the security group rule, select the Include Classic Security Group check box.
From the Security Groups list, select security groups.
To add tags to the application, add the key and value pair in the Key and Value fields respectively.
To update the storage of the application, do the following under the Storage section:
1. For the existing storage, update the memory in GB in the Size(GiB) field and volume type of the storage device from the Volume Type list for the root storage.
2. Click the + icon to add a storage and specify the device, size, and volume type.
Click Update to run the update configuration.
The application with updated VM configuration is saved on the Application tab.

Update the VM Configuration of an Application on an Azure Platform

You can run the update configuration to modify parameters, such as VM configurations, controllers, disks, or network adapters of a single-VM application running on an AWS platform.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application that you want to edit.
On the Manage tab, click Update VM Configuration .
The Update screen for the application VM is displayed.
Under the VM Configuration section, update the hardware profile from the Hardware Profile list.
The number of data disks and NICs depends upon the selected hardware profile. For information about the sizes of Windows and Linux VMs, see Windows and Linux Documentation.

The Instance Name , Resource Group , Location , and Availability Option fields are automatically selected. You cannot update these fields.
Under the Storage Profile section, do the following:
1. Select the Storage Type and Disk Caching Type and specify the Size and Disk LUN for the existing data disk.
2. Click the + icon to add a data disk. Select the Storage Type and Disk Caching Type and specify the Size and Disk LUN for the new data disk.
Under the Network Profile section, click the + icon to add NICs as per your requirement and do the following for each NIC:
1. Select a security group from the Security Group list.
2. Select a virtual network from the Virtual Network list.
3. Under Public IP Config , enter a name, and select an allocation method.
4. Under Private IP Config , select an allocation method.
  If you selected Static as the allocation method, then enter the private IP address in the IP Address field.
You can also update the Security Group , Subnet , and public or private IP config Allocation Method of the existing NIC.
To add tags to the application, add the key and value pair in the Key and Value fields respectively.
Click Update to run the update configuration.
The application with updated VM configuration is saved on the Application tab.

Updating Actions and Credentials of an Application

You can add or update the credential, custom actions, post delete tasks, or package uninstall tasks from the Overview tab of a single-VM application.

About this task

Note:

For this release, support for credential or action update is not available for the applications running on Xi cloud.
Dynamic variables are runtime editable by default, but you cannot mark variable as runtime editable if you add the variables while updating an application.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the single-VM application for which you want to update the credential or actions.
From the Update list, select Update Actions and Credentials .
The Update screen is displayed.
In the Credentials and Connection area, click Edit .
The Credentials and Connection page is displayed.
To add a credential, click Add Credential and do the following.
1. In the Add Credential window, enter name of the credential in the Credential Name .
2. Enter user name in the Username field.
3. Select the secret type from the Secret Type list.
  You can either select password or SSH private key.
4. Do one of the following.
  - If you have selected password, enter the password in the Password field.
  - If you have selected SSH Private Key, enter or upload the SSH private key in the SSH Private Key field.
  Optionally, if the private key is password protected, click +Add Passphrase to provide the password.
To delete an existing credential, click Delete against the credential.

Note: You can also update the user name or password of an existing credential. However, if you have logged on as an operator, you can only update the password.
Under Connection , to update the credential and check the logon status after creating the application, select the credential from the Credentials list.
You can update the credential to check the logon status only if you have enabled the Check log-in upon create field while configuring the blueprint.
Optionally, to add a post delete task for the application, in the Post Delete area, click Edit . For more information see Adding a Pre-create or Post-delete Task.
Optionally, to create a task to uninstall a package, click Edit next to the Package area and do the following.
1. Click + Task .
2. Enter the task name in the Task Name field.
3. To create the type of task, select the type from the Type list.
  The available options are:
  - Execute : To create the Execute task type, see Creating an Execute Task.
  - Set Variable : To create the Set Variable task type, see Creating a Set Variable Task.
  - HTTP Task : To create the HTTP Task type, see Creating an HTTP Task.
  - Delay : To create the Delay task type, see Creating a Delay Task.
4. To add variables to the post delete task, click the Package Uninstall Variables tab.
5. In the Variables pane, click the + icon to add variable types
6. In the Name field, enter a name for the variable.
7. From the Data Types list, select one of the base type variable or import a custom library variable type.
8. If you have selected a base type variable, configure all the variable parameters. For more information about configuring variable parameters, see Creating Variable Types.
9. If you have imported a custom variable type, all the variable parameters are automatically filled.
10. Select the Secret check-box if you want to hide the value of the variable.
11. To save the package uninstall task, click Done .
12. To establish a connection between tasks, click Add Connector and use the arrow to create connection between tasks.
13. To delete a task, click the Delete button next to the task.
  You can delete a task only while adding a new task. If you are updating the existing task, you cannot delete the task.
Optionally, to add another action to the application, click + Add Action next to the Actions area and do the following.
1. Click + Add Task .
  The task inspector panel is displayed.
2. In the task inspector panel, click the Task button.
3. Enter the task name in the Task Name field.
4. Select the type of tasks from the Type list.
  The available options are:
  - Execute : Use this task type to run eScripts on the VM. To create the Execute task type, see .Creating an Execute Task
  - Set Variable : Use this task to change variables in a blueprint. To create the Set Variable task type, see Creating a Set Variable Task.
  - HTTP Task : Use this task type to query REST calls from a URL. An HTTP task supports GET, PUT, POST, and DELETE methods. To create the HTTP Task type, see Creating an HTTP Task.
  - Delay : Use this task type to set a time interval between two tasks or actions. To create the Delay task type, see Creating a Delay Task.
  The task is created.
5. To add another task, click Add Task in the task editor area.
6. To establish a connection between tasks, click Add Connector and use the arrow to create connection between tasks.
7. To delete a task, click the Delete button next to the task.
8. To add variables to the task, click the Variables tab.
9. In the Variables pane, click the + icon to add variable types in your blueprint.
10. In the Name field, enter a name for the variable.
11. From the Data Types list, select one of the base type variable or import a custom library variable type.
12. If you have selected a base type variable, configure all the variable parameters. For more information about configuring variable parameters, see Creating Variable Types.
13. If you have imported a custom variable type, all the variable parameters are auto filled.
14. Select the Secret check-box if you want to hide the value of the variable.
15. To save the task, click Done .
To save the updated credentials and tasks for the application, click Update .

Creating an Image on a Nutanix Platform

An image is a template for creating new instance or VM. Calm allows you to create images from an existing single-VM or multi-VM application running on a Nutanix platform. Perform the following procedure to create an image from an existing application.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application from which you want to create an image.
To create an image on a single-VM application, click Create Image on the Applications page.

Figure. Create Image - Single VM Application Click to enlarge
To create an image on a multi-VM application, select the service on the Services tab, and then click Create Image in the Inspector Panel.

Figure. Create Image - Single VM Application Click to enlarge
Click the check-box next to the disk from which you want to create an image.
If the application has multiple disk images available, you can also select multiple disks.
Under the Image Details section, type a name and a description for the new image in the Name and Description fields respectively.
If you have selected multiple disk images, repeat the steps for all the Image Details sections.
Click Save .
The new image is created and available in the Image list under the VM Configuration section. You can use the image while creating a single-VM or multi-VM application.

Cloning an Application

Perform the following procedure to clone an application. The cloned application has the same VM configuration as the source application from which it is cloned.

About this task

Note: You can clone an application if you are using Nutanix, VMware, or AWS as your provider.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application on which you want to make a clone.
The Overview tab is displayed.
Click Clone .
The Clone screen appears.
In the Cloned Application Name field, enter a name for the cloned application.
In the Description field, enter a brief description about the cloned application.
Click Save .
After you successfully cloned an application, you can view the link to the cloned application in the audit log of the source application.
Note: In a Nutanix cluster, a restored VM or a cloned VM has NGT service installed if the snapshot or the source VM has NGT service installed.

What to do next

You can click the link of the cloned application to view the Overview tab of the cloned application. To view the source application, click the Clone From field on the Overview tab.

Deleting an Application

You can delete the unwanted applications from the Applications tab.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Select the check box against the application that you want to delete.
The Action list is displayed at the top of the Application page.
Select Delete from the Action list.
Delete Application window is displayed.
Click Confirm .
The application is deleted from the Application tab.

Executing User Level Actions

You can define and create custom or user-level actions while configuring a blueprint. Perform the following procedure to run the user-level actions.

Before you begin

Ensure that you have created a custom action during configuring a blueprint.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application that you want to run a user-level action.
The Overview tab is displayed.
Under the Manage tab, click the action that is created by the user.

Figure. User Level Action Click to enlarge

The custom action starts running for the application.

Executing System Level Actions

System-level actions are pre-defined actions that you can run on an application. Perform the following procedure to execute the system-level actions.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application that you want to execute a system generated action.
The Overview tab is displayed.
Under the Manage tab, click one of the following type of action.

Figure. System Level Action Click to enlarge
- Create : Creates an application but cannot be performed once the blueprint is created.
- Start : Starts an application.
- Restart : Restarts an application.
- Stop : Stops an application.
- Delete : Deletes an application including the underlying VMs on the provider side.
- Soft Delete : Deletes the application from the Calm environment but does not delete the VMs on the provider side.
- Install NGT Apps : Installs NGT services for your application. To install NGT, see Installing NGT Apps.
- Manage NGT Apps : Manages NGT services for your application . You can enable or disable app-consistent and crash-consistent snapshots. For more information, see Managing NGT Apps.
- Uninstall NGT Apps : Uninstalls NGT services from the VM. For more information, see Uninstalling NGT Apps.

Policies in Calm

Scheduler Overview

Scheduler allows you to schedule application action and runbook executions. You can schedule recurring jobs and one-time jobs for critical operations throughout the application life cycle.

You can schedule any user-defined application actions, create or restore application snapshots (only AHV), or any pre-defined system actions such as Start, Stop, Restart, Delete, and Soft Delete. For example, you can schedule a Stop action and a Start action on a single-VM Calm application to run at a particular date and time.

Scheduler supports two types of entities.

Application action. You can use scheduler to schedule application actions, such as Start and Stop, to run at a particular date and time. You can also schedule any custom-defined actions and snapshot create and restore action for AHV.
Runbook execution. You can schedule runbooks to run on a particular date and time.

Scheduler jobs have a role ownership. A user can modify the job that you created if the user has access to the entity and Allow Collaboration is enabled in the associated project. For example, if you create a scheduler job for an application action as a developer, a consumer that has access to the same application can modify the job. If Allow Collaboration is disabled in the project, then only the creator of the scheduler job can modify the job. For information on the role required to schedule application action and runbook execution, see Role-Based Access Control in Calm.

Creating a Scheduler Job

Create a scheduler job to perform an application action or runbook execution.

Before you begin

Ensure that you have enabled the policy engine on the Settings page. For details about enabling the policy engine, see Enabling policy Engine.

Procedure

Click the Policies icon in the left pane.
On the Scheduler tab, click the +Create Job button to create a job.
The Create Job page appears.
Figure. Create Scheduler Job Click to enlarge
In the Job Name field, type a name for the job.
Enter a description for the job. This step is optional.
From the Select Action list, select an entity type that you want the scheduler job to run on. Your options are:
- Select Application Action to schedule application actions such as start and stop, schedule any user-defined actions, or snapshot create and restore action for AHV.
- Select Execute Runbook to schedule the execution of a runbook.
From the Project list, select the project associated with your application or runbook.
Click Action Details .
If you have selected Application Action as the action type, then do the following:

Figure. Application Action Click to enlarge
1. From the Select Application list, select the application for which you want to schedule an action.
  The Select Application list displays only those applications that are associated with the project you selected on the Job Details tab.
2. From the Select Application Action list, select an application-level action or a user-defined action.
3. If you select any user-defined action, then review or edit the variables for the selected action.
If you have selected Execute Runbook as the action type, then do the following:

Figure. Execute Runbook Click to enlarge
1. From the Runbook list, select the runbook for which you want to schedule an action.
  The Runbook list displays only those runbooks that are associated with the project you selected on the Job Details tab.
2. From the Default Endpoint list, select a default endpoint for the runbook execution.
3. Verify the variables and endpoint data (such as base URLs, IP addresses, and VMs) defined for the runbook.
Click Set Schedule .
Under Schedule Type , select Recurring Job to run the job at regular intervals or One-Time Job to run the job only once.
If you have selected Recurring Job , then do the following:

Figure. Recurring Job Click to enlarge
1. Under Starts , define the start date and time in the Start on and Start at fields if you want to start the job at a particular date and time. This step is optional.
2. Under Ends , select Never to run the job indefinitely or On to define the ending date and time for the job.
3. In the Select Timezone field, select a location to define the time zone for the schedule.
4. Under How often does the job occur section, select an option in the Every field to define the frequency of the job schedule.
  You can also enter a cron expression to define the frequency of the job schedule.
  
  Depending on the option you select, you have to define specific criteria for the job frequency. For example, when you select Year , you also have to define the months, days, day of the week, hours, and minutes.
If you have selected One-Time Job , then do the following:

Figure. One-Time Job Click to enlarge
1. In the Executes on field, specify the execution date.
2. In the Executes at field, specify the execution time.
3. In the Select Timezone field, select a location to define the time zone.
Click Save .

Viewing and Updating Scheduler Jobs

You can view or update a scheduler job on the Scheduler tab of the Policies page.

About this task

Scheduler jobs have a role ownership. You can update a job that a different user has created only when you have access to the entity and collaboration is allowed in the associated project.

Procedure

Click the Policies icon in the left pane.
On the Scheduler tab, click the job that you want to view or update.

Figure. Scheduler Job Click to enlarge
On the job details page, do the following:
- On the Job Info tab, view the action type, runbook or application name, the next scheduled date, execution time or recurrence, and the state of the job. A job can show one of the following states.
  - Active: When the job is created or updated without any errors and the job has not completed the last execution and has not crossed the last execution date.
  - Inactive: When the job is created or updated with errors.
  - Expired: When the last execution of the job is complete or the job has already crossed the last execution date.
  Figure. Job Info Click to enlarge
- On the Action Details tab, view the following action details:
  - For an application action job, view the associated application and application action.
  - For a runbook job, view the associated runbook, default endpoint, variable details, and endpoint date.
- On the Execution History tab, view the scheduled time, execution status, and execution time. A job can have one of the following execution statuses.
  - Executed: When the job is already executed as scheduled.
  - Running: When the job is running as scheduled.
  - Success: When a job run is completed successfully.
  - Aborted: When you manually cancel a running or scheduled job.
  - Failed: When the job failed to execute because of some errors.
  You can also click View Logs for any executed job to go to the Audit tab and view the logs.
  
  Figure. Execution History Click to enlarge
To edit the job, click Update and edit the details of the job. For more information about the fields, see Creating a Scheduler Job.

Deleting a Scheduler Job

You can delete a scheduler job on the Scheduler tab of the Policies page.

Procedure

Click the Policies icon in the left pane.
On the Scheduler tab, click the job that you want to delete.

Figure. Scheduler Job Click to enlarge
From the Action list, click Delete .
In the Confirm Delete window, click Delete .

Approval Policy Overview

Caution: This feature is currently in technical preview. Do not use any technical preview features in a production environment.

An approval policy adds a level of governance to determine which application deployment requests or actions require approvals before they are initiated. You can use approval policies to manage your infrastructure resources, their associated costs, and compliance more effectively.

For example, consider a marketplace item that consumes a significant part of your available resources. You can use an approval policy to enable your IT administrator to review all deployment requests for that marketplace item and ensure that all requests are justified.

You can also use approval policies to enable a project administrator to review all the changes that are done as part of orchestration to a critical application instance.

Approval Policy Creation and Management

The Approvals feature is disabled by default. You must enable the feature from the Settings page before creating your approval policies. See Enabling Approvals.
You must enable the policy engine to create and manage approval policies.
Each approval policy is a defined set of conditions that you configure for specific entities in Calm. See Conditions in Approval Policies.
A policy can have multiple conditions. An approval request is generated when an event meets all the conditions defined in the policy.
As a Prism Central Admin or Project Admin, you can create approval policies for runbook execution, application launch, and application day-2 operations (system-defined or user-defined actions).
A policy can have more than one set of approvers, and the approvals are done sequentially during the policy enforcement. For example, if the policy has Set 1 and Set 2 approvers, then during the policy enforcement, Set 1 approvers have to approve the request before Set 2.
The approver must be an existing user of Prism Central.
You can enable a policy to enforce the policy on an event that matches the entity, action, and conditions of the policy or disable the policy to skip policy enforcement.
You can enable or disable approvals from the Settings page to enforce all enabled approval policies in Calm or disable all approval policy enforcement.
When the policy engine VM does not respond, the runbook execution, application launch, or application day 2 operations that match the approval policy conditions fail to process completely. To process those events, you must disable policy enforcement. See Disabling Policy Enforcement.
You can clone an existing policy and edit its information to quickly create a new policy.
You can delete an approval policy.
The approval feature is currently not supported for VMware update config, Azure update config, or AWS update config.

Approval Process

An approver receives an email notification when an approval action is required for a request.
- For email notifications, the SMTP server must be configured in Prism Central. To know how to configure the SMTP server, see the Prism Central Guide .
- Notifications are sent based on the value of the E-mail field in your Active Directory. To receive approval notifications, ensure that the value is specified in the E-mail field of the Active Directory.
  Figure. Active Directory Configuration Click to enlarge
As an approver, you can view a list of all pending approval policies and can approve or reject the request with a reason. When you approve a request, the event moves to the next task. When you reject a request, the requester is notified about the rejection of the request.
As an approver, you cannot make any updates to the original approval request.
If an Active Directory group is added as an approver, any user from the group can approve the request to move the event to the next task.
A Prism Central admin cannot override and approve pending requests. All pending requests have to be approved by the approvers assigned in the enforced policy.
The Audit tab of an application displays the confirmation of the enforced policy. The Policy Execute - Approval task is added on the Audit tab, and the task remains in the POLICY_EXEC status until the request is approved or rejected.
Figure. Policy Execute - Approval Click to enlarge

Note: Limitation: Restarting the Epsilon or Policy-Epsilon container or a Calm upgrade deletes the workflows and affects the entities that are in the approval pending status.

Approvals Page

The Policy Configurations tab provides the option to create an approval policy and lists all the approval policies you created as an admin for management.
The Approval Requests tab displays all requests that you need to approve on the Pending on me tab and all requests generated on the All requests tab.
The My Requests tab displays all the requests that you created. The Pending tab displays all pending requests, and the Reviewed tab displays all requests that the approvers reviewed. When you click a request on the Pending tab, you can view the approvers who are required to approve your request. If you are an admin, you can also view the details of the enforced policy.

Creating an Approval Policy

As a Prism Central Admin or Project Admin, you can create approval policies for runbook executions, application launch, and application day-2 operations (system-defined or user-defined actions).

About this task

Each approval policy is a defined set of conditions that you apply to specific entities in Calm. An approval request is generated when an associated event meets all the conditions defined in the policy.

Before you begin

Ensure that you have enabled the policy engine on the Settings page. For details about enabling the policy engine, see Enabling policy Engine.

Procedure

Click the Policies icon in the left pane.
On the Approvals tab, click the + Create Approval Policy button to create a policy.
On the Basic Information tab , provide the basic information such as the name, project, and the entity with its associated action. To do that:

Figure. Basic Information Click to enlarge
1. In the Name field, provide a name for the approval policy.
2. In the Description field, provide a description for the policy. This step is optional.
3. From the Select the project this policy is applicable to list, select a project with which you want to associate the approval policy.
4. From the Entity Type list, select the entity to which you want to apply the approval policy.
  You can select Runbook or Application .
5. From the Action list, select the action during which the approval policy must be enforced.
  The options in the Action list appear based on the entity you selected.
6. Click Next .
On the Set Conditions tab, specify the attribute, its associated operator, and the value for the approval policy. To do that:

Figure. Policy Condition Click to enlarge
1. From the Attribute list, search the attribute for the policy enforcement.
  The options in the Attribute list change based on the entity and the associated action you selected on the Basic Information tab.
  
  To search for a provider-specific attribute, type the provider name in the Attribute field.
2. From the Operator list, select the operator for the policy attribute.
  The options in the Operator list change based on the attribute you selected as the condition.
3. In the Value field, specify the value for the attribute-operator condition.
  With some attribute-operator combinations, an information icon appears that displays the supported units or values for the Value field. You can use the information to specify the appropriate values in the field.
  
  For system actions, you must specify the name in the action_<system action> format. For example, for the Restart action, you must specify the value as action_restart . For the list of supported system action names for approval policies, see Conditions in Approval Policies.
  
  For Azure locations, you must specify the Azure location name instead of the Azure location displayName. For example, instead of using Central US (the Azure location displayName) in the Value field, use centralus (the Azure location name).
4. Click Done next to the condition name.
5. To add another condition to the policy, click + Add Condition and then specify the attribute, operator, and value.
  You can also click the Copy icon next to the condition name of an existing condition to quickly create a new condition and edit its details.
  
  You can add multiple conditions in the policy. An approval request is generated when an event meets all the conditions defined in a policy. To view the list of conditions, see Conditions in Approval Policies.
Click Next .
On the Select Approvers tab, specify the set name, approver rule, and approvers for the policy. To do that:

Figure. Select Approvers Click to enlarge
1. In the Set Name field, specify the name of the policy set.
2. Under approval rule, select one of the following:
  - Any one can approve : Select this option if you want any approvers selected for the set to approve the action.
  - All need to approve : Select this option if you want all approvers in the set to approve the action.
3. From the Approvers list, select the approvers you want to include in the set.
  You can select and add multiple approvers in a set.
4. Click Done next to the set name.
5. To create another set, click + Add Approver Set and specify the set name, approver rule, and approvers.
  You can also click the Copy icon next to the set name of an existing set to quickly create a new set and edit its details.
  
  You can add multiple sets of approvers in the policy. The approver sets are applied sequentially during the policy enforcement. For example, if you have configured Set 1 and Set 2 approvers in your policy, then during policy enforcement, Set 1 approvers have to approve the request before Set 2.
Click Save .
In the Policy Saved confirmation window, select the Yes, enable this policy button to enable the policy.
You can click the No, keep it disabled button if you want to create the policy in the disabled state.

Conditions in Approval Policies

You can configure approval policies for specific events with different set of conditions. For example, to configure an approval policy for a marketplace item, you can use the following values:

Entity Type : Application
Action : Launch
Attribute : Blueprint Name
Operator : Contains
Value : <Name of the Marketplace Item for which you want to create an approval policy>

The following table lists the different conditions that you can define for different events in approval policies. To search for a provider-specific attribute, type the provider name in the Attribute field.

Table 1. Conditions in Approval Policies
Entity Type and Action	Provider	Attribute	Operator
Entity Type: Runbook Action: Execute	All	Runbook Name	Equals, Contains, Like
		Task Name	Equals, Contains, Like
		Endpoint Name	Equals, Contains, Like
Entity Type: Application Action: Launch	All	Substrate Type	Equals, Contains, Like
		Blueprint Name	Equals, Contains, Like
		Application Name	Equals, Contains, Like
		Application Profile Name	Equals, Contains, Like
		Estimated Application Profile Cost	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		Account Name	Equals, Contains, Like
		VM Name	Equals, Contains, Like
		Service Name	Equals, Contains, Like
		App Replicas Count	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		OS Type	Equals, Contains, Like
	Azure Specific Attributes	Azure Tag	Equals, Contains, Like
		Azure Location	Equals, Contains, Like
		Azure Instance Name	Equals, Contains, Like
		Azure Resource Group	Equals, Contains, Like
		Azure Availability Zone	Equals, Contains, Like
		Azure Availability Set	Equals, Contains, Like
		Azure Hardware Profile	Equals, Contains, Like
		Azure Data Disk Name	Equals, Contains, Like
		Azure Data Disk Type	Equals, Contains, Like
		Azure Data Disk Size	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		Azure Network Profile Subnet	Equals, Contains, Like
		Azure Network Profile NIC Name	Equals, Contains, Like
		Azure Network Profile Virtual Network	Equals, Contains, Like
		Azure Network Profile Network Security Group	Equals, Contains, Like
	VMware Specific Attributes	VMware Instance Name	Equals, Contains, Like
		VMware Datastore Cluster	Equals, Contains, Like
		VMware Datastore	Equals, Contains, Like
		VMware Cluster	Equals, Contains, Like
		VMware Host	Equals, Contains, Like
		VMware Sockets	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		VMware Cores Per Socket	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		VMware Memory	Equals, Contains, Like
		VMware Adapter Type	Equals, Contains, Like
		VMware Network	Equals, Contains, Like
		VMware Disk Type	Equals, Contains, Like
		VMware Tag	Equals, Contains, Like
		VMware Disk Size	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		VMware Template Name	Equals, Contains, Like
	AHV Specific Attributes	AHV vCPU	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		AHV Cores Per vCPU	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		AHV Memory	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		AHV Category	Equals, Contains, Like
		AHV VPC Name	Equals, Contains, Like
		AHV vLAN Name	Equals, Contains, Like
		AHV Disk Type	Equals, Contains, Like
		AHV Disk Image Name	Equals, Contains, Like
		AHV Disk Size	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		AHV Boot Configuration Type	Equals, Contains, Like
	AWS Specific Attributes	AWS Instance Type	Equals, Contains, Like
		AWS Region	Equals, Contains, Like
		AWS Tag	Equals, Contains, Like
		AWS Root Volume Type	Equals, Contains, Like
		AWS Data Volume Type	Equals, Contains, Like
		AWS Root Disk Size	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		AWS Data Disk Size	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		AWS IAM Role	Equals, Contains, Like
		AWS VPC ID	Equals, Contains, Like
		AWS Security Group ID	Equals, Contains, Like
		AWS Subnet ID	Equals, Contains, Like
		AWS Machine Image ID	Equals, Contains, Like
	GCP Specific Attributes	GCP Instance Name	Equals, Contains, Like
		GCP Machine Type	Equals, Contains, Like
		GCP Zone	Equals, Contains, Like
		GCP Boot Disk Storage Type	Equals, Contains, Like
GCP Boot Disk Source Image		Equals, Contains, Like
GCP Labels		Equals, Contains, Like
Entity Type: Application Action: Day 2 Operation	All	Application Name	Equals, Contains, Like
		Application Profile Cost	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		App Replicas Count	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		Action Name	Equals, Contains, Like
	AHV Specific Attributes (for Update Config Only)	AHV vCPU	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		AHV Cores Per vCPU	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		AHV Memory	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		AHV Category	Equals, Contains, Like
		AHV vLAN Name	Equals, Contains, Like
		AHV VPC Name	Equals, Contains, Like
		AHV Device Type	Equals, Contains, Like
		AHV Disk Size	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
	AHV (for Snapshots)	AHV Snapshot Location	Equals, Contains, Like
		AHV Snapshot Replica	Equals, Contains, Like
		AHV Snapshot Name	Equals, Contains, Like

Day 2 operations are combination of multiple actions. Ensure that you use the supported attributes for different day 2 operations to enforce the policy appropriately. For example, when you configure a policy with scale in or scale out task, the supported attributes can be App Replicas Count and Application Profile Cost.

The following table provides the day 2 operation with the supported attributes.

Table 2. List of Supported Attributes for Day 2 Operations
Day 2 Operation	Supported Attributes
AHV Update Config	Estimated Application Profile Cost, AHV vCPU, AHV Cores Per vCPU, AHV Memory, AHV Category, AHV VPC Name, AHV vLAN Name, AHV Disk Size, and AHV Device Type
Scale-in or Scale-out task	App Replicas Count and Application Profile Cost
AHV Snapshot Config	AHV Snapshot Name, AHV Snapshot Replica, and AHV Snapshot Location
Supported Attributes for All Day 2 Operations	Application Name and Action Name

For system actions, you must specify the name in the action_<system action> format. The following table lists the system action names supported for approval policies.

Table 3. Supported System Action Names
System Action	Names
Start	`action_start`
Restart	`action_restart`
Stop	`action_stop`
Delete	`action_delete`
Soft Delete	`action_soft_delete`
Snapshot Create	`action_snapshot_create`
Restore	`action_restore`
Update	`action_update`

Cloning an Approval Policy

To quickly create a new policy, you can clone an existing policy and edit its basic information, conditions, and approvers.

About this task

You cannot clone an approval policy that is in the Draft state.

Procedure

Click the Policies icon in the left pane.
On the Approvals tab, click the vertical ellipsis next to the policy that you want to clone and then click Clone .

Figure. Clone Approval Policy Click to enlarge
In the Clone Approval Policy window, provide a name for your new policy in the Approval policy name field, and then click the Clone button.
On the Basic Information , Set Conditions , and Select Approvers tab, edit the fields that you need to change in your new policy. For information about the fields, see Creating an Approval Policy.
Click Save to save the approval policy.
You can also clone a policy from the policy details page.

Enabling or Disabling an Approval Policy

You can enable a policy to enforce the policy on an event that matches the entity, action, and conditions of the policy or disable the policy to skip policy enforcement.

Procedure

Click the Policies icon in the left pane.
To enable or disable a policy, do one of the following on the Approvals tab:

Figure. Enable Approval Policy Click to enlarge
- To enable a disabled policy, click the vertical ellipsis next to the policy that you want to enable and then click Enable .
- To disable an enabled policy, click the vertical ellipsis next to the policy that you want to disable and then click Disable .
You can also enable or disable a policy from the policy details page.

Deleting an Approval Policy

As a Prism Central Administrator or Project Administrator, you can delete an approval policy if the policy is no longer required for the event.

Procedure

Click the Policies icon in the left pane.
On the Approvals tab, click the vertical ellipsis next to the policy that you want to delete and then click Delete .

Figure. Delete Approval Policy Click to enlarge
In the Confirm Delete window, click the Delete button.

Viewing an Approval Policy Details

After you have created a policy, you can view the details of the policy on the policy details page.

Procedure

Click the Policies icon in the left pane.
On the Approvals tab, click the policy that you want to view.

Figure. Policy Details Click to enlarge
The policy details page has the following tabs:
- Basic Information : Use this tab to view the associated project, event, and the details related to the policy creation and updates. You can also use the Enable Policy or Disable Policy option on this tab to enable or disable the policy.
- Conditions : Use this tab to view all the conditions that are associated with the policy.
- Approvers : Use this tab to view the approvers sets that are associated with the policy.
- Execution History : Use this tab to view the execution history of policies.
To clone the policy, click the Clone Policy button. See Cloning an Approval Policy.
To edit the policy, click the Edit button and update the required fields on the Basic Information , Set Conditions , and Select Approvers tab. For information about the fields, see Creating an Approval Policy.
To delete the policy, click the Delete Policy button.

Approving or Rejecting an Approval Request

An an approver, you can view a list of all pending approval policies on the Approval Requests tab and can either approve or reject the request with a reason.

About this task

When you approve a request, the event moves to the next task. When you reject a request, the requester is notified about the rejection of the request. If you are the requester, you can view your pending requests and the status of your reviewed request on the My Requests tab.

Procedure

Click the Policies icon in the left pane.
On the Approvals tab, click the Approval Requests tab in the left pane.
On the Pending on me tab, do the following:
1. Click the request that is pending for approval.
2. View the Basic Information and Condition Details of the applicable policy.
  
  Figure. Pending Request for Approval Click to enlarge
  
  If you are an admin, you can click Go to Application to go to the Overview tab of the application and view the details. You can also click the View Policy tab to view the enforced policy.
3. In the Add Comment field, provide a reason for the approval or rejection of the request. This step is optional.
4. To approve the request, click the Approve button.
5. To reject the request, click the Reject button.
6. Click Yes to confirm approval or rejection.
You can also view the details of the request such as the requester, date of initiation, conditions, and so on the Pending on me tab and click the approve or reject

Library in Calm

Library Overview

Library allows you to save user-defined tasks (scripts) and variables that you can use persistently for other application blueprints. You do not have to define the same tasks and variables for each blueprint.

You can also share tasks and variables listed as part of library across different projects. You can also customise an existing task or variable.

The Library tab lists all the published user-defined tasks and the created variable types to be used across multiple blueprints.

Note:

To list a task in the Library, you must publish the task by using Publish to Library functionality under service package while configuring your blueprints.
To view the list of variables, you must create and save the variables in the Library. For more information, see Variable Types Overview.

Variable Types Overview

You create custom variable types for added flexibility and utility. Beyond just string and integer data types, you can create more data types such as Date/Time, list, and multi-line string. You can define list values as a static list of values or can attach a script (eScript or HTTP task) to retrieve the values dynamically at runtime.

While creating a custom variable type, you associate a project to the variable type. You can also share the variable type with multiple other projects using the "Share" option on the same page.

Creating Variable Types

Create variable types so that you can use the variables during blueprint creation. You can also share the created variable types across multiple projects.

Procedure

Click the Library icon in the left pane.
Click the Variable Types tab.

Figure. Variable Type Click to enlarge
Click Create Variable Type if you are creating the first variable or + Add Variable Types if you are adding a new variable to the list of variables.
The Create Variable Type window appears.
From the Projects list, select the project and click Done .

Note: You associate a project when you create a custom variable type. You can also share the variable type with other projects using the Share option. Members of the same project can use the variable types while creating a blueprint.
In the Name field, type a name for the variable type.

Figure. Variable Type Click to enlarge
In the Description field, type a brief description about the variable type.
From the Data Type list, select the base type for the variables.
The base type defines the type of variable you use while configuring a blueprint. You can select one of the following data types.
- String
- Integer
- Multi-line string
- Date
- Time
- Date Time
Select one of the following input type.
- Use Simple to add a default value.
- Use Predefined to assign static values.
- Use eScript to attach a script that is run to retrieve values dynamically at runtime. Script can return single or multiple values depending on the selected base data type.
- Use HTTP to retrieve values dynamically from the defined HTTP end point. Result is processed and assigned to the variable based on the selected base data type.
If you have selected Simple , then type the value for the variable in the Value field.
If you have selected Predefined , then type the value for the variable in the Option field. To add multiple values for the variable, do the following.
1. Click + Add Option .
2. In the Option field, type the value.
3. To make any value as default, select the Default radio button next to the value.
If you have selected eScript , then add the eScript in the field.
You can click Publish to publish the script to the library.
Note:
- You cannot add macros to eScripts.
- If you have selected Multiple Input (Array) checkbox with input type as eScript, then ensure that the script returns a list of values separated by comma. For example, CentOS, Ubuntu, Windows.
If you have selected HTTP , then configure the following fields.
1. In the Request URL field, specify the URL of the server that you want to run the methods on.
2. In the Request Method list, select a request method. The available options are GET, PUT, POST, and DELETE.
3. In the Request Body field, enter or upload the request.
4. In the Content Type list, select a type of the output format. The available options are XML , JSON, and HTML.
5. In the Connection Timeout (sec) field, type the timeout interval in seconds.
6. Select the authentication type.
  - If you select Basic , then specify the User name and Password .
  - If you select Basic (With Credentials) , then you can set the credentials in the blueprint after copying the task.
  By default, Authentication is set to None . This step is optional.
7. To verify the URL of the HTTP endpoint with a TLS certificate, select the Verify TLS Certificate check box. This step is optional.
8. To use a proxy server that you configured in Prism Central, select the Use PC Proxy configuration check box. This step is optional.
9. In the Retry Count field, type the number of attempts the system must perform to create a task after each failure. By default, the retry count is one, which indicates that the task creation procedure stops after the first attempt.
10. In the Retry Interval field, type the time interval in seconds for each retry if the task fails. By default, the Retry Interval value is set to one second.
11. Under Headers , enter the HTTP header key and value in the Key and Value fields.
12. To publish the HTTP header key and value pair as secret, select the Secrets check box.
13. Under Expected Response Options , type the Response Code for the Response Status you select. You can select Success or Failure as the response status for the task.
To check the Regex, do the following.
1. Select the Validate with Regular Expression check box.
2. Click Test Regex .
3. Provide the value for the Regex in the Value field.
  
  Note: You can enter Regex values in PCRE format. For more details, see from http://pcre.org/.
4. To test the expression, click Test Regex .
Click Save .
The Variable is saved to the Library.
To share the variable type with other projects, do the following.
1. Click Share .
  The Share Variable Type screen appears.
2. From the Select projects to share with list, add the projects with which you want to share the saved variable.
3. Click Done .

What to do next

Use this variable type while define variables in a blueprint. For more details, see Calm Blueprints Overview.

Task Library Overview

You can create tasks while configuring a blueprint and publish these tasks to the library. Calm allows you to import these published tasks while configuring other blueprints across multiple projects.

To refer to the video about task library, click here.

Adding Projects to a Task

Add tasks to a project so that you can use the tasks while configuring blueprints for the selected project.

Procedure

Click the Library icon in the left pane.
The Tasks tab displays the list of all published tasks.
Select the task that you want to assign to a project.
The task inspector panel appears.
Select project from the Project Shared With list.
Click Save .
The task is added to the project.

Deleting a Task from the Task Library

Delete unwanted tasks from the Library. The deleted tasks can no longer be used in any project while configuring a blueprint.

About this task

Video: Deleting a Task from the Task Library

Procedure

Click the Library icon in the left pane.
The Tasks tab displays the list of all published tasks.
Select the task that you want to delete.
The task inspector panel appears.
Click Delete .
In the confirmation window, click Delete .
The task is deleted from the Library.

Runbooks in Calm

Runbooks Overview

A runbook is a framework to automate routine tasks and procedures that pan across multiple applications without the involvement of a blueprint or an application.

A runbook is a collection of tasks that you can define to run sequentially at different endpoints. For more information about endpoints, see Endpoints Overview.

You can define the following types of tasks in a runbook.

Table 1. Tasks in a Runbook
Task	Description
Execute	To run Shell, PowerShell, and eScript (custom python) scripts.
Set Variable	To run a script and create variables.
Delay	To set a delay interval between two tasks or actions.
HTTP	To perform REST calls to an HTTP endpoint.
While Loop	To iterate over multiple tasks until the defined condition is met.
Decision	To define different flows or paths based on the exit condition.
VM Power On	To power on the VMs that are present in the VM endpoint type.
VM Power Off	To power off the VMs present in the VM endpoint type.
VM Restart	To restart the VMs present in the VM endpoint type.

For more information about creating a runbook, see Creating a Runbook.

Runbook Sharing across Projects

To share an active runbook across different projects, you can submit the runbook to be published as a Marketplace item. When the runbook is available at the marketplace, members from different projects to which the runbook is assigned can view and execute it.

When you submit a runbook for publishing, your administrator approves and publishes the runbook at the Marketplace. While publishing, your administrator selects the projects that can view and execute the runbook. You can publish runbooks with or without endpoints and with or without secret values (credential passwords or keys and secret variables). For more information, see Submitting a Runbook for Publishing.

You can select endpoints with virtual machines as the target type to execute power operation tasks such as power off, power on, or restart. Executing these tasks on Virtual machines is particularly helpful in cases where you need to run a set of scripts on multiple VMs and then restart the VMs. For example, when you want to upgrade a software on your VMs. For more information about creating an endpoint, see Creating an Endpoint.

You cannot modify the runbook after it is published. You can either execute the runbook or clone the runbook within your project from the marketplace.

Creating a Runbook

A runbook is a collection of tasks that you can define to run sequentially at different endpoints.

Procedure

Click the Runbooks icon in the left pane.
Click Create Runbook .
Configure the following on the Create Runbook page.

Figure. Create Runbook Click to enlarge
- In the Name field, type a name for the runbook.
- In the Description field, type a brief description about the runbook.
- From the Project list, select a project to which you want to add the runbook.
- From the Default Endpoint list, select a default endpoint. This step is optional.
  Calm uses the default endpoint only when you do not configure any endpoint at the task level.
Click Proceed .
On the Editor tab, click +Add Task and do the following.

Figure. Runbook Editor Click to enlarge
1. In the Task Name field, type a name for the task.
2. From the Type list, select the task type.
  - Select the Execute task to run Shell, PowerShell, and eScript (custom python) scripts or Set Variable task to run a script and create variables. For more information on how to configure the Execute or Set Variable task type, see Creating a Runbook with an Execute or Set Variable Task.
  - Select the Delay task to set a delay interval between two tasks or actions. For more information on how to configure the Delay task type, see Creating a Runbook with a Delay Task.
  - Select the HTTP task to perform REST calls to an HTTP endpoint. For more information on how to configure an HTTP task type, see Creating a Runbook with an HTTP Task.
  - Select the While Loop task to iterate over multiple tasks until the defined condition is met. For more information on how to configure the While Loop task type, see Creating a Runbook with a While Loop Task.
  - Select the Decision task to define different flows or paths based on the exit conditions.
    The task is further subdivided into True and False condition. You must repeat the steps to add the tasks and configure the task type.
  - Select the VM Power Off , VM Power On , or VM Restart task to power off, power on, or restart the VMs that are present in the VM endpoint type. You must select the target VM endpoint for these task types.
To add a credential, do the following on the Configuration tab.
1. Click Add/Edit Credentials .
2. Click + Add Credential .
3. In the Name field, type a name for the credential.
4. Under the Type section, select the type of credential that you want to add.
  - Static : Credentials store keys and passwords in the credential objects that are contained in the blueprints.
  - Dynamic : Credentials fetch keys and passwords from an external credential store that you integrate with Calm as the credential provider.
5. In the Username field, type the user name.
  For dynamic credentials, specify the @@(username)@@ that you defined while configuring the credential provider.
  
  Note: A dynamic credential provider definition requires username and secret. The secret variable is defined by default when you configure your credential provider. However, you must configure a runbook in the dynamic credential provider definition for the username variable before you use the variable in different entities.
6. Select either Password or SSH Private Key as the secret type.
7. Do one of the following to configure the secret type.
  - If you have selected Static as the credential type and Password as the secret type, then type the password in the Password field.
  - If you have selected Static as the credential type and SSH Private Key as the secret type, then enter or upload the key in the SSH Private Key field.
  - If you have selected Dynamic as the credential type and Password or SSH Private Key as the secret type, then select a credential provider in the Provider field. After you select the provider, verify or edit the attributes defined for the credential provider.
  If the private key is password protected, click +Add Passphrase to provide the passphrase. For dynamic credentials, you must configure a runbook in the dynamic credential provider definition for the passphrase variable and then use the @@{passphrase}@@ variable.
  
  The type of SSH key supported is RSA. For information on how to generate a private key, see Generating SSH Key on a Linux VM or Generating SSH Key on a Windows VM.
8. Click Done .
Note: The credential that you add on the Configuration tab overrides the credential you added in the endpoint.
To add a variable, do the following on the Configuration tab. This step is optional.
1. Click Add/Edit Variable .
2. If you want to use an existing variable, select the variable that you want to use for the runbook.
3. If you want to create a new variable, click Add Variable . For more information on how to create variables, see Creating Variable Types.
To add a default endpoint, select the endpoint from the Default Endpoint list. This step is optional.

Note: The endpoint you select on the Configuration tab supersedes the endpoint you add on the Editor tab.
To add endpoint information, select the endpoint from the Endpoint list and enter a description for the endpoint in the Description field. This step is optional.
Click Save

What to do next

You can execute the runbook. For more information, see Executing a Runbook.
You can submit the runbook for approval and publishing. For more information, see Submitting a Runbook for Publishing.

Creating a Runbook with an Execute or Set Variable Task

Create a runbook with the Execute task to run Shell, PowerShell, and eScript (custom python) scripts. Create a runbook with the Set Variable task to run a script and create variables.

Before you begin

Ensure that you have created a runbook and have added a task for the runbook. For more information, see Creating a Runbook.

Procedure

On the runbook Editor tab, click +Add Task .
In the Task Name field, type a name for the task.
From the Type list, select the Execute or Set Variable task.
In the Script Type list, select Shell , Powershell , or eScript .
For Shell, PowerShell, and eScript scripts, you can access the available list of macros by using @@{ .
From the Endpoint list, select an endpoint on which you want to run the task. This step is optional.
You can also select Add New Endpoint from the list and create an endpoint. For more information about creating an endpoint, see Creating an Endpoint.

If you do not select an endpoint, then Calm uses the default endpoint that you defined while creating the runbook.
For the EScript task, select the tunnel that you can use to get access to the endpoint within the VPC in the Select tunnel to connect with list. This step is optional.
The Select tunnel to connect with list shows only those tunnels that are allowed in the project you selected for the endpoint.
For the Shell or PowerShell script type, select an existing credential from the Credential list or add a new credential to override the credential for the task. This step is optional. To add a new credential, do the following:
1. In the Credential list, select Add New Credential .
2. In the Name field, type a name for the credential.
3. Under the Type section, select the type of credential that you want to add.
  - Static : Credentials store keys and passwords in the credential objects that are contained in the blueprints.
  - Dynamic : Credentials fetch keys and passwords from an external credential store that you integrate with Calm as the credential provider.
4. In the Username field, type the user name.
  For dynamic credentials, specify the @@(username)@@ that you defined while configuring the credential provider.
  
  Note: A dynamic credential provider definition requires username and secret. The secret variable is defined by default when you configure your credential provider. However, you must configure a runbook in the dynamic credential provider definition for the username variable before you use the variable in different entities.
5. Select either Password or SSH Private Key as the secret type.
6. Do one of the following to configure the secret type.
  - If you have selected Static as the credential type and Password as the secret type, then enter the password in the Password field.
  - If you have selected Static as the credential type and SSH Private Key as the secret type, then enter or upload the key in the SSH Private Key field.
  - If you have selected Dynamic as the credential type and Password or SSH Private Key as the secret type, then select a credential provider in the Provider field. After you select the provider, verify or edit the attributes defined for the credential provider.
  If the private key is password protected, click +Add Passphrase to provide the passphrase. For dynamic credentials, you must configure a runbook in the dynamic credential provider definition for the passphrase variable and then use the @@{passphrase}@@ variable.
  
  The type of SSH key supported is RSA. For information on how to generate a private key, see Generating SSH Key on a Linux VM or Generating SSH Key on a Windows VM.
7. Click Done to add the credential.
In the Script panel, enter or upload the script that you want to run.
To test the script in the Calm playground, click Test script and do the following.
You can use the Calm playground to run the script, review the output, and make any required changes.
1. On the Authorization tab, specify the IP Address and Port .
2. In the Select tunnel to connect with list, select the tunnel that you can use to get access to the VM within the VPC. This step is optional.
  The Select tunnel to connect with list shows only those tunnels that are allowed in the project you selected for the endpoint.
3. Specify the Credential for the test machine.
  You can also specify the Username and Password for the test machine instead of the credential.
4. Click Login and Test .
5. On the Test Script tab, view or edit your script in the Script field.
6. For macros in your script, provide the values in the macro inspector panel.
7. Click Assign and Test .
  The Output field displays the test result.
8. To go back to the Runbook Editor page, click Done .
To publish this task to the task library, click Publish to Library and then click Publish .
Click Save to save the runbook.

Creating a Runbook with a Delay Task

Create a runbook with the Delay task to set a delay interval between two tasks or actions.

Before you begin

Ensure that you have created a runbook and have added a task for the runbook. For more information, see Creating a Runbook.

Procedure

On the runbook Editor tab, click +Add Task .
In the Task Name field, type a name for the task.
From the Type list, select the Delay task.
In the Sleep Interval field, type the sleep time interval in seconds for the task.
Click Save to save the runbook.

Creating a Runbook with an HTTP Task

Create a runbook with the HTTP task to perform REST calls to an HTTP endpoint.

Before you begin

Ensure that you have created a runbook and have added a task for the runbook. For more information, see Creating a Runbook.

Procedure

On the runbook Editor tab, click +Add Task .
In the Task Name field, type a name for the task.
From the Type list, select the HTTP task.
From the Endpoint list, select the endpoint where you want to execute the HTTP task. This step is optional.
In the Request Method list, select one of the following request methods.
- Select GET to retrieve data from a specified resource.
- Select POST to send data to a server to create a resource, and enter or upload the POST request in the Request Body field.
- Select DELETE to send data to a server to delete a resource, and enter or upload the DELETE request in the Request Body field.
- Select PUT to send data to a server to update a resource, and enter or upload the PUT request in the Request Body field.
In the Relative URL field, enter the URL of the server on which you want to run the methods.
In the Content Type list, select the type of the output format.
The available options are HTML , JSON , and XML .
In the Headers section, type the HTTP header key and value in the Key and Value fields respectively.
If you want to publish the HTTP header key and value pair as secrets, select the Secret check box.
In the Expected Response Options area, do the following configurations.
1. Select Success or Failure as the Response Status , and type the Response Code for the status.
  
  Note: If the response code is not defined, then by default all the 2xx response codes are marked as success, and any other response codes are marked as failure.
2. Under Set Variables from response , type the variables for the specified response path. The example of json format is $.x.y and xml format is //x/y . For more information about json path syntax, see http://jsonpath.com.
  
  Note: To retrieve the output format in HTML format, add a * in the syntax.
If you want to test the script in the Calm playground, click Test Request .
The test result appears in the Output field .
Click Save to save the runbook.

Creating a Runbook with a While Loop Task

Create a runbook with the While Loop task to iterate over multiple tasks until the defined condition is met.

Before you begin

Ensure that you have created a runbook and have added a task for the runbook. For more information, see Creating a Runbook.

Procedure

On the runbook Editor tab, click +Add Task .
In the Task Name field, type a name for the task.
From the Type list, select the While Loop task.
In the Iterations field, type the number of times you want to iterate the task till the task meet a condition. The default value is 1.
From the Exit Condition list, select a condition after which the task iteration must stop. The available options are as follows.
- - Select Success if you want to stop the task iteration after the status of the task is success.
  - Select Failure if you want stop the task iteration after the status of the task is failure.
  - Select Don't care if you want to continue the task iteration irrespective of the status of the task.
Click Save to save the runbook.

Submitting a Runbook for Publishing

Submit a runbook for publishing so that your admin can approve and publish it at the marketplace. Members from the associated projects can view and execute the runbooks that are published at the marketplace.

About this task

Video: Submitting a Runbook for Publishing

Procedure

Click the Runbooks icon in the left pane.
Do one of the following:
- To publish an existing runbook, click to open a runbook from the list.
- To publish a new runbook, click Create Runbook and create a new runbook. For information on how to create a runbook, see Creating a Runbook.
On the Runbook Editor page, click the Publish button.
The Publish Runbook dialog box appears.
Figure. Publish Runbook Click to enlarge
To publish a new runbook, do the following.
1. Select New Marketplace Runbook .
2. Provide a name for the runbook to be used at the marketplace.
3. Enable the Publish with secrets toggle button to encrypt secret values such as the credential passwords, keys, and secret variables.
  By default, the secret values from the runbook are not preserved when you publish them. Enable this option if you do not want to fill the secret values or to be patched from the environment when you execute the runbook.
4. Enable the Publish with endpoints toggle button to preserve the endpoint values.
  By default, the endpoints from the runbook are not preserved when you publish them. Enable this option if you do not want to fill the endpoint values when you execute the runbook.
5. In the Initial Version field, type a new version number.
6. Provide a description for the runbook. This step is optional.
To publish a newer version of an already published runbook, do the following:
1. Select New version of an existing Marketplace Runbook .
2. From the Marketplace Item list, select the existing runbook.
3. Enable the Publish with secrets and Publish with endpoints toggle buttons.
4. Specify the version for the runbook for the existing runbook.
5. Provide a description for the runbook. This step is optional.
Click Submit for Approval .
Calm submits the runbook to the Marketplace Manager for your admin to approve and publish the runbook to the Marketplace.

What to do next

If you are the admin, you can approve and publish the runbook from the Marketplace Manager. To know more about approving and publishing the runbook, see Approving and Publishing a Blueprint or Runbook. If you are a project admin or a developer, you can request your admin to approve and publish the runbook at the Marketplace.

Executing a Runbook

You can execute a runbook to run the tasks sequentially on an endpoint.

About this task

Video: Executing a Runbook

Procedure

Click the Runbooks icon in the left pane.
Select the runbook that you want to execute.

Figure. Execute Runbook Click to enlarge
From the Action list, select Execute .
The Execute Runbook page appears.
To change the default endpoint for the execution, select an endpoint from the Endpoints list. This step is optional.
To update the added variable to the Runbook, click the respective variable field and edit the variable. This step is optional.

Note: You can update the variable only if you mark the variable as runtime editable while adding it in the Runbook.
Click Execute .
The runbook execution starts and you are directed to the Runbook execution page.

What to do next

You can view all the executions in the Execution History tab.

Deleting a Runbook

Perform the following procedure to delete a runbook.

About this task

Video: Deleting a Runbook

You must have the role of an administrator or a developer to delete a runbook.

Procedure

Click the Runbooks icon in the left pane.
Select the runbook that you want to delete.
From the Action list, select Delete .
In the Confirm Delete window, click Delete .

Endpoints in Calm

Endpoints Overview

Endpoints are the target resources where the tasks defined in a runbook or blueprint are run.

The endpoints are collection of IP addresses or VMs. The collection of VMs can be a static selection or can be dynamic with filter rules applied.

You have the following types of endpoints.

A Windows machine
A Linux machine
An HTTP service endpoint

To know how to create an endpoint, see Creating an Endpoint.

Endpoints with Virtual Machines

For Windows or Linux endpoint type, you can select virtual machines as the target type. Selecting VMs as target type is useful in cases where you run a set of scripts on multiple VMs and then restart the VMs. For example, you can select VMs as target type to upgrade a software on your VMs.

After you select VMs as the target type, you must select the provider account to list all the associated VMs. You can filter the list of VMs. You can either select the VMs manually or enable the option to automatically select the filtered VMs for your endpoint.

Creating an Endpoint

Create an endpoint to run the tasks that you define in a runbook or blueprint.

About this task

You must have the role of an administrator or a developer to create an endpoint.

Procedure

Click the Endpoints icon in the left pane.
Click Create Endpoint .
In the Create Endpoint window, type a name and description for the endpoint.
From the Project list, select the project to which you want to assign the endpoint.
Select the type of the endpoint. You can select Windows , Linux , or HTTP as the endpoint type.
If you have selected HTTP as the endpoint type, do the following.

Figure. HTTP Endpoint Type Click to enlarge
1. In the Select tunnel to connect with list, select the tunnel that you can use to get access to the endpoint within the VPC. This step is optional.
  The Select tunnel to connect with list shows only those VPC tunnels that are allowed in the project that you selected for the endpoint.
2. In the Base URL field, enter the base URL of the HTTP endpoint. A base URL is the consistent part of the endpoint URL.
3. To verify the URL of the HTTP endpoint with a TLS certificate, click the Verify TLS Certificate check box. Use this option to securely access the endpoint. This step is optional.
4. To use a proxy server that you configured in Prism Central, select the Use PC Proxy configuration check box.
  
  Note: Ensure that Prism Central has the appropriate HTTP proxy configuration.
5. In the Retry Count field, type the number of attempts the system must perform to create a task after each failure.
  The default value is 1, which implies that the task creation process stops after the first attempt.
6. In the Retry Interval field, type the time interval in seconds for each retry if the task fails. The default value is 10 seconds.
7. In the Connection Timeout field, type the time interval in seconds after which the connection attempt to the endpoint stops. The default value is 120 seconds.
8. To add an authentication method to connect to an HTTP endpoint, click Authentication and select Basic from the Type field. Type a username and password to authenticate the endpoint. This step is optional.
  By default, the authentication type is set to None .
If you have selected Windows or Linux as the endpoint type, then select a target type. The target type can be IP Addresses or VMs .

Figure. Endpoint Target Type Click to enlarge
If you have selected IP Addresses as the target type, then do the following:
1. In the Select tunnel to connect with list, select the tunnel that you can use to get access to the endpoint within the VPC. This step is optional.
  The Select tunnel to connect with list shows only those VPC tunnels that are allowed in the project that you selected for the endpoint.
2. In the IP Addresses field, type the IP address to access the endpoint device.
If you have selected VMs as the target type, do the following:
1. In the Account list, select an account.
  The Account list displays all the provider accounts that you configured in the project. After you select the provider account, the window displays the VMs associated with the provider account.
2. To filter VMs, use the Filter By options.
  You can use different attribute, operator, and value criteria to get accurate results.
3. Select the VMs that you want to add to your endpoint.
  You can also use the Auto Select VMs toggle button to automatically add the filtered VMs to your endpoint.
  
  Note: The resolution of the VMs from the filters happens at the runbook execution.
In the Connection Protocol field, select the connection protocol to access the endpoint. You can select either HTTP or HTTPS . This field appears only for the Windows endpoint type.
In the Port field, type the port number to access the endpoint.
Add a credential for Windows or Linux endpoint type to access the endpoint.
1. Click Credential .
2. Select the type of credential that you want to add under the Type section.
  - Static : Credentials store keys and passwords in the credential objects that are contained in the blueprints.
  - Dynamic : Credentials fetch keys and passwords from an external credential store that you integrate with Calm as the credential provider.
3. In the Username field, type a username for the endpoint credential.
  For dynamic credentials, specify the @@(username)@@ that you defined while configuring the credential provider.
  
  Note: A dynamic credential provider definition requires username and secret. The secret variable is defined by default when you configure your credential provider. However, you must configure a runbook in the dynamic credential provider definition for the username variable before you use the variable in different entities.
4. Select either Password or SSH Private Key as the secret type.
5. Do one of the following to configure the secret type.
  - If you have selected Static as the credential type and Password as the secret type, then type the password in the Password field.
  - If you have selected Static as the credential type and SSH Private Key as the secret type, then enter or upload the key in the SSH Private Key field.
  - If you have selected Dynamic as the credential type and Password or SSH Private Key as the secret type, then select a credential provider in the Provider field. After you select the provider, verify or edit the attributes defined for the credential provider.
  If the private key is password protected, click +Add Passphrase to provide the passphrase. For dynamic credentials, you must configure a runbook in the dynamic credential provider definition for the passphrase variable and then use the @@{passphrase}@@ variable.
  
  The type of SSH key supported is RSA. For information on how to generate a private key, see Generating SSH Key on a Linux VM or Generating SSH Key on a Windows VM.
Click Save .

What to do next

You can add the endpoint to a runbook. For more details, see Creating a Runbook.

Deleting an Endpoint

Perform the following procedure to delete a endpoint.

About this task

You must have the role of an administrator or a developer to delete an endpoint.

Procedure

Click the Endpoints icon in the left pane.
Select the endpoint that you want to delete.
From the Action list, select Delete .
In the Confirm Delete window, click Delete .

Calm Backup and Restore

Calm Data Backup and Restore

You can take a backup of the Calm data to a specified location on your machine and restore the data to a new Prism Central. You back up the following data:

Zookeeper Data
- Calm instance data
Elastic Search Data
- Task Run Logs
- App Icons
- Marketplace branding Logos
IDF PC Tables
- project
- Entity Capabilities
IDF Calm Tables
- "management_server_account"
- "marketplace_item"
- "nucalm_action"
- "nucalm_action_run"
- "nucalm_app_beam_status"
- "nucalm_app_blueprint"
- "nucalm_app_failover_status"
- "nucalm_application"
- "nucalm_application_cfg"
- "nucalm_app_protection_status"
- "nucalm_budget"
- "nucalm_consumption"
- "nucalm_cost"
- "nucalm_credential"
- "nucalm_deployment"
- "nucalm_deployment_cfg"
- "nucalm_deployment_element"
- "nucalm_environment"
- "nucalm_library_task"
- "nucalm_library_variable"
- "nucalm_lifecycle"
- "nucalm_loadbalancer"
- "nucalm_loadbalancer_cfg"
- "nucalm_package"
- "nucalm_package_cfg"
- "nucalm_package_element"
- "nucalm_platform_instance_element"
- "nucalm_policy_rule"
- "nucalm_price_item"
- "nucalm_price_item_status"
- "nucalm_published_service"
- "nucalm_published_service_cfg"
- "nucalm_recovery_plan_job_sync_status"
- "nucalm_runbook"
- "nucalm_run_log"
- "nucalm_secret"
- "nucalm_service"
- "nucalm_service_cfg"
- "nucalm_service_element"
- "nucalm_service_upgrade_history"
- "nucalm_service_version"
- "nucalm_substrate"
- "nucalm_substrate_cfg"
- "nucalm_substrate_element"
- "nucalm_sync_status"
- "nucalm_task"
- "nucalm_user_file"
- "nucalm_variable"
- "nucalm_worker_state"

Backing up Calm Data

You can take a backup of the entire Calm data to a specified location on your machine.

About this task

To know how to back up Calm data on an IAMV2-enabled setup, see Backing up Calm Data in an IAMV2-Enabled Setup.

Procedure

Log on to the Calm container by using the SSH session and run the following command.
docker exec -it nucalm bash

The calmdata binary is available in the /home/calm/bin folder.
In the SSH terminal, change the directory to the Calm container by running the following command.
# cd /home/calm/bin
Create a folder to store the backup data. The backup folder must be empty.
To take a backup of the Calm data, run the following command.
```
 # ./calmdata backup --dump-folder <folder>
```
The default folder is located in /tmp/default path. Replace folder with the new folder.

Note: Ensure that the the backup folder has only the calmdata tar file dump.
To get the backup dump from the container, run the following command.
```
docker cp <nucalm_container_id>:<backup_tar_file_path> <PC_path_to_copy>
```
For example,
```
docker cp f4af4798e47d:/backup/3.5.2_backup.tar /home/nutanix/local_backup/
```
The command copies the calmdata backup tar file from the nucalm container to the Prism Central file system.
Use the scp command to copy the calmdata backup tar file from the Prism Central file system to the new Prism Central.
Login to the new Prism Central.
To copy the calmdata backup tar file into the nucalm container of the new Prism Central, run the following command.
```
docker cp <back_up_tar_file_path> <nucalm_container_id>:<restore_path_dump_folder>
```

What to do next

To know how to restore Calm data, see Restoring Calm Data.

Backing up Calm Data in an IAMV2-Enabled Setup

You can take a backup of the entire Calm data to a specified location on your machine.

Procedure

Log on to the Calm container by using the SSH session and run the following command.
docker exec -it nucalm bash

The calmdata binary is available in the /home/calm/bin folder.
In the SSH terminal, change the directory to the Calm container by running the following command.
# cd /home/calm/bin
Create a folder to store the backup data. The backup folder must be empty.
To take a backup of the Calm data, run the following command.
```
 # ./calmdata backup --dump-folder <folder>
```
The default folder is located in /tmp/default path. Replace folder with the new folder.

Note: Ensure that the the backup folder has only the calmdata tar file dump.
Run the IAM backup script to take a backup of the ACPs.
1. SSH to the leader node of the Prism Central.
2. Run the following command to find the leader node in a scale-out setup:
```
sudo kubectl -s 0.0.0.0:8070 -n ntnx-base get pods
```
  The command must return all point of deliveries without any error.
3. Run the following commands on the leader node.
```
cd ~/cluster/bin/
```
```
vi backup_iam.sh
```
4. Copy the script from the Nutanix Downloads page and paste the script in the backup_iam.sh file.
5. Run the following script.
```
sh backup_iam.sh
```
  The backup zipped file will be saved on this PC at /usr/local/nutanix/iam-backup .
To get the backup dump from the container, run the following command.
```
docker cp <nucalm_container_id>:<backup_tar_file_path> <PC_path_to_copy>
```
For example,
```
docker cp f4af4798e47d:/backup/3.5.2_backup.tar /home/nutanix/local_backup/
```
The command copies the calmdata backup tar file from the nucalm container to the Prism Central file system.
Use the scp command to copy the calmdata backup tar file from the Prism Central file system to the new Prism Central.
Use the scp command to copy the IAM backup zipped file from the Prism Central file system to the following location on the new Prism Central.
/usr/local/nutanix/iam-backup
Login to the new Prism Central.
To copy the calmdata backup tar file into the nucalm container of the new Prism Central, run the following command.
```
docker cp <back_up_tar_file_path> <nucalm_container_id>:<restore_path_dump_folder>
```

What to do next

To know how to restore Calm data, see Restoring Calm Data.

Restoring Calm Data

You can restore the Calm data to a new Prism Central using a backup you took earlier.

About this task

For more information about backing up the Calm data, see Backing up Calm Data.

Note: Before you restore your Calm data, ensure that:

You do not have any running applications or blueprints on the Prism Central on which you restore the Calm data. Any applications or blueprints available on your Prism Central might not work properly after you restore the data.
The Prism Central on which you restore the data has the same Prism Elements as that of the backed-up Prism Central. In case of any variations, the accounts or projects associated with your local Prism Element through the Prism Central might not work properly.
The restored version of the Calm must be the same as that of the backed-up version. For example, if you have taken a backup of version 3.0, you must restore using version 3.0. You cannot use version 3.1 or 3.2 to restore the Calm data.
You have enabled Calm on the destination Prism Central, and the Calm instance is new.

Procedure

To restore the backed up Calm data, do the following:

With the session, run the following command on the new Prism Central.
```
# ./calmdata restore --dump-folder <folder> 
```
The default folder is located in the /tmp/default path. Replace the folder with the new folder.

Run the following command.

docker exec -ti nucalm bash
activate; 
code ; 
python scripts/update_policy_vm_host_data.pyc

Log on to the Policy Engine VM and run the following commands:

sudo systemctl stop policy-container
sudo systemctl stop policy-epsilon-container
sudo systemctl stop chronos-container
docker rm -f policy
docker rm -f policy-epsilon
docker rm -f chronos
sudo systemctl start policy-container
sudo systemctl start policy-epsilon-container
sudo systemctl start chronos-container

Additonally, run the IAM restore script if you have an IAMv2-enabled setup.
1. SSH to the Prism Central leader node to restore.
2. Run the following commands on the leader node.
```
cd ~/cluster/bin/
```
```
vi restore_iam_from_file.sh
```
3. Copy the script from the Nutanix Downloads page and paste the script in the restore_iam_from_file.sh file.
4. Run the following script.
```
sh restore_iam_from_file.sh
```

Flag Options for Backup

Use the following flag options for your Calm data backup:

Table 1. Flag Options
Options	Description
dump-folder	The folder where you want to place the backup data. The default folder is located at /tmp/default . Note: Create this folder before taking the backup. When you restore, the restore binary must be present at this location. Example: `# ./calmdata backup --dump-folder="/tmp/new"`
max-threads	The maximum number of threads to use to take the backup. The default value is 5. Example: `# ./calmdata backup --max-thread=5`
fetch-limit	The maximum number of entries to fetch in batches of 100 per call. The default and the maximum value is 100. Decreasing the value of fetch-limit increases the time taken to back up Calm data. Example: `# ./calmdata backup --fetch-limit=100`
idf-timeout	The timeout for IDF (database). Increase the value of IDF timeout if you encounter backup failure due to timeout. The default value is 60. Example: `# ./calmdata backup --idf-timeout=120`
backup-deleted-entities	The flag to include deleted entities in the backup. The backup does not include deleted entities when the value is False. The default value is True. Example: `# ./calmdata backup --backup-deleted-entities=false`

Backing Up and Restoring Policy Engine Database

When you enable the policy engine for your Calm instance, Calm creates and deploys a new VM for the policy engine in your Prism Central network. After the policy engine VM deployment, you can anytime create a backup of your policy engine database. You can use the backup to restore the policy engine to the earlier state on your existing policy engine VM or on a new policy engine VM.

About this task

You must run the backup and restore commands from your Prism Central instance.

Procedure

To create a backup of your policy engine, run the following command:
ssh nutanix@<policy_vm_ip> /home/nutanix/scripts/backup.sh

Where <policy_vm_ip> is the IP address of the policy engine VM.

This command creates a local backup on the policy engine VM at /home/nutanix/data/backups/ .

To restore the policy engine to a new policy engine VM, copy the backup to Prism Central using the scp command and then to the new policy engine VM.

Note: When you run the command to create the backup, the policy engine remains unavailable until the backup is created.
To view all the backups that are available on your policy engine VM, use the following command:
ssh nutanix@<policy_vm_ip> /home/nutanix/scripts/restore.sh –-list
To restore policy engine to its earlier state, run the following command:
ssh nutanix@<policy_vm_ip> /home/nutanix/scripts/restore.sh -f=<backup_name>

Where <policy_vm_ip> is the IP address of the policy engine VM and <backup_name> is the local backup file available on the policy engine VM.

Note: When you run the command to restore your policy engine on the existing policy engine VM, the policy engine remains unavailable until it is restored.

Calm Scripts

Sample Scripts for Installing and Uninstalling Services

Calm task library public repository contains scripts for installing and uninstalling different services. To access the repository, click here.

Sample Scripts to Configure Non-Managed AHV Network

The following sections provide the sample scripts of Cloud-init and SysPrep to configure the static IP address range for non-managed AHV network.

Cloud-init Script for Linux

Note: You can assign a static IP to a non-managed network only when the disk image contains a network card set for the static IP. You cannot assign the static IP if the NIC is configured for DHCP in the disk image.

#cloud-config
cloud_config_modules: 
  - resolv_conf
  - runcmd
write_files:
  - path: /etc/sysconfig/network-scripts/ifcfg-eth0
    content: |
      IPADDR=10.136.103.226
      NETMASK=255.255.255.0
      GATEWAY=10.136.103.1
      BOOTPROTO=none
      ONBOOT=yes
      DEVICE=eth0

runcmd:
  - [ifdown, eth0]
  - [ifup, eth0]
  
manage_resolv_conf: true
resolv_conf:
  nameservers: ['8.8.4.4', '8.8.8.8']
  searchdomains:
    - foo.example.com
    - bar.example.com
  domain: example.com
  options:
    rotate: true
    timeout: 1

SysPrep Script for Windows

<?xml version="1.0" encoding="UTF-8"?>
<unattend xmlns="urn:schemas-microsoft-com:unattend">
   <settings pass="specialize">
      <component xmlns:wcm="http://schemas.microsoft.com/WMIConfig/2002/State" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="Microsoft-Windows-Shell-Setup" processorArchitecture="amd64" publicKeyToken="31bf3856ad364e35" language="neutral" versionScope="nonSxS">
         <ComputerName>Windows2016</ComputerName>
         <RegisteredOrganization>Nutanix</RegisteredOrganization>
         <RegisteredOwner>Acropolis</RegisteredOwner>
         <TimeZone>UTC</TimeZone>
      </component>
      <component xmlns:wcm="http://schemas.microsoft.com/WMIConfig/2002/State" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="Microsoft-Windows-UnattendedJoin" processorArchitecture="amd64" publicKeyToken="31bf3856ad364e35" language="neutral" versionScope="nonSxS">
         <Identification>
            <Credentials>
               <Domain>contoso.com</Domain>
               <Password>secret</Password>
               <Username>Administrator</Username>
            </Credentials>
            <JoinDomain>contoso.com</JoinDomain>
            <UnsecureJoin>false</UnsecureJoin>
         </Identification>
      </component>
      <component xmlns:wcm="http://schemas.microsoft.com/WMIConfig/2002/State" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="Microsoft-Windows-TCPIP" processorArchitecture="amd64" publicKeyToken="31bf3856ad364e35" language="neutral" versionScope="nonSxS">
         <Interfaces>
            <Interface wcm:action="add">
               <Identifier>Ethernet</Identifier>
               <Ipv4Settings>
                  <DhcpEnabled>false</DhcpEnabled>
                  <RouterDiscoveryEnabled>true</RouterDiscoveryEnabled>
                  <Metric>30</Metric>
               </Ipv4Settings>
               <UnicastIpAddresses>
                  <IpAddress wcm:action="add" wcm:keyValue="1">10.0.0.2/24</IpAddress>
               </UnicastIpAddresses>
               <Routes>
                  <Route wcm:action="add">
                     <Identifier>10</Identifier>
                     <Metric>20</Metric>
                     <NextHopAddress>10.0.0.1</NextHopAddress>
                     <Prefix>0.0.0.0/0</Prefix>
                  </Route>
               </Routes>
            </Interface>
         </Interfaces>
      </component>
      <component xmlns:wcm="http://schemas.microsoft.com/WMIConfig/2002/State" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="Microsoft-Windows-DNS-Client" processorArchitecture="amd64" publicKeyToken="31bf3856ad364e35" language="neutral" versionScope="nonSxS">
         <UseDomainNameDevolution>true</UseDomainNameDevolution>
         <DNSDomain>contoso.com</DNSDomain>
         <Interfaces>
            <Interface wcm:action="add">
               <Identifier>Ethernet</Identifier>
               <DNSDomain>contoso.com</DNSDomain>
               <DNSServerSearchOrder>
                  <IpAddress wcm:action="add" wcm:keyValue="1">10.0.0.254</IpAddress>
               </DNSServerSearchOrder>
               <EnableAdapterDomainNameRegistration>true</EnableAdapterDomainNameRegistration>
               <DisableDynamicUpdate>true</DisableDynamicUpdate>
            </Interface>
         </Interfaces>
      </component>
      <component xmlns="" name="Microsoft-Windows-TerminalServices-LocalSessionManager" publicKeyToken="31bf3856ad364e35" language="neutral" versionScope="nonSxS" processorArchitecture="amd64">
         <fDenyTSConnections>false</fDenyTSConnections>
      </component>
      <component xmlns="" name="Microsoft-Windows-TerminalServices-RDP-WinStationExtensions" publicKeyToken="31bf3856ad364e35" language="neutral" versionScope="nonSxS" processorArchitecture="amd64">
         <UserAuthentication>0</UserAuthentication>
      </component>
      <component xmlns:wcm="http://schemas.microsoft.com/WMIConfig/2002/State" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="Networking-MPSSVC-Svc" processorArchitecture="amd64" publicKeyToken="31bf3856ad364e35" language="neutral" versionScope="nonSxS">
         <FirewallGroups>
            <FirewallGroup wcm:action="add" wcm:keyValue="RemoteDesktop">
               <Active>true</Active>
               <Profile>all</Profile>
               <Group>@FirewallAPI.dll,-28752</Group>
            </FirewallGroup>
         </FirewallGroups>
      </component>
   </settings>
   <settings pass="oobeSystem">
      <component xmlns:wcm="http://schemas.microsoft.com/WMIConfig/2002/State" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="Microsoft-Windows-Shell-Setup" processorArchitecture="amd64" publicKeyToken="31bf3856ad364e35" language="neutral" versionScope="nonSxS">
         <UserAccounts>
            <AdministratorPassword>
               <Value>secret</Value>
               <PlainText>true</PlainText>
            </AdministratorPassword>
         </UserAccounts>
         <AutoLogon>
            <Password>
               <Value>secret</Value>
               <PlainText>true</PlainText>
            </Password>
            <Enabled>true</Enabled>
            <Username>Administrator</Username>
         </AutoLogon>
         <FirstLogonCommands>
            <SynchronousCommand wcm:action="add">
               <CommandLine>cmd.exe /c netsh firewall add portopening TCP 5985 "Port 5985"</CommandLine>
               <Description>Win RM port open</Description>
               <Order>1</Order>
               <RequiresUserInput>true</RequiresUserInput>
            </SynchronousCommand>
         </FirstLogonCommands>
         <OOBE>
            <HideEULAPage>true</HideEULAPage>
            <SkipMachineOOBE>true</SkipMachineOOBE>
         </OOBE>
      </component>
      <component xmlns:wcm="http://schemas.microsoft.com/WMIConfig/2002/State" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="Microsoft-Windows-International-Core" processorArchitecture="amd64" publicKeyToken="31bf3856ad364e35" language="neutral" versionScope="nonSxS">
         <InputLocale>en-US</InputLocale>
         <SystemLocale>en-US</SystemLocale>
         <UILanguageFallback>en-us</UILanguageFallback>
         <UILanguage>en-US</UILanguage>
         <UserLocale>en-US</UserLocale>
      </component>
   </settings>
</unattend>

Supported eScript Modules and Functions

Calm supports the following eScript modules.

Table 1. Supported eScript Modules
Module	Module supported as
datetime	_datetime
re	re
difflib	difflib
base64	base64
pprint	pprint
pformat	pformat
simplejson	json
ujson	ujson
yaml	yaml
Uuid	uuid
requests	requests
boto3	boto3
azure	azure
kubernetes	kubernetes

The following example displays the usage of boto3 module.

import boto3
ec2 = boto3.client('ec2', aws_access_key_id='{}', aws_secret_access_key='{}', region_name='us-east-1')
print ec2.describe_regions()

The following example displays the usage of Azure module.

# subscription_id macro contains your Azure Subscription ID
# client_id macro contains your Client ID
# tenant macro contains you Tenant ID
from azure.common.credentials import ServicePrincipalCredentials
from azure.mgmt.resource import ResourceManagementClient
credentials = ServicePrincipalCredentials(
    client_id=@@{client_id}@@,
    secret='secret',
    tenant=@@{tenant}@@
)
client = ResourceManagementClient(credentials, @@{subscription_id}@@)
for item in client.resource_groups.list():
    print(item)

The following example displays the usage of Kubernetes module.

from kubernetes import client as k8client
aToken="eyJhbGciOiJSUzI1NiIsImtpZCI6IiJ9.eyJpc3MiOiJrdWJl
cm5ldGVzL3NlcnZpY2VhY2NvdW50Iiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWN
jb3VudC9uYW1lc3BhY2UiOiJkZWZhdWx0Iiwia3ViZXJuZXRlcy5pby9zZXJ2aWNl
YWNjb3VudC9zZWNyZXQubmFtZSI6InNhcmF0aC10b2tlbi1ubWo1cSIsImt1YmVybm
V0ZXMuaW8vc2VydmljZWFjY291bnQvc2VydmljZS1hY2NvdW50Lm5hbWUiOiJzYXJhdG
giLCJrdWJlcm5ldGVzLmlvL3NlcnZpY2VhY2NvdW50L3NlcnZpY2UtYWNjb3VudC51aWQ
iOiIzODM1Zjk5MC0zZGJhLTExZWEtODgwNy01MDZiOGQzYjFhYjIiLCJzdWIiOiJzeXN0ZW06c2Vyd
mljZWFjY291bnQ6ZGVmYXVsdDpzYXJhdGgifQ.dLJCdlOGktRsXfxDItBdbYxDYJtnFS9pptQaKr
JS1QfWAiT93l_iPExZZ_7JGQ2t7glpe-DNEwfjKiqUkDKmuHZSxN9fV6PHjTc8CGOn1q4LV7
tFFkh4HNi-JjhLPkRRQUM6_y5qQSrx9asDEGVLGsoHjuMLhELi4Ghq1EOgcRxPCTQD6lq_C203Dap
PESdqPl7JsmIVBCkFUT4A8A4sseiOqq9ogX-QKvAwoI7yq97BMJLX7q868cNBRsbFzct1tS-CEx-RCPM95
qAzdLNUOrIszVVgSd7jLxIg_tqUH_yEj4T0cePsbLhrCBPRt6bHFCyg3RkIKRoIN2YBq0wPWw"
configuration=k8client.Configuration()
configuration.host="https://10.46.4.213:6443"
configuration.verify_ssl=False
configuration.debug=True
configuration.api_key={"authorization":"Bearer "+ aToken}
k8client.Configuration.set_default(configuration)
v1=k8client.CoreV1Api()
nodes=v1.list_node(watch=False)
print nodes.items[0].metadata.name

Calm supports the following eScript functions.

urlreq

The API exposes REST interface as a set of objects. This action is implemented using python requests module.

urlreq(url, verb='GET', auth=None, c=None, user=None, passwd=None, params=None,
headers=None, timeout=None, send_form_encoded_data=True, allow_redirects=True,
cookies=None, verify=True, proxies=None)

requests.Response object is returned.

Table 2. Arguments
Arguments	Description
url	string, url to request
verb	string, verb is GET by default. POST, HEAD, PUT, PATCH, and DELETE are other valid entries.
auth	string (optional), BASIC and DIGEST are the valid entries. For authentication purposes, the order is as follows. username and password is authenticated by using user and passwd fields. username and password is authenticated by using name of credential supplied using c field. username and password is authenticated by using credential attached to the task.
user	string (optional), username used for authentication.
passwd	string (optional), password used for authentication.
params	dict (optional), if verb is GET, HEAD or DELETE, parameters are sent in the query string for the request otherwise they are sent in the body of the request.
headers	dict (optional), Dictionary of HTTP headers needs to be send along with the request.
timeout	integer (optional), you can configure requests to stop waiting for a response after a given number of seconds with the timeout parameter. timeout only elects the connection process itself, not the downloading of the response body.
send_form_encoded_data	boolean (optional), = True by default. If False, parameters dict is first dumped using simplejson.dumps() and then passed as a string.
allow_redirects	boolean (optional), = True by default. Specifies whether redirects should be allowed or not.
cookies	dict (optional), cookies dict to be sent along with the request.
verify	boolean (optional), = True by default. Specifies whether SSL certificates should be verified or not.
proxies	dict (optional), Dictionary mapping protocol to the URL of the proxy

Rules for authentication in the order of priority.

If they are not None , use user and passwd fields.
If c is not None , authenticate username and password from the credential name supplied.
If the above two criteria does not match, username and password are authenticated by using the credential attached to the task.

For example

params = {'limit': 1}
headers = {'content-type': 'application/octet-stream'}
r = urlreq(url, verb="GET", auth="BASIC", c='somecred', params=params, headers=headers)
r = urlreq(url, verb="POST", auth="BASIC", user="user", passwd="pass", params=params)

exit

The exit function is an alias for sys.exit of python standard library.

exit(exitcode)

For example

exit(0)

sleep

The sleep function is an alias for time.sleep.

sleep(num_of_secs)

For example

sleep(10)

_construct_random_password

The _construct_random_password API generates a random password and returns it.

_construct_random_password(lower, upper=None, numCaps=0, numLetters=0,
numDigits=0, numPuncs=0, startwith=None, caps=None, letters=None,
digits=None, puncs=None)

Returns: String

Table 3. Arguments
Argument	Description
lower	integer, minimum number of characters in the password.
upper	integer (optional), maximum number of characters in the password. If upper is not defined, then the password returned will always be as per lower, else the length can vary between lower and upper (both included).
numCaps	integer (optional), minimum number of capital letters that must be there in password.
numLetters	integer (optional), minimum number of letters that must be there in password.
numDigits	integer (optional), minimum number of digits that must be there in password.
numPuncs	integer (optional), minimum number of punctuation alphabets that must be there in password.
startwith	string (optional), password returned starts with one of the characters provided in startwith string.
caps	string (optional), default = 'A-Z'. This can be overridden.
letters	string (optional), default = 'a-zA-Z'. This can be overridden.
digits	string (optional), default = '0-9'. This can be overridden.
puncs	string (optional), default = '!@#$%^&'. This can be overridden.

Note: numCaps + numLetters + numDigits + numPuncs + 1 (if startwith is defined) must not be greater than upper.

_is_bad_password

The _is_bad_password function checks whether the password is correct or not.

_is_bad_password(password, reserved, dictionary=True, numCaps=0, numPuncs=0, \

numDigits=0, minLen=5)

For example

_is_bad_password("Abcd@123")

_randomchoose

The _randomchoose function is used to get a random character from a string.

_randomchoose(string)

For example

_randomchoose("adsadrer")

_shuffle

The _shuffle function is used to shuffle the sequence.

_shuffle(sequence)

For example

_shuffle(a)

get_sql_handle

The get_sql_handle function enables you to remotely connect and manage SQL Servers. It is implemented by using python pymssql module.

get_sql_handle(server, username, password, database='', timeout=0, login_timeout=60, charset='UTF-8', as_dict=False, host='', appname=None, port='1433', conn_properties=None, autocommit=False, tds_version=None)

Returns pymssql.Connection object

Table 4. Arguments
Argument	Description
server (str)	database host
user (str)	database user to connect as
password (str)	user’s password
database (str)	The database to initialize the connection with. By default SQL Server selects the database which is set as default for specific user
timeout (int)	query timeout in seconds, default 0 (no timeout)
login_timeout (int)	timeout for connection and login in seconds, default is 60 seconds
charset (str)	character set with which to connect to the database

For example

username="dbuser"
  password="myP@ssworD"
  server="10.10.10.10"
  port="1433"
  
  cnxn = get_sql_handle(server, username, password, port=port, autocommit=True)
  cursor = cnxn.cursor()
  
  # List all databases
  cursor.execute("""
    SELECT Name from sys.Databases;
  """)
  for row in cursor:
    print row[0]

    cnxn.close()

To refer to the video about supported eScripts, click here.

EScript Sample Script

The following script is an EScript sample script.

Note: Ensure that your script starts with #script .


#script

account_name = "@@{ACCOUNT_NAME}@@"
aviatrix_ip = "@@{address}@@"
new_test_password = "@@{NEW_TEST_PASSWORD}@@"
vpc_name = "Test"

api_url = 'https://{0}/v1/api'.format(aviatrix_ip)
#print api_url


def setconfig(api_url, payload):
  r = urlreq(api_url, verb='POST', auth="BASIC", user='admin', passwd='passwd', params=payload, verify=False)
  resp = json.loads(r.content)
  if resp['return']:
    return resp
  else:
    print "Post request failed", r.content
    exit(1)

print "Get the session ID for making API operations"
payload = {'action': 'login', 'username': 'admin', 'password': new_test_password}
api_url1 = api_url + "?action=login&username=admin&password="+ new_aviatrix_password
cid = setconfig(api_url=api_url1, payload=payload)
cid = cid['CID']
print cid

print "Delete the gateway"
payload = {'CID': cid,
  'action': 'delete_container',
  'account_name': account_name,
  'cloud_type': 1,
  'gw_name': vpc_name
  }
api_url1 = api_url + "?CID="+cid+"&action=delete_container&account_name="+account_name+"&cloud_type=1&gw_name="+vpc_name
print setconfig(api_url=api_url1,payload=payload)

print "Delete the aws account"

payload = {'CID': cid,
  'action': 'delete_account_profile',
  'account_name': account_name
  }
api_url1 = api_url + "?CID="+cid+"&action=delete_account_profile&account_name="+account_name
print setconfig(api_url=api_url1,payload=payload)

JWT Usage Sample Script

The following script is a jwt usage sample script.

Note: Ensure that your script starts with #script .


#script
jwt = '@@{calm_jwt}@@'

payload = {}
api_url = 'https://localhost:9440/api/nutanix/v3/apps/list'
headers = {'Content-Type': 'application/json',  'Accept':'application/json', 'Authorization': 'Bearer {}'.format(jwt)}
r = urlreq(api_url, verb='POST', params=json.dumps(payload), headers=headers, verify=False)
if r.ok:
    resp = json.loads(r.content)
    print resp
    exit(0)
else:
    print "Post request failed", r.content
    exit(1)

Sample Powershell Script

The following script is a powershell sample script.

Install-PackageProvider -Name NuGet -Force
Install-Module DockerMsftProvider -Force
Install-Package Docker -ProviderName DockerMsftProvider -Force

Sample Auto Logon and First Logon Scripts

Sample Auto Logon Script

The following script is a guest customization sample script for the Azure service.

<AutoLogon>
  <Password>
    <Value>@@{user.secret}@@</Value>
    <PlainText>true</PlainText>
  </Password>
  <Enabled>true</Enabled>
  <Username>@@{user.username}@@</Username>
</AutoLogon>

Sample First Logon Script

The following script is a guest customization sample script for the Azure service.

<FirstLogonCommands>
    <SynchronousCommand>
    <CommandLine>cmd.exe /c powershell -Command get-host</CommandLine>
    <Order>1</Order>
    </SynchronousCommand>
</FirstLogonCommands>

Sample Guest Customization Scripts for VMware and GCP Services

The following script is a guest customization sample script for the VMware service.

cmd.exe /c winrm quickconfig -q
cmd.exe /c winrm set winrm/config/service/auth @{Basic="true"}
powershell -Command "enable-psremoting -Force"
powershell -Command "Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Force"

The following script is a guest customization sample script for the GCP service.

#! /bin/bash\napt-get update\napt-get install -y apache2\ncat <<EOF > /var/www/html/index.html\n<html><body><h1>Hello World</h1>\n<p>This page was created from a simple startup script!</p>\n</body></html>\nEOF

Calm Blueprints Public Repository

Calm blueprints public repository contains custom blueprints and custom scripts that are created and published by community members. Calm also publishes official blueprints and tasks to the github public repository. You can clone the published blueprints and scripts and use from the repository. To access the repository, click here .

Seeding Scripts to the Calm Task Library

The blueprints repository of Calm contains script that can be seeded into task library and published to projects. You can use these tasks for blueprint configuration.

Procedure

Clone the blueprint repository from github. To access the repository, click here.
Change the directory to calm-integrations/generate_task_library_items .
To execute the script to seed, run the following command in bash.
bash generate_task_library_items.sh
Enter the following information.
- Prism Central IP : Enter the Prism Central IP address to which the task library items are to be seeded.
- Prism Central User : Enter the user name with the access to create task library scripts.
- Prism Central Password : Enter the password of the Prism Central user.
- Prism Central Project : Enter the Project name to which the task library items can be published.
To avoid giving inputs multiple times, run the following command to export environment variables before running the script. This step is optional.
```
export PC_IP=<prism central IP>    
export PC_USER=<prism central user>
export PC_PASSWORD=<prism central password>
export PC_PROJECT=<prism central project>
```

Run the following command to seed individual files into Calm.

python generate_task_library.py --pc $PC_IP--user $PC_USER --password $PC_PASSWORD --project $PC_PROJECT --script <path of script>

Calm Licensing and Upgrades

Calm Licensing

Calm license for Prism Central enables you to manage VMs that are provisioned or managed by Calm. Nutanix provides a free trial period of 60 days to try out Calm.

The Prism web console and Nutanix Support portal provide the most current information about your licenses. For detailed information about the Calm licensing feature, refer to the Prism Central Guide .

Calm Upgrades

Upgrade Calm or Epsilon using the Life Cycle Manager (LCM) from Prism Central. Epsilon is the orchestration engine for Calm. For more information , see Life Cycle Manager.

Life Cycle Manager

The Life Cycle Manager (LCM) allows you to track and upgrade the Calm and Epsilon versions in Prism Central.

Note: LCM 2.1 and above support Calm and Epsilon upgrades.

Performing Inventory with the Life Cycle Manager

Use LCM to display the software and firmware versions of the entities in the cluster.

Procedure

In Prism Central, click the gear icon to open the Settings page.
Select Life Cycle Management in the sidebar.

Figure. Life Cycle Management Click to enlarge
Click Options > Perform Inventory .
The LCM shows a warning message if you have not enabled the auto-update, and a new version of the LCM framework is available.
Figure. Perform Inventory Click to enlarge
Click OK .
The LCM displays all discovered entities.
To view the current Calm and Epsilon versions, click View All .

Figure. All Updates Click to enlarge

The Epsilon and Calm entities show the current version and the date and time of the most recent update.

Upgrading Calm with the Life Cycle Manager

Use LCM to upgrade Calm and Epsilon to the latest available versions.

Before you begin

Configure rules in your external firewall to allow LCM updates. For more details, see the Firewall Requirements section in the Prism Web Console Guide .
Run a successful inventory operation before upgrading Calm or Epsilon.

Procedure

In Prism Central, click the gear icon to open the Settings page.
Select Life Cycle Management in the sidebar.

Figure. Life Cycle Management Click to enlarge
Click Edit and select Nutanix Calm .
By default, Epsilon is selected.

Note: Do not select only Epsilon to update.
Click Change .
Select the check box next to the version that you want to upgrade.
Click Save .
You can also update the services from the Options list.
- To perform all available updates, select Update All .
- To perform only required updates, select Update Required .
- To perform only updates you have selected, select Update Selected .
  If you do not select any specific updates, the LCM performs all available updates.

Upgrading Calm at a Dark Site

By default, LCM automatically fetches updates from a pre-configured URL. If LCM fails to access the configured URL to fetch updates, you can configure the LCM to fetch updates locally to upgrade Calm and Epsilon.

About this task

Perform the following procedure to upgrade Calm and Epsilon at a dark site.

Note: When you upgrade Calm to the latest version as part of the Prism Central upgrade and if Policy Engine is enabled, then ensure to upgrade your policy engine as well.

Before you begin

Ensure that LCM version is 2.3 or above.

Procedure

Set up a local web server that is reachable by all your Nutanix clusters.
For more information about setting up a local web server, click here.
Note:
- You must use this server to host the LCM repository.
- From Calm 3.0.0.2 release onwards, when you set up a Windows local web server for LCM dark site upgrade, create an MIME type called '.xz' with the type set as text/plain.
From a device that has public Internet access, go to the Nutanix portal.
Click Downloads > Calm .
Select the required version and download Nucalm-X.X.X.X.ZIP , Epsilon-X.X.X.X.Zip , and Policy-X.X.X.X.ZIP tar files.
X.X.X.X represents the Calm, Epsilon, or Policy engine versions.
Transfer Nucalm-X.X.X.X.ZIP , Epsilon-X.X.X.X.Zip , and Policy-X.X.X.X.ZIP tar files to your local web server.
Extract the files into the local release directory.
You get the following files in the release directory.
- Nucalm-X.X.X.X.Zip
  - release/builds/calm-builds/x.x.x.x/metadata.json
  - release/builds/calm-builds/x.x.x.x/metadata.sign
  - release/builds/calm-builds/x.x.x.x/nucalm.tar.xz
- Epsilon-X.X.X.X.Zip
  - release/builds/epsilon-builds/x.x.x.x/metadata.json
  - release/builds/epsilon-builds/x.x.x.x/metadata.sign
  - release/builds/epsilon-builds/x.x.x.x/epsilon.tar.xz
- Policy-X.X.X.X.ZIP
  - release/builds/policy_engine-builds/x.x.x.x/metadata.json
  - release/builds/policy_engine-builds/x.x.x.x/metadata.sign
  - release/builds/policy_engine-builds/x.x.x.x/policy-engine.tar.gz
From a device that has public Internet access, go to the Nutanix portal.
Select Downloads > Calm .
Download nutanix_compatibility.tgz and nutanix_compatibility.tgz.sign tar files.
Transfer the compatibility tar files to your local web server and replace the files in the /release directory.
Log on to Prism Central.
On the LCM page, click Settings .
In the Source field, select Local web server .
In the URL field, enter the path to the directory where you extracted the tar file on your local server . Use the format http://webserver_IP_address/release .
Click Save .
In the LCM sidebar, select Inventory and click Perform Inventory .
Update the LCM framework before trying to update any other component.

The LCM sidebar now shows the LCM framework with the updated version.

Calm VM Upgrades

Refer to this section to upgrade Calm to the latest available version after you deploy the Calm VM.

Following are the available methods:

Prism Central (PC) / Calm VM upgrade - Upgrading the Prism Central (Calm VM) also upgrades the Calm version.
Life Cycle Manager (LCM) upgrade - You can upgrade to newer versions of Calm without performing a VM upgrade. Upgrades to most minor releases and few major releases are done using this method.

Upgrading Calm and Epsilon from Calm VM 3.5.1 to 3.5.2

Use the following procedure to upgrade Calm and Epsilon from Calm VM 3.5.1 to 3.5.2.

Procedure

Perform a Prism Central upgrade to version 2022.6.
For more information, see Upgrading Calm VM with Prism Central.

As part of Prism Central upgrade, Calm also upgrades to version 3.5.2.
SSH to Calm VM.
Run the docker ps command and check the status of Nucalm and Epsilon containers.
Verify that the Calm and Epsilon containers are healthy or wait for the services to get healthy.

Upgrading Calm VM with Prism Central

About this task

To upgrade Calm VM using the PC method, do the following:

Procedure

Login into the Calm VM GUI using the IP address.
Click Prism Central Settings > Upgrade Prism Central .

Figure. Prism Central Settings Click to enlarge

Check if the compatible PC version is available. If not, go to the Name Servers page and enter the global DNS server as the Name server.

Figure. Upgrade Prism Central Click to enlarge
In the Upgrade Prism Central page, click Download against the compatible version.

A confirmation window appears.

Click Yes to start the download process. After the download gets completed, you can view the Upgrade list.

Note: If the PC version you want to upgrade does not appear in the list, typically because you do not have Internet access (such as at a dark site), you can click the upload the Prism Central binary link to upload an image from your local media.
In the Upgrade list, click Upgrade Now .
A confirmation window appears.
Click Continue to start the upgrade process.

During the upgrade process, the Calm VM gets restarted.

Also, you can log in to the Calm VM GUI to view the upgraded version. In the top-left corner, click User Menu > About Nutanix .

Upgrading Calm VM with Life Cycle Manager

You can upgrade to newer versions of Calm without performing a VM upgrade. Upgrades to most minor releases and few major releases are done using the LCM method.

Before you begin

LCM perform inventory and Calm/Epsilon upgrade operations fail using the default LCM URL. The workaround is to replace the LCM repository URL to http://download.nutanix.com/lcm/saas under the LCM > Settings .

About this task

To upgrade Calm VM using the LCM method, do the following:

Procedure

Click Administration > LCM to open the LCM page.
Click Perform Inventory .

A confirmation window appears.

Figure. LCM - Perform Inventory Click to enlarge
Click Proceed .
The Perform Inventory process can take several minutes depending on your cluster size. Once completed, you can view the available updates in the Software page.
Select the check-box next to the Calm VM version that you want to upgrade. Then, click Update .

Note that the Epsilon check-box also gets selected. Epsilon is the orchestration engine used by Calm.

Figure. LCM - Upgrading Calm VM Click to enlarge

A confirmation window appears.

Note: Once the update process begins, it cannot be stopped or paused.
Click Apply Updates to complete.
If you do not have internet access, use the dark-site method to upgrade Calm. For more information, see Upgrading Calm VM with Life Cycle Manager at a Dark Site.

Upgrading Calm VM with Life Cycle Manager at a Dark Site

By default, Life Cycle Manager (LCM) automatically fetches updates from a pre-configured URL. If LCM fails to access the configured URL to fetch updates, you can configure the LCM to fetch updates locally to upgrade Calm and Epsilon. Perform the following procedure to upgrade Calm and Epsilon at a dark site.

About this task

Note:

Use the following procedure only for Calm VM deployments. Do not use this procedure to perform LCM upgrades in the Nutanix Prism Central VMs that are attached to Prism Elements.
If you have both Nutanix infrastructure (Nutanix Prism Central VMs attached to Prism Elements) and Calm VM, ensure to set up and manage two different LCM URLs or web servers to perform dark site upgrades for each type of deployments. For more information on using LCM for Prism Central VMs, see the Life Cycle Manager Dark Site Guide .
The following procedure handles the upgrades of Calm family only and does not handle upgrades of any other modules.

Before you begin

Ensure that LCM version is 2.3 or above.

Procedure

Set up a local web server that is reachable to your Calm VMs.
You will use this server to host the LCM repository.
Note:
- For more information about setting up a local web server, click here.
- From Calm 3.0.0.2 release, create a MIME type called '.xz' with the type set as text/plain when setting up a Windows local web server for LCM dark site upgrade.
Use the following steps to set up your LCM repository:
1. From a device that has public Internet access, go to the Nutanix portal and select Downloads > Calm .
2. Next to the Calm on ESX LCM Bundle entry, click Download to download the latest LCM framework tar file, lcm_dark_site_bundle_version.tgz .
3. Transfer the framework tar file to your local web server.
4. Extract the framework tar file into the release directory.
  The following files are extracted into the release directory.
  - master_manifest.tgz
  - master_manifest.tgz.sign
  - modules
  - nutanix_compatibility.tgz
  - nutanix_compatibility.tgz.sign
  - support.csv
  - support.md
From a device that has public Internet access, go to the Nutanix portal and select Downloads > Calm . Choose the required version and download Nucalm-X.X.X.X.ZIP and Epsilon-X.X.X.X.Zip tar files.
X.X.X.X represents the Calm and Epsilon versions.
Transfer Nucalm-X.X.X.X.ZIP and Epsilon-X.X.X.X.Zip tar files to your local web server and extract the files into local directory release .
After you extract and save the files in release folder, you can view the following files.
- Nucalm-X.X.X.X.Zip
  - release/builds/calm-builds/x.x.x.x/metadata.json
  - release/builds/calm-builds/x.x.x.x/metadata.sign
  - release/builds/calm-builds/x.x.x.x/nucalm.tar.xz
- Epsilon-X.X.X.X.Zip
  - release/builds/epsilon-builds/x.x.x.x/metadata.json
  - release/builds/epsilon-builds/x.x.x.x/metadata.sign
  - release/builds/epsilon-builds/x.x.x.x/epsilon.tar.xz
From a device that has public Internet access, go to the Nutanix portal and select Downloads > Calm . Download nutanix_compatibility.tgz and nutanix_compatibility.tgz.sign tar files.
Transfer the compatibility tar files to your local web server and replace the files in the /release folder.
Replace the existing compatibility files with the new files.
Log on to Prism Central.
On the LCM page, click Settings .
In the Source field, select Local web server .
In the URL field, enter the path to the directory where you extracted the tar file on your local server. Use the format http://webserver_IP_address/release .
Click Save .
You return to the Life Cycle Manager.
Select Inventory in the LCM sidebar and click Perform Inventory .
Update the LCM framework before trying to update any other component.

The LCM sidebar now shows the LCM framework with the same version as the LCM dark site bundle you downloaded.

Additional Information

Credential Security Support Provider

The Credential Security Support Provider (CredSSP) protocol is a security support provider that you implement using the Security Support Provider Interface (SSPI). CredSSP allows an application to delegate credentials of a user from the client to the target server for remote authentication. CredSSP provides an encrypted transport layer security protocol channel. The client is authenticated over the encrypted channel by using the Simple and Protected Negotiate (SPNEGO) protocol with either Microsoft Kerberos or Microsoft NTLM.

For more information, refer to the Microsoft Documentation .

Enabling CredSSP

Perform the following procedure to enable CredSSP.

Procedure

Run the following command to enable CredSSP on the target machine.

> Enable-WSManCredSSP -Role Server -Force

Generating SSH Key on a Linux VM

Perform the following procedure to generate an SSH key pair on a Linux VM.

About this task

Note: Avoid generating the RSA key pair on your Prism Central VM or CVM.

Procedure

Run the following shell command to generate an RSA key pair on your local machine.
```
$ ssh-keygen -t rsa
```
Accept the default file location as ~/.ssh/id_rsa .
You can find your public key at ~/.ssh/id_rsa.pub and the private key at ~/.ssh/id_rsa .

Note: Do not share your private key with anyone.

Generating SSH Key on a Windows VM

Perform the following procedure to generate an SSH key pair on Windows.

About this task

Note: Avoid generating the RSA key pair on your Prism Central VM or CVM.

Procedure

Launch PuTTygen.
Move the mouse cursor in the blank area and click Generate .
To convert the private key into an OpenSSH format, select Conversions > Export OpenSSH key .
PuTTygen warning message appears.
Click Yes to save the key without a passphrase.
Navigate to a location on your local system to save the key.
Type a name for the key.
Click Save .
Copy the public key (highlighted in the following image) into a plain text file and save the key at the same location as that of the private key.

Figure. Public Key Click to enlarge

Migrating to Integrated Linux Based PowerShell Gateway from Karan Service

Integrated Linux based PowerShell gateway is an in-built microservice of Calm that you can use to run Windows PowerShell scripts. You do not have to install any Windows VM separately or install Karan service manually to run the PowerShell scripts in Calm. Perform the following task to run the PowerShell scripts in Calm.

About this task

Note: Calm version 2.10 or later do not support manual Karan service installation.

Before you begin

Ensure that you meet the following requirements.

Calm version is 2.5.0 and above.
If you use Windows ISO image, enable remoting and open the 5985 and 5986 ports in the Windows disk image or in Sysprep XML.
Define script type as PowerShell to execute the PowerShell scripts.
Select the connection type as Windows(PowerShell) from the Connection Type list while configuring a VM.

Procedure

If you want to run the PowerShell scripts in the default execution mode, integrated Linux based PowerShell gateway runs the script by creating a remote PowerShell session and runs the script with NTLM authentication mode.
The following example displays a sample PowerShell script that runs in the default execution mode.
```
> Install-windowsfeature -name AD-Domain-Services –IncludeManagementTools
```
If the PowerShell scripts need elevated privileges, run the following command to enable the CredSSP server role on the target machine.
```
> Enable-WSManCredSSP -Role Server -Force
```
The following example displays a sample PowerShell script that requires the elevated privileges.
```
> Install-windowsfeature -name AD-Domain-Services –IncludeManagementTools
```

Integrated Linux Based PowerShell Gateway Errors

You might encounter the following errors when you run the PowerShell scripts using the integrated Linux based PowerShell gateway.

Table 1. Integrated Linux Based PowerShell Gateway Errors
Error	Description
Access denied	If the VM and the WinRM services are started but the specified credential is wrong. You encounter the error in the following cases. When you use the local account credential of a domain member machine. You can resolve the issue by using the domain credentials. When the script requires elevated privileges and the CredSSP is not enabled on the target machine. You can resolve the issue by enabling the CredSSP on the target machine. For more information on enabling CredSSP, see Credential Security Support Provider.
Connection refused	You encounter the connection refusal error in the following cases. When a VM is not started but Calm tries to do a check-login or runs a PowerShell task. You can resolve the issue by adding a delay time task. For more details, see Creating a Delay Task. When Calm is not able to communicate with the target machine. You can resolve the issue by allowing the connection to the port that is used to contact the target machine. Ensure that all the firewalls between Prism Central and the target machine allow connections to the port.

Localization

Nutanix localizes the user interface in simplified Chinese and Japanese. All the static screens are translated to the selected language. You can change the language settings of the cluster from English (default) to simplified Chinese or Japanese. For information on how to change the language setting, refer to the Prism Central Guide .

Calm Administration and Operations Guide

Calm 3.6

Product Release Date: 2022-09-06

Last updated: 2022-11-22

Introduction

Introduction to Calm

Calm (also called NCM Self Service) allows you to seamlessly select, provision, and manage your business applications across your infrastructure for both the private and public clouds. Calm provides application automation, lifecycle management, monitoring, and remediation to manage your heterogeneous infrastructure, for example, VMs or bare-metal servers.

Calm Key Benefits

Calm is a multi-cloud application management framework that offers the following key benefits:

IT Agility and Human Error Elimination
Calm simplifies the setup and management of custom enterprise applications by incorporating all important elements, such as the relevant VMs, configurations, and related binaries into an easy-to-use blueprint. These blueprints make the deployment and lifecycle management of common applications repeatable and help infrastructure teams eliminate extensive and complex routine application management.
Unified Multi-Cloud Orchestration
Calm unifies the management of all your clouds into a single-pane-of-glass, removing the need to switch between portals. Calm automates the provisioning of multi-cloud architectures, scaling both multi-tiered and distributed applications across different cloud environments, including AWS, GCP, Azure, and VMware (on both Nutanix and non-Nutanix platforms).
Automated Self-Service with Centralized Control
Calm empowers different groups in the organization to provision and manage their own applications, giving application owners and developers an attractive alternative to public cloud services. Calm provides powerful, application-centric self-service capabilities with role-based access control. All activities and changes are logged for end-to-end traceability, aiding security teams with key compliance initiatives.
Nutanix Marketplace
The marketplace offers preconfigured application blueprints that infrastructure teams can instantly consume to provision applications. The marketplace also provides the option to publish sharable runbooks. A runbook is a collection of tasks that are run sequentially at different endpoints. Infrastructure teams can define endpoints and use runbooks to automate routine tasks and procedures that pan across multiple applications without the involvement of a blueprint or an application.
Cost Governance
With native integration into Beam, Calm also shows the overall utilization and true cost of public cloud consumption to help you make deployment decisions with confidence.
Application Development and Modernization
Combined with Nutanix Karbon or your choice of certified Kubernetes, Calm provides the tools required to modernize applications without losing control of policy. Additionally, Calm natively integrates with Jenkins to empower CI/CD pipelines with automatic infrastructure provisioning or upgrades for all applications.
Calm DSL - Infrastructure-as-Code (IaC)
Calm DSL describes a simpler Python3-based Domain Specific Language (DSL) for writing Calm blueprints. DSL offers all the richness of the Calm user interface along with additional benefits of being human readable and version controllable code that can handle even the most complex application scenario. DSL can be also used to operate Calm from a CLI.

As Calm uses Services, Packages, Substrates, Deployments and Application Profiles as building blocks for a blueprint, these entities can be defined as Python classes. You can specify their attributes as class attributes and define actions on those entities (procedural runbooks) as class methods.

Calm DSL also accepts appropriate native data formats such as YAML and JSON that allow reuse into the larger application lifecycle context of a Calm blueprint.

For technical articles, videos, labs and resources on Calm DSL, see Nutanix Calm DSL on Nutanix.dev.

Calm Prerequisites

Pre-configuration for Using Calm

You must configure the following components before you start using Calm.

Image configuration for VM: To use Nutanix as your provider, you must add and configure the image for your VMs. Images are provider-specific. You can upload images to Prism Central or Prism web console and use those images when you configure your blueprints. For more information, see Image Management section in the Prism Central Guide .
SSH key (optional): Generate SSH keys so that you can use them for authentication when you configure or launch your blueprints. For more information, see Generating SSH Key on a Linux VM or Generating SSH Key on a Windows VM.
Lightweight Directory Access Protocol (LDAP): Configure LDAP to authenticate users or group of users to use Calm. For more information about LDAP, see Configuring Authentication section in the Prism Central Guide .
SSP: The Prism Self Service feature allows you to create projects within an enterprise. Users or group of users can provision and manage VMs in a self-service manner without involving IT in their day-to-day operations. For more information, see Prism Self Service Administration section in the Prism Central Guide .

Prerequisites to Enable Calm

Before you enable Calm from Prism Central, ensure that you have met the following prerequisites.

The Prism Central version is compatible with Calm.
You can go to the Software Product Interoperability page to verify the compatible versions of Calm and Prism Central.
The Prism Central in which Calm is running is registered with the same cluster.
Note:
- Calm is supported only on AHV and ESXi hypervisors on a Nutanix cluster.
- Calm is not supported on Hyper-V cluster.
- Calm does not support vSphere essential edition. If you try to enable Calm with vSphere essential edition license, you get a failure notification because hot-pluggable virtual hardware is not supported by vSphere essential edition.
A unique data service IP address is configured in the Prism web console cluster that is running on Prism Central. For more information about configuring data service IP address, see the Modifying Cluster Details in the Prism Web Console Guide .
Note: Do not change the data service IP address after Calm enablement.
A minimum allocation of 4 GB of memory for a small Prism Central and 8 GB of memory for large Prism Central. For more information, see Calm Benchmarks.
All the required ports are open to communicate between a Prism web console and Prism Central. For more information about ports, see Port Reference.
The DNS server is reachable from Prism Central. Unreachable DNS server from Prism Central can cause slow deployment of Calm.

Calm Benchmarks

Use these guidelines as a good starting point for your Calm installation. You might have to allocate more resources over time as your infrastructure grows.

Calm Single-Node Profile

The following table shows the Calm benchmarks for a single-node Prism Central profile.


Prism Central size	Prism Central configuration	Number of VMs	Number of single-VM blueprints	Number of single-VM applications	Number of projects	Number of runbooks
Small (1 node)	6 vCPUs and 30 GB of memory for each node.	2000	400	2000	50	250
Large (1 node)	10 vCPUs and 52 GB of memory for each node.	7000	1400	7000	250	500

Calm Three-Node (Scale-Out) Profile

The following table shows the Calm benchmarks for a three-node Prism Central profile. If high-availability is preferred, it is recommended to use the scale-out deployment.


Prism Central size	Prism Central configuration	Number of VMs	Number of single-VM blueprints	Number of single-VM applications	Number of projects	Number of runbooks
Small (3 nodes, scale out)	6 vCPUs and 30 GB of memory for each node.	3500	700	3500	100	500
Large (3 nodes, scale out)	10 vCPUs and 52 GB of memory for each node.	12500	2500	12500	500	1000

Benchmark Considerations

The following considerations are applicable for both Calm single-node and three-node (scale-out) profiles:

When you enable Calm, an additional 4 GB memory per node is added to the Prism Central small deployment profile and 8 GB of memory per node is added to the Prism Central large deployment profile.
The listed application and blueprint numbers include both running and deleted applications and blueprints. Data related to deleted applications and blueprints is cleaned up after 3 months.
All the listed VM numbers are for the VMs that are managed by Calm and not Prism Central overall.
These performance tests are done by using single-service blueprints and applications. Results might be lower when blueprints with multiple services are deployed.
Calm automatically archives the logs every 3 months to clean up the database and to free up the resources. You can also increase the memory (RAM) of your deployed Prism Central VM to increase the Calm capacity.

Calm Throughput

The maximum throughput on a large three-node (scale-out) deployment profile is 400 VMs per hour.

Note: For customized higher capacity Calm configurations, work with your Nutanix sales representative.

Port Information in Calm

Calm Enablement

Enabling and Accessing Calm

Calm is integrated into Prism Central and does not require you to deploy any additional VMs. To start using Calm, you only have to enable Calm from Prism Central.

Before you begin

Ensure that you have met the prerequisites to enable Calm. For more information, see Prerequisites to Enable Calm.

Note:

If the Prism web console is not registered from a Prism Central and the application blueprints have subnet, image, or VMs on the Prism web console, the Calm functionality is impacted.

Procedure

Log on to Prism Central with your local admin account.
For detailed information on how to install and log on to Prism Central, see the Prism Central Guide .
From the Prism Central UI, click Services > Calm .
Click Enable .

Note: The Enable option appears only when you log on to Prism Central with a local admin account.

When you enable Calm, an additional 4 GB memory per node is added to the Prism Central small deployment profile and 8 GB of memory per node is added to the Prism Central large deployment profile.
To access Calm, click Services > Calm from the entities menu.

What to do next

You can instantaneously launch your first application. For more information, see Launching a Blueprint Instantaneously.

Checking Calm Version

You can check the version of your Calm instance from the Calm user interface.

Procedure

From the Prism Central entities menu, click Services > Calm .
Click the icon on the bottom-left corner.
The About Nutanix Calm page appears displaying the version number of Calm. For example:
Figure. Version Number Click to enlarge

Calm VM Deployment

Calm VM is a standalone VM that you can deploy on AHV and ESXi hypervisors and leverage calm functionality without the Nutanix infrastructure.

Note:

Calm VM currently supports Calm version 3.6.
Calm VM supports scale-out deployment. See Setting up Scale-Out Calm VM.
The supported ESXi versions are 6.0.0 and 6.7 (vCenter version 6.7).

You can deploy Calm VM on ESXi in one of the following ways:

Using the vSphere Web Client. See Deploying Calm VM using the vSphere Web Client
Using the vSphere CLI. See Deploying Calm VM using the vSphere CLI

For information on Calm VM deployment on AHV, see Deploying Calm VM on AHV.

Deploying Calm VM on AHV

This section describes the steps to deploy a Calm VM on AHV.

Before you begin

Ensure that you have the URL of the OVA file.

Procedure

From the Prism Central entities menu, click Compute & Storage > OVAs .
Click Upload OVA .
The Upload OVA page appears.
Under OVA Source, select the URL radio button and do the following.

Figure. Upload OVA Click to enlarge
1. Provide a name in the Name field.
2. Provide the URL of the OVA file of the Calm VM in the OVA URL field.
3. Click Upload .
On the OVAs page, select the uploaded OVA from the list.
From the Actions list, select Deploy as VM .

Figure. Deploy VM Click to enlarge
On the Deploy as VM page, do the following:

Figure. Deploy as VM - Configuration Click to enlarge
1. Under the VM Properties section, specify the values for CPU , Cores Per CPU , and Memory .
  The CPU and Memory requirements of the Calm VM Deployment is equivalent to the Calm single-node profile. For the benchmark values, see Calm Benchmarks.
2. Click Next .
3. To configure the networks, associate the required subnets for your Calm VM instance.
4. Click Next .
5. Click Create VM to start the deployment of the Calm VM instance.
From the Prism Central entities menu, go to Compute & Storage > VMs and do the following:

Figure. VM Power On Click to enlarge
1. Select the Calm VM instance that you deployed.
2. Click Actions and then click Power On to power on the Calm VM instance.
3. Wait for the Calm services to be up and running.

What to do next

To manage and administer your applications, use the Calm VM IP address and the following default credentials to log in to the Calm VM for the first time:

Username: admin
Password: Nutanix/4u

You can change the default credentials after you log in.

Deploying Calm VM using the vSphere Web Client

You must create a VM with a specific Open Virtualization Format (OVF) image to access the Calm UI.

Before you begin

Ensure that you have the URL of the OVF file, or you have saved the OVF file on your local machine.

Procedure

Log on to the vSphere web client.
Click the cluster on which you want to deploy the Calm VM.

Figure. vSphere Web Client - Deploying OVF Template Click to enlarge
Click Actions > Deploy OVF Template .

Figure. Deploy OVF Template - Window Click to enlarge
In the Deploy OVF Template window, do the following.
1. Click the Local File option to browse and upload the OVF file from your local machine.
  Go to Nutanix Support Portal - Downloads and download the OVF file.
2. Click Next and select the cluster where you want to deploy the Calm VM.
3. Click Next and configure the storage and networks for the VM. Then, click Finish .
The system starts importing and deploying the file on the selected VMware cluster. After the deployment is complete, the Calm VM needs to be powered on.
Note: Calm services takes around 30 min to start after the VM is powered on.

For more information, see Deploying OVA Template on VMware vSphere section in the VMware documentation .

What to do next

To manage and administer your applications, use the Calm VM IP address and the following default credentials to log in to the Calm VM for the first time:

Username: admin
Password: Nutanix/4u

You can change the default credentials after you log in.

Deploying Calm VM using the vSphere CLI

This section describes the steps to deploy a Calm VM by using the vSphere CLI (govc).

Before you begin

Ensure that you have installed all the libraries of the vSphere CLI client (govc). For more information, click here.

Procedure

Login to the SSH client.

Note: Ensure that you have installed the govc libraries.
Run the following command.
```
$ govc import.ova -name 5.17.1-prismcentral -3.0.0.1 http://endor.dyn.nutanix.com/GoldImages/calm-vm
```
If you have downloaded the OVF file on your system, replace http://endor.dyn.nutanix.com/GoldImages/calm-vm with the location of the OVF file.
Figure. vSphere CLI (govc) - Deploy Calm Click to enlarge

Running the command starts the uploading process. Once the uploading is complete, power on the Calm VM from the vSphere web client.

Note: Calm services takes around 30 min to start after the VM is powered on.

What to do next

To manage and administer your applications, use the Calm VM IP address and the following default credentials to access Calm VM for the first time:

Username: admin
Password: Nutanix/4u

You can change the default credentials after you log in.

Setting up Scale-Out Calm VM

Use the following procedure to set up Scale-out version of Calm VM.

Before you begin

Ensure that:

Your VMware vCenter version is later than 6.0.
You downloaded the Calm VM OVA file from the Downloads page.
You uploaded the Calm VM OVA file on ESXi using the vSphere CLI (govc) or vSphere Web Client and marked it as a template. See Deploying Calm VM using the vSphere Web Client and Deploying Calm VM using the vSphere CLI.
You uploaded the Calm VM OVA file on AHV using the Prism Central User Interface. See Deploying Calm VM on AHV.
You have taken a backup of Calm data in case you are planning to extend an existing Calm VM.

Procedure

Create three Calm VMs using the templates you uploaded.
Do one of the following:
- To assign static IP addresses to the VMs, see Launching Calm VM with a Static IP Address.
- If DHCP is enabled, continue to step 3.
SSH to the three Calm VMs and wait until all the cluster services, including Calm and Epsilon, are up and running.
Run the following commands on all three VMs.
```
cluster stop
```
```
cluster destroy
```
Note: Run these commands only after taking a backup of the Calm data in case you are extending an existing

Run the cluster create command on one of the three VMs.

To create a simple cluster, run the following command:

#cluster --cluster_function_list="multicluster" -s <ip1>,<ip2>,<ip3> create

For example:

cluster --cluster_function_list="multicluster" -s 10.46.141.71,10.46.138.20,10.46.138.26 create

To create an advanced cluster with cluster name and virtual IP, run the following command:

cluster --cluster_function_list="multicluster" --cluster_name "<Cluster Name>" -s <ip1>,<ip2>,<ip3> --cluster_external_ip=<vip> create

For example:

cluster --cluster_function_list="multicluster" --cluster_name "Demo" -s 10.46.141.71,10.46.138.20,10.46.138.26 --cluster_external_ip=10.46.141.70 --dns_servers 10.40.64.15,10.40.64.16 create

Run the following command on one of the three VMs.
```
cd /home/nutanix/bin
python enable_calm.py
```
Run the following command to verify epsilon and Calm services status:
```
cluster status
```
Enable policy engine for Calm VM. For more information, see Enabling Policy Engine for Calm VM.

Run the following command to set up policy engine on one of the VMs.

docker cp /home/nutanix/bin/set_policy_calmvm.pyc nucalm:/home
docker cp /home/nutanix/bin/set_policy.sh nucalm:/home
docker exec nucalm /bin/sh -c '/home/set_policy.sh <POLICY_VM_IP> <POLICy_VM_UUID>'

What to do next

To manage and administer your applications, use the Calm VM IP address and the following default credentials to log in to the Calm VM for the first time:

Username: admin
Password: Nutanix/4u

You can change the default credentials after you log in.

Enabling Policy Engine for Calm VM

Use the following steps to enable policy engine for Calm VM.

Before you begin

Ensure that you have the accounts configured. For more information, see Provider Account Settings in Calm.
Ensure that you have created a project for the blueprint. For more information, see Projects Overview.
The project to which you upload the blueprint must have the account in which you want to create the policy engine VM.

Procedure

To enable policy engine on a new deployment of Calm VM, do the following:
1. Download the blueprint from one of the following locations.
  - To download the blueprint for a single-node Calm VM, click here.
  - To download the blueprint for a scale-out Calm VM, click here.
2. Upload the downloaded blueprint to a project.
  
  Note: You can add any string in the credential password and save the blueprint to avoid any blueprint errors after the upload.
3. Set values for the following variables in the blueprint.
  - Desired policy engine IP address. This IP address must be in the same network as that of the Calm VM.
  - VIP of the Calm VM
  - Netmask of the Calm VM network
  - Gateway of the Calm VM network
  - DNS IP of the Calm VM
  - NTP IP of the Calm VM
  - Public key of CALM VM. For scale-out Calm VM, provide the public key of all VMs.
  - Disable check-login in case the check-login is enabled by default.
4. Launch the blueprint.
5. Wait for the application that you created by launching the blueprint to get into the running state.
6. SSH into the Calm VM as a Nutanix user and run the following command after making the required changes.
```
docker cp /home/nutanix/bin/set_policy_calmvm.py nucalm:/home
docker cp /home/nutanix/bin/set_policy.sh nucalm:/home
docker exec nucalm /bin/sh -c '/home/set_policy.sh <POLICY_VM_IP> <POLICY_VM_UUID>'
```
To upgrade the policy engine VM on an upgraded Calm VM, do the following:
1. SSH to the policy engine VM as a Nutanix user.
2. Wget the policy-engine.tar.gz file from the Downloads page on to the policy engine VM.
3. Untar (extract) the policy-engine.tar.gz file.
4. Locate and run upgrade.sh .
5. Run the docker ps command to check the status of policy containers, and wait for the containers to get healthy.
To enable the policy engine VM on an upgraded Calm VM where the older version did not have the Policy Engine VM enabled, do the following:
1. Download the set_policy_calmvm.py script from the Downloads page into the /home/nutanix/bin/ directory of your Calm VM and provide the execute permission.
2. Download the set_policy.sh script from the Downloads page into the /home/nutanix/bin/ directory of your Calm VM and provide the execute permission.
3. Perform Step 1 to enable the policy engine VM.

Launching Calm VM with a Static IP Address

By Default, Calm VM uses DHCP IP address. You can use the following procedure to launch Calm VM using a static IP address.

Procedure

Log on to vCenter.
In the Navigator pane, go to Home > Policies and Profiles > Customization Specification Manager .
Click Create a new specification and do the following:

Figure. Create New Specification Click to enlarge
1. In the Target VM Operating System drop-down menu, select Linux .
  
  Figure. Specify Properties Click to enlarge
2. In the Customization Spec Name field, enter a name for the specification.
3. (Optional) Add a description in the Description field.
4. Click Next .
On the Computer Name page, do the following.

Figure. Set Computer Name Click to enlarge
1. Select the Use the virtual machine name radio button.
2. Enter a domain name in the Domain name field.
3. Click Next .
On the Time Zone page, specify the time zone and then click Next .
On the Configure Network page, do the following:

Figure. Configure Network Click to enlarge
1. Select the Manually select custom settings radio button.
2. Click the Edit icon for the NIC to open the IP details page.
  
  Figure. IP Details Click to enlarge
3. On the IPv4 page, select the Prompt the user for an address when the specification is used radio button.
4. Enter the subnet mask in the Subnet Mask field.
5. Enter the default gateway in the Default Gateway field.
6. Click OK .
7. On the Configure Network page, click Next .
On the Enter DNS and Domain Settings page, enter the DNS and DNS search path details, and then click Next .
On the Ready to complete page, verify the details you entered, and then click Finish .
To launch the VM, do the following:
1. Click Actions and then select New VM from This Template... .
  Before you launch the VM, ensure that you have uploaded the Calm VM OVA file to vCenter and converted it as a template.
2. On the Select a name and folder page, enter a name for the VM, select the datacenter location for the VM, and then click Next .
  
  Figure. Name and Datacenter Click to enlarge
3. On the Select a compute resource page, select a cluster or node, and then click Next .
4. On the Select storage page, select the datastore and click Next .
5. On the Select clone options page, select the following check boxes.
  - Customize the operating System
  - Customize this virtual machine’s hardware
  - Power-on virtual machine after creation
6. On the Customize guest OS page, select the customization spec that you created.
  
  Figure. Customization Spec Click to enlarge
7. On the User Settings page, enter the IP address that you want to assign to the VM, and then click Next .
  The User Settings page appears because you selected the Prompt the user for an address when the specification is used radio button during the setup.
  
  Figure. User Settings Click to enlarge
8. On the Customize hardware page, update the CPU, memory, and network requirements, and then click Next .
9. On the Ready to complete page, verify the details you entered, and then click Finish .
Use these steps to launch other VMs in case of a scale-out Calm VM.

What to do next

To set up scale-out Calm VM, see Setting up Scale-Out Calm VM.

Getting Started with Calm

Calm Overview

The following table lists the different tabs in Calm, their icons, and their usage:

Table 1. Calm Tabs
Icons	Tab	Usage
	Marketplace tab	To instantly consume application blueprints to provision applications. See Marketplace Overview.
	Blueprint tab	To create, configure, publish, and launch single-VM or multi-VM blueprints. See Calm Blueprints Overview.
	Application tab	To view and manage applications that are launched from blueprints. See Applications Overview.
	Library tab	To create and use variable types and tasks. You use variables and tasks while configuring a blueprint. See Library Overview.
	Runbooks tab	To automate routine tasks and procedures that pan across multiple applications without involving any blueprints or applications. See Runbooks Overview.
	Endpoints tab	To create and manage target resources where the tasks defined in a runbook or in a blueprint can run. See Endpoints Overview.
	Settings tab	To enable or disable general settings. See General Settings in Calm. To configure and manage provider accounts. See Provider Account Settings in Calm. To configure and manage credential provider. See Configuring a Credential Provider.
	Policies tab	To schedule application actions and runbook executions. See Scheduler Overview.
	Marketplace Manager tab	To manage approval and publishing of application blueprints. See Marketplace Manager Overview.
	Projects tab	To create users or groups and assign permissions to use Calm. Projects tab also allows you to configure environment for your providers. See Projects Overview.

Exploring Calm

You can use the following procedure to explore Calm user interface and get an overview of the Calm components.

Procedure

Click the Tour icon on the bottom-left pane and click Explore Calm .
Do one of the following.
1. To navigate through the Calm components, click the right or left arrow.
2. To skip the tour, click Skip tour .

Accessing Calm REST API Explorer

You can use the following procedure to access the Calm REST API explorer console from the Calm user interface.

Procedure

Click the icon on the bottom-left corner.
The About Nutanix Calm page appears.
Click the Rest API Explorer link.
The Calm REST API explorer interface appears.

Role-Based Access Control in Calm

Users or groups are allowed to view, launch, or manage applications based on the roles that are assigned within the projects. Calm has the following roles for users or groups:

Project Admin
Project admins have full control of the project. They can perform reporting and user management, create blueprints, launch blueprints, and run actions on the applications.
Developer
Developers can create blueprints, launch blueprints, and run actions on the applications. They are, however, not allowed to perform reporting and user management.
Consumer
Consumers can launch new blueprints from the marketplace and run actions on the applications. They are, however, not allowed to create their own blueprints.
Operator
Operators have minimum access and are allowed only to run actions against existing applications. They are not allowed to launch new blueprints or edit any existing blueprints.

Note: A Prism Admin is a super user within Calm and within the rest of Prism Central who has full access to all the features and functionalities of Calm.

The following table details the roles and responsibilities in Calm:

Table 1. Roles and Responsibilities Matrix
		Prism Admin	Project Admin	Developer	Consumer	Operator
Marketplace	Enable and Disable	X
	Manage	X
	App publishing request	X	X	X
	Send App publishing request to the Administrator	X	X
	Clone and edit App blueprint	X	X	X
Blueprint	Create, update, delete, and duplicate	X	X	X
	Read-only	X	X	X	X
	Launch	X	X	X	X
Applications	Complete App summary	X	X	X	X	X
	Run functions	X	X	X	X	X
	App debug mode	X	X	X	X	X
	Function edit	X	X	X
	Create App (brownfield import)	X	X	X
	Delete App	X	X	X	X
Settings	CRUD	X
Task Library	View	X	X	X	X	X
	Create and Update	X	X	X
	Delete	X
	Sharing with Projects	X
Projects	Add project	X
	Update project	X	X
	Add VMs to projects	X
	Custom roles
Users	Add users to the system and change roles	X
	Add and remove users to or from a project	X	X
	Change user roles in a project	X	X
	Create Administrator	X
	Create Project Administrator	X	X
Runbooks	Create and Update	X	X	X
	View	X	X	X	X	X
	Delete	X	X	X
	Execute	X	X	X	X	X
Endpoints	Create and Update	X	X	X
	View	X	X	X	X	X
	Delete	X	X	X
Scheduler	Create, delete, and clone jobs	X	X	X	X
	Read job and view execution status	X	X	X	X	X
	Update job name, schedule, executable, and application action	X	X	X	X
	Edit operations on a blueprint launch	X	X	X	X
	Edit operations on runbook executions	X	X	X	X
	Edit operations on application actions	X	X	X	X
	Edit operations on Marketplace launch	X	X	X	X

Note: Scheduler does not support custom roles in this release.

Calm: Quick Start

Launching a Blueprint Instantaneously

About this task

Video: Launching a Blueprint Instantaneously

Procedure

Click the Tour icon in the bottom-left pane and click Launch Blueprint .
The Quick Launch a Blueprint page appears.
On the Select Blueprint tab, click Next .
The default selection for launch is ExpressLaunch.
On the Select Project tab, select a project and click Next .
Projects are logical groupings of user roles, providers, VM templates, and credentials used to manage and launch blueprints within your organization. For more information, see Projects Overview.
On the Select App Profile tab, click Next .
The default selection for launch is an application profile that is configured with your Nutanix account.

Application profiles are profiles for different datacenters or cloud services where you want to run your application. For more information, see Calm Blueprints Overview.
On the Preview and Launch tab, type a name for your application and click Launch and Create App .
The Preview and Launch tab displays the VM details of your application.

The blueprint application is created and provisioned.

What to do next

You can view the details of the blueprint application on the Applications tab. For more information, see Applications Overview.

Provisioning a Linux or Windows Infrastructure as a Service (IaaS)

To quickly provision a Linux or Windows Infrastructure as a Service (IaaS) for your end users, you can configure and launch a single-VM blueprint in Calm.

Before you begin

Ensure that you have enabled Calm from your Prism Central instance. For more information, see Enabling and Accessing Calm.
Ensure that you have configured the projects that you want to use to provision your IaaS. For more information, see Projects Overview.

About this task

Provisioning a Linux or Windows IaaS involves configuring the single-VM blueprint VM specifications and launching the blueprint.

Procedure

Log on to Prism Central.
From the Prism Central UI, click Services > Calm .
Click the Blueprint icon in the left pane.
Click + Create Blueprint > Single VM Blueprint .
On the Blueprint Settings tab, enter a name and description for your blueprint, and select a project and an environment.

Figure. Blueprint Settings Click to enlarge
On the VM Details tab, enter a VM name, and then select an account and an operating system.

Figure. VM Details Click to enlarge

If you have not configured any account, then keep the default Nutanix account selected. For detailed information about configuring provider accounts, see Provider Account Settings in Calm.

You can select Linux or Windows as the operating system of your IaaS.
On the VM Configuration tab, do the following:
1. Enter the number of vCPU, cores of each vCPU, and total memory to configure the processing unit of the VM.
2. Provide the guest customization, if required.
3. Based on the operating system you selected, select a Linux image or a Windows image from the image service under the Disks section.
4. Select a network configuration under the NICs section.
Figure. VM Configuration Click to enlarge

For detailed information about the VM configuration for different provider accounts, see VM Configuration.
Click Save to save the blueprint.
Click Launch to launch the blueprint.

Figure. Blueprint Launch Click to enlarge
Provide an application name, description, environment, and application profile, and then click Deploy .
If you have not configured any environment or application profile, keep the default environment and application profile selected.
Navigate to the Applications tab to view and access the application.

What to do next

You can publish the blueprint to the marketplace so that other project users can also launch the blueprint and use the IaaS. For more information, see Submitting a Blueprint for Approval.
You can create single-VM blueprints with different provider accounts and launch them. For more information, see Creating a Single-VM Blueprint.

General Settings in Calm

The Settings tab allows you to control the overall administrative functionalities of the Calm instances. You must be a Prism Central administrator to access the Settings tab.

You can use the Settings > General tab to control the following functionalities:

Enable the Default Landing Page option to make Calm as the default landing page in Prism Central.
Enable the availability of ready-to-use application blueprints in the marketplace manager. For more information, see Marketplace Manager Overview.
Enable showback to estimate the overall service cost of the applications running on your on-prem cloud. For more information, see Showback.
Enable the policy engine to enforce resource quota policy for the infrastructure resources (compute, memory, and storage) on Nutanix and VMware. For more information, see Policy Engine Overview.
Set up quota defaults for vCPU, memory, and disk so that they can populate automatically when you allocate quotas to your provider accounts. For more information, see Setting up Quota defaults.
Disable policy engine quota enforcement for your Calm instance in case the policy engine VM does not respond or encounters any connectivity issues. For more information, see Disabling Policy Enforcement.
Download application logs that are archived by the system periodically to clear resources. For more information, see Application Log Archive.

Enabling Nutanix Marketplace Applications

Procedure

Click the Settings icon in the left pane.
Under the General tab, click the Nutanix Marketplace Apps toggle button.
The application blueprints appear on the Marketplace Manager tab.

What to do next

You can associate the ready-to-use application blueprints with a project and publish them to the marketplace. For more information, see Approving and Publishing a Blueprint or Runbook.

Showback

Showback allows you to estimate the overall service cost of the applications running on your on-prem cloud. You can also view the graphical representation of the cost of the applications.

Calm supports showback for the following platforms.

Nutanix
VMware through vCenter

To enable and configure showback, see Enabling Showback.

Note: Starting with AOS 5.10 or NCC 3.6.3, Prism Central generates the following NCC alerts for showback:

Beam connectivity with Prism Central
Prism Central and Prism web console (also known as Prism Element) registration or de-registration

Enabling Showback

About this task

Video: Enabling Showback

Procedure

Log into Prism Central as an administrator.
Click the Settings icon in the left pane.
Under the General tab, click the Enable Showback toggle button.
The Enable Showback window is displayed.
Click the supported provider for which you want to define the cost.
To configure the resource usage cost, click Edit for the selected provider, and configure the cost of the following resources.
1. In the vCPU field, enter the cost of vCPU consumption for each hour in dollars.
  The default value is $0.01 for each vCPU for each hour.
2. In the Memory field, enter the cost of memory consumption for each hour in dollars.
  The default value is $0.01 for each GB of usage for each hour.
3. In the Storage field, enter the cost of storage consumption for each hour in dollars.
  The default value is $0.0003 for each GB of usage for each hour.
Click Enable Showback .

Disabling Showback

Disable showback to stop monitoring the resources cost of your application blueprints.

Procedure

Log into Prism Central as an administrator.
Click the Settings icon in the left pane.
Under the General tab, click the Disable Showback toggle button.
The Disable Showback window is displayed.
To disable Showback, click Disable Showback .

Policy Engine Overview

As an administrator, you can enable the policy engine to:

Enforce resource quota policy for the infrastructure resources (compute, memory, and storage) on Nutanix and VMware. The quota policy enforcement allows better governance on resources across infrastructures at the provider and project levels. See Quota Policy Overview.
Orchestrate applications through tunnels on a virtual private network (VPC) on Nutanix accounts. See Tunnels for Orchestration within a VPC.
Enforce approval policies to manage resources and control actions in your environment. See Approval Policy Overview.
Schedule application actions and runbook executions. See Scheduler Overview.

Enabling policy Engine

The policy engine is a single-VM setup for the single or scale-out Prism Central.

About this task

Note:

If your Prism Central is on ESXi, add the VMware provider account for the vCenter that manages the host where the Prism Central VM resides to your Calm.
For quota consumption of running applications, you can either wait for the next platform sync to happen or run platform sync manually after the policy engine enablement. For more information on how to run platform sync, see Synchronizing Platform Configuration Changes.
When you upgrade Calm to the latest version as part of the Prism Central upgrade and if the policy engine is enabled, then ensure to upgrade your policy engine to the latest version using LCM.
If an HTTP proxy is configured, ensure that the IP address you provide for the policy engine VM is added to the HTTP-proxy whitelist.

Procedure

Click the Settings icon in the left pane.
The Settings page appears.
On the Policies tab, enter the IP address in the IP Address for Policy Engine field.
The IP address must be an available IP address and must belong to the same network as that of your Prism Central VM.

Figure. Enable Policy Engine Click to enlarge
Click the Enable button.
Click the Confirm button to enable the policy engine.

What to do next

To get quota consumption of running applications for the first time after enabling the policy engine, you can wait for the platform sync to happen or run the platform sync manually. After the first update, all future updates will happen instantly. For information on how to run platform sync, see Synchronizing Platform Configuration Changes.
Allocate resource quotas to provider accounts. See Allocating Resource Quota to an Account.
Allocate resource quotas to projects. See Managing Quota Limits for Projects .
Create VPC tunnels on Nutanix accounts. See Creating VPC Tunnels.
Create approval policies for runbook executions, application launch, or application day-2 operations. See Creating an Approval Policy.
Schedule application actions and runbook executions. See Creating a Scheduler Job.

Enabling Policy Engine at a Dark Site

You can enable the policy engine at a dark site.

Before you begin

If your Prism Central is on ESXi, add the VMware provider account for the vCenter that manages the host where the Prism Central VM resides to your Calm.

Procedure

Download the policy engine image of the version that is compatible with your Calm version from the Downloads page of the Support & Insights Portal:
https://portal.nutanix.com/page/downloads?product=calm
Do one of the following:
- If your Prismr Central is on AHV, upload the image on Prism Central with the following name:
  <Calm version number>-CalmPolicyVM.qcow2
- If your Prism Central is on ESXi, manually upload the image as template on the vCenter host where the Prism Central VM resides with the following name:
  <Calm version number>-CalmPolicyVM.ova
After uploading the image, enable the policy engine on the Settings page. For more information on enabling the policy engine, see Enabling policy Engine.

Setting up Quota defaults

After you enable the policy engine, you can set up the default quota values for vCPU, memory, and disk. This step is optional.

About this task

Before you begin

Ensure that you enabled the policy engine for your Calm instance. For information about enabling the policy engine, see Enabling policy Engine.

Procedure

Click the Settings iconic the left pane.
The Settings page appears.
On the Policies tab, click the Quotas tab in the left pane.
Select the Set Quota Defaults check box.
Specify the values for vCPU , Memory , and Disk .
Click the Save icon next to the fields.

Viewing Policy Engine VM Details

Before you begin

Ensure that you have enabled the policy engine for your Calm instance. For information about enabling the policy engine, see Enabling policy Engine.

Procedure

Click the Settings icon in the left pane.
The Settings page appears.
On the Policies tab, click the Policy Settings tab in the left pane.
Expand the Policy Engine VM Details section to view the policy engine VM details.

Disabling Policy Enforcement

Disable the policy enforcement for your Calm instance if the policy engine VM encounters any connectivity issues or the policy engine VM is not responding.

About this task

When you disable policy enforcement, policies are not enforced for quota checks and approval policies.

Procedure

Click the Settings icon in the left pane.
The Settings page appears.
On the Policies tab, click the Policy Settings tab in the left pane.
Select the Skip Policy Checks check box to disable the policy enforcement.
Click the Confirm button.

Enabling Approvals

You can enable approvals for your Calm instance from the settings page.

About this task

Caution: This feature is currently in technical preview and is disabled by default. Do not use any technical preview features in a production environment.

Procedure

Click the Settings icon in the left pane.
The Settings page appears.
On the Policies tab, click the Approvals tab in the left pane.
Use the Approvals toggle button to enable approvals.

Disabling Approvals

You can disable approvals for your Calm instance from the Settings page.

About this task

Procedure

Click the Settings icon in the left pane.
The Settings page appears.
On the Policies tab, click the Approvals tab in the left pane.
Use the Approvals toggle button to disable approvals.

Viewing Approval Email Templates

You can view the configuration details and email template on the Policies tab of the Settings page.

Procedure

Click the Settings icon in the left pane.
The Settings page appears.
On the Policies tab, click the Approvals tab in the left pane.
Under the General Configuration section, view details such as the number of days after which a request expires and the frequency of the email sent to the approver and requester.
Under the Email Content section, click the For Approver or For Requester tabs to view the template of the emails that are sent with each request.

Figure. Email Template Click to enlarge
The content of the email templates for approver or requester can be modified only using the APIs. You can use the following supported email template variables.
- Approver
- Requester
- ConditionDetails
- Event
- EntityType
- EntityName
- State
- PCIP
- CreationTime
- ExpirationTime
- NutanixLogo
You can use these variables with the {{}} syntax. For example, {{.PCIP}} .

Application Protection Status

You can view the protection and recovery status of a Calm application when:

The VMs of the application running on a Nutanix platform are protected by a protection policy in Prism Central.
You enabled the option to show application protection status in Calm.

You can view the protection and recovery status of the application on the Application Overview page. For more information, see Overview Tab.

Note:

The option to show application protection status is available only when at least one VM of the application is protected by a protection policy in Prism Central.
You can view the protection and recovery status of the Calm applications if the versions of Prism Central and Prism Element are 5.17 or later.
If the target recovery location is set to another Prism Central, Calm still displays the correct protection status. However, the recovery is not tracked, and there is no recovery status available for the application. Calm application still points to the old VMs.

To enable the option to show application protection status, see Enabling Application Protection Status View.

Enabling Application Protection Status View

Before you begin

Ensure that the versions of Prism Central and Prism Element are 5.17 or above.
Ensure that at least one VM of the application is protected by a protection policy in Prism Central.

Procedure

Log on to Prism Central as an administrator.
From the Prism Central UI, click Services > Calm .
Click the Settings icon in the left pane.
Under the General tab, click the Show App Protection Status toggle button.

What to do next

You can view the protection and recovery status of the application in the application Overview page. For more details, see Overview Tab.

Application Log Archive

Calm automatically archives run logs of the deleted applications and custom actions that are older than three months. You can download the archives within 7 days from the time of archive creation.

For a running application, data is not archived for the system-generated Create actions.

You can get the following information for Start, Restart, Stop, Delete, and Soft Delete system-generated actions and user-created actions.

Started by
Run by
Status

Calm archives all action details of a deleted application.

Only an administrator can view and download the application log archive. For more information, see Downloading Application Log Archive.

Downloading Application Log Archive

Calm periodically archives application logs to clear resources. You can download the archived application logs from the Settings tab.

Procedure

Log into Prism Central as an administrator.
From the Prism Central UI, click Services > Calm .
Click the Settings icon in the left pane.
Under Application log archive is ready to download , click Download .
The tar.gz file is downloaded.

Provider Account Settings in Calm

Provider accounts are cloud services, baremetals, or existing machines that you can use to deploy, monitor, and govern your applications. You can configure multiple accounts of the same provider.

Calm supports the following provider accounts:

Table 1. Provider Accounts
Provider Accounts	Description
Nutanix	All the AHV clusters that are registered to the Prism Central instance are automatically added as providers. Note: If you want to add a remote Prism Central (PC) instance as a provider in a multi-PC setup, you must add the remote PC instance as an account in Calm. For more information, see Configuring a Remote Prism Central Account.
VMware	To configure a VMware account, see Configuring a VMware Account.
AWS	To configure an AWS account, see Configuring an AWS Account.
Azure	To configure an Azure account, see Configuring an Azure Account.
GCP	To configure a GCP account, see Configuring a GCP Account.
Kubernetes	To configure a Kubernetes account, see Configuring a Kubernetes Account.
Xi Cloud	To configure Xi Cloud as a provider, see Configuring a Xi Cloud Account.

Nutanix Account Configuration

All AHV clusters that are registered to your Prism Central instance are automatically added as provider accounts to Calm.

You can also configure any remote Prism Central (PC) as an account in Calm to deploy applications on the remote PC. For more information, see Support for Multi-PC Setup.

Support for Multi-PC Setup

In a multi-PC environment, every remote PC is added as an account to the host PC and you can add the account to your project before creating and launching a blueprint.

For more information about adding a remote PC as an account, see Configuring a Remote Prism Central Account.

For more information about adding the account to a project, see Adding Accounts to a Project.

Configuring a Remote Prism Central Account

To deploy an application on a remote PC, you must configure the remote PC as an account in Calm.

About this task

You require the role of a Prism Admin to configure a remote PC account.

For more information about multiple Prism Central setup support, see Support for Multi-PC Setup.

Procedure

Click the Settings icon in the left pane.
Click the Account tab.
The account inspector panel appears.
Click +Add Account .
The Account settings page appears.
In the Name field, type a name for the PC account.
From the Provider list, select Nutanix .

Figure. Remote Prism Central Account Click to enlarge
In the PC IP field, type the IP address of the remote PC.
The application is provisioned in the remote PC IP address.
In the PC Port field, type the port number for the IP address.
In the User name field, type the administrator username of the remote PC.
In the Password field, type the administrator password of the remote PC.
In the Account Sync Interval field, specify the interval after which the platform sync must run for a cluster.
Calm uses platform sync to synchronize any configuration changes occur in Calm-managed resources, such as IP Address changes, disk resizing, and so on. Platform sync enables Calm to maintain accurate quota and Showback information.
Click Save .
The account list displays the account that you created.
To verify the credentials of the account, click Verify .
Calm adds the remote PC as a Nutanix account after credential authentication and account verification.

Tunnels for Orchestration within a VPC

To set up tunnels for your VPCs, you must:

Have Flow Virtual Networking enabled in the Prism Central that hosts the Calm instance (see Enabling Flow Networking). For more information on VPCs, see Virtual Private Cloud.
Enable the Advanced Network Controller.
Attach an external subnet (VLAN) to the VPC to enable the tunnel VM to reach the policy engine VM and establish a tunnel connection. An external subnet allows VMs inside the VPC to reach the VMs that are outside the VPC network.
Ensure that the VMs inside the VPC is able to ping the policy engine VM and Prism Central.
Permit traffic from the tunnel VM to the Policy Engine VM on port 2222 using TCP connections.
Allow connections on default 22 port for SSH script execution or default 5985 for Powershell script execution on the target VM.
Enable the policy engine in Calm to allow the tunnel VM to communicate with Calm.
Have 2 vCPUs, 2 GiB memory and 10 GiB disk space for the tunnel VM.

For more information on creating VPC tunnels, see Creating VPC Tunnels.

Creating VPC Tunnels

In your Nutanix account, you set up tunnels to get access to the VMs that are created within the VPCs.

About this task

The tunnels that you create enables you to perform check log-in and run script-based execution tasks on the VMs that use the overlay subnets of the VPC.

If tunnel is not configured for the selected VPC, you can only perform basic operations (such as VM provisioning) on the VPC.

Before you begin

Procedure

Click the Settings icon in the left pane.
Click the Accounts tab.
Select the Nutanix account in the left pane.
The Account Settings page appears.
In the VPC Tunnels section, do the following to set up the tunnel.
1. Click Create Tunnel .
  The Create Tunnel for VPCs window appears.
  Figure. Create Tunnel Click to enlarge
2. From the Select VPC list, select the VPC on which you want to set up the tunnel.
3. From the Select VPC Subnet , select the subnet that must be used for the NIC of the tunnel VM.
4. Under Tunnel Configuration section, select the cluster on which you want to place the VM from the Select Cluster list.
5. In the Tunnel Name field, edit the name of the tunnel. This step is optional.
  The tunnel name is auto-generated to ensure uniqueness. You can only edit or append based on your requirement.
6. In the Tunnel VM Name field, edit the tunnel VM name. This step is optional.
  The tunnel VM name is auto-generated to ensure uniqueness. You can only edit or append based on your requirement.
7. Click Create .

Configuring a VMware Account

Configure your VMware account in Calm to manage applications on the VMware platform.

About this task

Note:

If you do not have an administrator user account in vCenter while configuring the account, then you can also use a user account with required permissions. See Permission Required in vCenter.
You cannot enable Calm with vSphere Essentials edition license because vSphere Essentials edition does not support hot-pluggable virtual hardware.
With VMware accounts, Calm also supports virtual switch (vSwitch) networks and VMware NSX-based networks.

To refer to the video about setting up VMware as provider, click here.

Procedure

Click the Settings icon in the left pane.
Click the Accounts tab.
The account inspector panel is displayed.
Click +Add Account .
The Account Settings page appears.
Figure. Account- VMware Click to enlarge
In the Name field, type a name for the account.

Note: The name you specify appears as the account name when you add the account to a project.
From the Provider list, select VMware .
In the Server field, type the server IP address of the vCenter server.
In the Username field, type the user name of the vCenter account.
If a domain is part of the username, then the username syntax must be <username>@<domain> .
In the Password field, type the password of the account.
In the Port field, type the port number as 443 .
Click Save .
From the Datacenter list, select the datacenter.
A VMware datacenter is the grouping of servers, storage networks, IP networks, and arrays. All the datacenters that are assigned to your vCenter account are available for your selection.
In the Account Sync Interval field, specify the interval after which the platform sync must run for a cluster.
Calm uses platform sync to synchronize any configuration changes occur in Calm-managed VMware resources, such as IP Address changes, disk resizing, and so on. Platform sync enables Calm to maintain accurate quota and Showback information.
To monitor the operating cost of your applications, configure the cost of the following resources. This step is optional.

Note: Ensure that you have enabled showback. For more information about enabling showback, see Enabling Showback.
- In the vCPU field, type the cost of vCPU consumption for each hour in dollars. The default value is $0.01 for each vCPU for each hour.
- In the Memory field, type the cost of memory consumption for each hour in dollars. The default value is $0.01 for each GB of usage for each hour.
- In the Storage field, type the cost of storage consumption for each hour in dollars. The default value is $0.0003 for each GB of usage for each hour.
Click Save .
To verify the credentials of the account, click Verify .
Calm lists the account as an active account after successful credential authentication and account verification.

What to do next

Create a project and configure a VMware environment, see Creating a Project and Configuring VMware Environment.

Permission Required in vCenter

The following table provides the complete list of permissions that you need to enable in vCenter before you configure your VMware account in Calm.

Table 1. Permissions required in vCenter
Entity	Permission
Datastore	Allocate space Browse datastore Low level file operation Update virtual machine files
Network	Assign Network Configure Move Network
Resource	Assign virtual machine to resource pool
vSphere Tagging	All
Virtual Machine > Change Configuration	Add existing disk Add new disk Add or remove device Change CPU count Change memory Modify device settings Configure raw device Rename Set annotation Change settings Upgrade virtual machine compatibility
Virtual Machine > Interaction	Configure CD media Connect devices Power On Power off Reset Install VMware tools
Virtual Machine > Edit Inventory	Create from existing Remove
Virtual Machine > Provisioning	Clone template Customize guest Deploy template Read customization specifications

Supported vSphere Versions

Calm supports the following versions of vSphere.

Configuring an AWS Account

Configure your AWS account in Calm to manage applications on the AWS platform.

Before you begin

Ensure that you have the following accounts and details.

An AWS account with valid credentials.
An IAM user account. For information on how to create an IAM user account, refer to AWS Documentation .
A user account with full EC2 access and IAM read-only access.
The access key ID and the secret access key for the IAM user account.

Note:

Ensure that you have configured the domain name server (DNS). To verify the DNS configuration, from the Prism Central UI, click Prism Central > Gear icon > Name Servers and run the following command.
```
nutanix@cvm$ ncli cluster get-name-servers
```
If you are configuring DNS now, then you must restart the Prism Central VM.

Procedure

Click the Settings icon in the left pane.
Click the Accounts tab.
The account inspector panel appears.
Click +Add Account .
The Account Settings page appears.
Figure. Account- AWS Click to enlarge
In the Name field, type a name for the account.
From the Provider list, select AWS .
In the Access Key ID field, type the access key ID of your AWS account.
In the Secret Access Key field, type the secret access key of your AWS account.
From the Regions list, select the geographical regions.
By default, Calm includes all regions except China and GovCloud in the account. You can remove a region from the account. You can also clear the All Regions check box and select regions from the Regions list.

Warning: Removing a region from an existing AWS account impacts the deployed VMs in that region.
In the Search Public Image field, search the public image applicable to your region, and select the public image. This step is optional.
You must authenticate the credentials before searching. You can select multiple public images and use any of the selected public images when you create a blueprint for AWS.
Click Save .
To verify the credentials of the account, click Verify .
Calm lists the account as an active account after successful credential authentication and account verification.

What to do next

Create a project and configure an AWS environment, see Creating a Project and Configuring AWS Environment.

Configuring AWS C2S Provider on Calm

About this task

Note:

The AWS GovCloud (US) region supports the management of regulated data by restricting physical and logical administrative access to U.S. citizens only.

Before you begin

Ensure that you have the following accounts.

An AWS GovCloud (US) account with valid credentials.
A C2S account configured in AWS.

Procedure

Click the Settings icon in the left pane.
Click the Accounts tab.
The inspector panel appears.
Figure. Provider- AWS Click to enlarge
In the Name field, type the name of the account.
From the Type list, select AWS C2S .
In the C2S account address field, type the C2S account IP address.
In the Client Certificate field, type or upload the client certificate.
In the Client Key field, type or upload the client key.
In the Role field, type the required IAM role.
In the Mission field, type the mission.
In the Agency field, type the agency.
Select All GovCloud Regions check box to select all the GovCloud regions.
Click Save .
To verify the credentials of the account, click Verify .
Calm lists the account as an active account after successful credential authentication and account verification.

What to do next

You can use the configured AWS C2S provider while you create a blueprint.

Configuring AWS User Account with Minimum Privilege

To manage applications on the AWS platform using Calm, you must have a privileged AWS user account with an appropriate policy.

Before you begin

Ensure that you have an AWS administrator user account.

Procedure

Log on to the AWS console with your AWS administrator account.
Click Services > IAM .
To add a user, click Users > Add User .
On the Add User page, do the following.
1. In the User name field, type a user name.
2. In the Access Type area, select the check boxes next to the Programmatic access and AWS Management Console access fields, and then click Next: Permission .
  
  Note: Do not configure any fields on the Set Permission page.
3. Click Next: Tags .
4. To add a tag to a user, type the key and value pair in the Key and Value fields.
  For more information about IAM tags, see AWS Documents .
5. Click Next: Review .
6. Click Create User .
  An IAM user is created.
7. To display the credential of the user, click Show in the Access key ID , Secret access Key , and Password fields.
  
  Note: Copy the credentials in a file and save the file on to your local machine. You need the credentials when you configure AWS as an account in Calm to manage applications.
To assign permission to the user, click the user you created on the Users page.
The Summary page appears.
On the Permissions tab, click + Add inline policy .

On the Create Policy page, click the JSON tab and use the following JSON code in the code editor area.


{
	"Version": "2012-10-17",
	"Statement": [
    	{
        	"Effect": "Allow",
        	"Action": [
            	"iam:ListRoles",
            	"iam:ListSSHPublicKeys",
            	"iam:GetSSHPublicKey",
            	"iam:GetAccountPasswordPolicy",
            	"ec2:RunInstances",
            	"ec2:StartInstances",
            	"ec2:StopInstances",
            	"ec2:RebootInstances",
            	"ec2:CreateTags",
            	"ec2:CreateVolume",
            	"ec2:CreateSnapshot",
            	"ec2:CreateImage",
            	"ec2:ModifyImageAttribute",
            	"ec2:ModifyInstanceAttribute",
            	"ec2:AttachVolume",
            	"ec2:DetachVolume",
            	"ec2:ModifyVolume",
            	"ec2:AssociateIamInstanceProfile",
            	"ec2:ReplaceIamInstanceProfileAssociation",
            	"ec2:DisassociateIamInstanceProfile",
            	"ec2:RegisterImage",
            	"ec2:DeregisterImage",
            	"ec2:DeleteSnapshot",
            	"ec2:GetConsoleOutput",
            	"ec2:Describe*",
            	"ec2:DeleteTags",
            	"ec2:TerminateInstances"
        	],
        	"Resource": "*"
    	},
    	{
        	"Effect": "Allow",
        	"Action": ["iam:ListUserPolicies"],
        	"Resource": ["arn:aws:iam::*:user/${aws:username}"]
    	},
    	{
        	"Effect": "Allow",
        	"Action": ["iam:PassRole"],
        	"Resource": ["arn:aws:iam::*:role/*"]
    	}
	]
}

Click Review Policy .
On the Review Policy page, in the Name field, type a name for the policy and click Create policy .

What to do next

AWS Policy Privileges

The following table displays the list of user policy privileges and the corresponding JSON attributes that you can add in the JSON syntax to assign different privileges to a user.

Table 1. User Privileges and the JSON attributes
To create	JSON attributes
EC2 Instances	`ec2:RunInstances`
Volumes	`ec2:CreateVolume`
Snapshot	`ec2:CreateSnapshot`
Image(AMI)	`ec2:CreateImage`
To list or get	JSON attributes
SSH Public Keys for all users	`iam:ListSSHPublicKeys`
List IAM Roles	`iam:ListRoles`
EC2 attributes	`ec2:Describe*`
EC2 instance console output	`ec2:GetConsoleOutput`
IAM user policies for the user	`iam:ListUserPolicies`
To update	JSON attributes
Image(AMI) attributes	`ec2:ModifyImageAttribute`
To delete	JSON attributes
EC2 Instances	`ec2:TerminateInstances`
Instance Tags	`ec2:DeleteTags`
Snapshot	`ec2:DeleteSnapshot`
Images(deregister images)	`ec2:DeregisterImage`
Others	JSON attributes
Start/Stop/Restart Instances	`ec2:RunInstances, ec2:StartInstances, ec2:StopInstances, ec2:RebootInstances`
Pass and IAM role to service	`iam:PassRole`

Configuring a GCP Account

Configure your GCP account in Calm to manage applications on the GCP platform.

Before you begin

Ensure that you have the service account file of your GCP account in a JSON format saved on your local machine. To create a GCP service account file, see the GCP documentation .

Procedure

Click the Settings icon in the left pane.
Click the Accounts tab.
The account inspector panel is displayed.
Click +Add Account .
The Account Settings page appears.
Figure. Account- GCP Click to enlarge
In the Name field, type a name for the account.
From the Provider list, select GCP .
To import the service account file from your local machine, click Service Account File .
A service account file is a special Google account file that you can use to upload the details of your GCP account.

The values in the Project ID , Private Key , Client Email , and Token URI fields are auto-filled after you upload the file.
From the Regions list, select the geographical regions.
By default, Calm includes all regions in the account. You can remove a region from the account. You can also clear the All Regions check box and select regions from the Regions list.

Warning: Removing a region from an existing GCP account impacts the deployed VMs in that region.
Select the Enable GKE check box to enable Google Kubernetes Engine (GKE). This step is optional.
In the Server IP field, type the GKE leader IP address.
In the Port field, type the port number.
Click Save .
To verify the credentials of the account, click Verify .
Calm lists the account as an active account after successful credential authentication and account verification.

What to do next

To troubleshoot some common issues, see KB-5616. You can create a project and configure a GCP environment, see Creating a Project and Configuring GCP Environment.

Configuring an Azure Account

Configure your Azure account in Calm to manage applications on the Azure platform.

About this task

Note:

For detailed description of the required fields, refer to the Azure documentation .
Only authorized organizations can use restricted regions like Australia Central through Calm. For more information, refer to the Microsoft documentation .

Before you begin

Assign appropriate role to your application. For detailed information, refer to the Microsoft documentation .

Procedure

Click the Settings icon in the left pane.
Click the Accounts tab.
The account inspector panel appears.
Figure. Account- Azure Click to enlarge
In the Name field, type a name for the account.
From the Provider list, select Azure .
Do the following under the Service Principal Credentials section.
1. In the Directory/Tenant ID field, type the directory/tenant ID of your Azure application.
2. In the Application/Client ID field, type the application/client ID.
3. In the Client Key/Secret field, type the client key or secret.
From the Subscriptions list, select your Azure subscriptions.
The subscriptions you select provide access to the associated resource groups during blueprint configuration. The subscriptions allow you to launch VMs in the associated resource groups with a single account. When you do not select any subscriptions, Calm provides access to all the subscriptions available in the Azure service principal.
From the Default Subscription list, select a default subscription. This step is optional.
Specify the default subscription if the Azure VM configurations such as blueprints and marketplace items created in any earlier versions of Calm require any backward compatibility.
From the Cloud Environment list, select a cloud environment.
You can select Public Cloud , US Government Cloud , China Cloud , or German Cloud .
Click Save .
To verify the credentials of the account, click Verify .
Calm lists the account as an active account after successful credential authentication and account verification.

What to do next

Create a project and configure an Azure environment, see Creating a Project and Configuring Azure Environment.

Configuring Azure User Account with Minimum Privilege

You must have a privileged Azure user account to manage applications on an Azure platform using Calm.

About this task

To refer to a video about assigning minimum privilege to configure Azure account to work with Calm, click here.

Procedure

Log on to Azure portal with your administrator account.
Open https://shell.azure.com and select bash.

Create a .json file with the following content.

{
  "Name": "Calm Admin",
  "IsCustom": true,
  "Description": "For calm to manage VMs on azure provisioned from calm applications",
  "Actions": [
    "Microsoft.Storage/storageAccounts/read",
    "Microsoft.Storage/storageAccounts/write",
    "Microsoft.Storage/checknameavailability/read",
    "Microsoft.Storage/skus/read",
    "Microsoft.Network/virtualNetworks/subnets/*",
    "Microsoft.Network/virtualNetworks/read",
    "Microsoft.Network/networkSecurityGroups/*",
    "Microsoft.Network/networkInterfaces/*",
    "Microsoft.Network/publicIPAddresses/*",
    "Microsoft.Network/publicIPPrefixes/*",
    "Microsoft.Compute/availabilitySets/vmSizes/read",
    "Microsoft.Compute/availabilitySets/read",
    "Microsoft.Compute/availabilitySets/write",
    "Microsoft.Compute/disks/*",
    "Microsoft.Compute/images/read",
    "Microsoft.Compute/images/write",
    "Microsoft.Compute/locations/publishers/read",
    "Microsoft.Compute/locations/publishers/artifacttypes/offers/read",
    "Microsoft.Compute/locations/publishers/artifacttypes/offers/skus/read",
    "Microsoft.Compute/locations/publishers/artifacttypes/offers/skus/versions/read",
    "Microsoft.Compute/skus/read",
    "Microsoft.Compute/snapshots/*",
    "Microsoft.Compute/locations/vmSizes/read",
    "Microsoft.Compute/virtualMachines/*",
    "Microsoft.Resources/subscriptions/resourceGroups/read",
    "Microsoft.Resources/subscriptions/resourceGroups/write",
    "Microsoft.Resources/subscriptions/resourceGroups/delete",
    "Microsoft.GuestConfiguration/*/read",
    "Microsoft.GuestConfiguration/*/write",
    "Microsoft.GuestConfiguration/*/action",
    "Microsoft.Compute/galleries/read",
    "Microsoft.Compute/galleries/images/read",
    "Microsoft.Compute/galleries/images/versions/read",
    "Microsoft.KeyVault/vaults/read",
    "Microsoft.KeyVault/vaults/deploy/action"
  ],
  "NotActions": [],
  "AssignableScopes": [
    "/subscriptions/<subscription id>"
  ]
}

In the Azure cloud shell, run the following command.
```
az role definition create --role-definition <file>.json
```
Use the file you created in step 4 in place of <file>.json .

Calm Admin user role is created.
In the Azure cloud shell, run the following command to create an Azure Service Principal. The command returns all the information required to add the Azure account in Calm.
```
az ad sp create-for-rbac -n "CalmAccount" --role "Calm Admin"
```
Copy the values for appId , password , and tenant . You need these values to add the Azure account in Calm.

Configuring a Kubernetes Account

Configure your Kubernetes account in Calm to manage applications on the Kubernetes platform.

Before you begin

Ensure that you meet the following requirements.

You have a compatible version of Kubernetes. Calm is compatible with Kubernetes 1.16 and 1.17.
You have necessary RBAC permissions on the Kubernetes server.
You have the authentication mechanism enabled on the Kubernetes cluster.

Procedure

Click the Settings icon in the left pane.
Click the Accounts tab.
The account inspector panel is displayed.
Click +Add Account .
The Account Settings page appears.
Figure. Provider- Kubernetes Click to enlarge
In the Name field, type a name for the account.
From the Provider list, select Kubernetes .
From the Type list, select one of the following.
- Select Vanilla to self deploy the kubernetes clusters.
- Select Karbon to add Karbon as the provider type. Nutanix Karbon is a curated turnkey offering that provides simplified provisioning and operations of Kubernetes clusters.
If you have selected the kubernetes type as Vanilla , then do the following.
1. In the Server IP field, type the Kubernetes leader IP address.
2. In the Port field, type the port number of the Kubernetes server.
3. From the Auth Type list, select the authentication type.
  You can select one of the following authentication types.
  - Basic Auth : Basic authentication is a method for an HTTP user agent, for example, a web browser, to provide a user name and password when making a request.
  - Client Certificate : A client certificate is a digital certificate protected with a key for authentication.
  - CA Certificate : A client authentication certificate is a certificate that is used to authenticate clients during an SSL handshake. The certificate authenticates users who access a server by exchanging the client authentication certificate.
  - Service Account : A service account is an automatically enabled authenticator that uses signed bearer tokens to verify requests.
4. If you have selected Basic Auth , then do one of the following.
  - In the Username field, type the username. If the domain is a part of the username, then the username syntax should be <username>@<domain> .
  - In the Password field, type the password.
5. If you have selected Client Certificate , then do one of the following.
  - Under Client Certificate , upload the client certificate.
  - Under Client Key , upload the private key.
6. If you have selected CA Certificate , then do one of the following.
  - Under CA Certificate , upload the CA certificate.
  - Under Client Certificate , upload the client certificate.
  - Under Client Key , upload the private key.
7. If you selected Service Account , then do one of the following.
  - Under Token , upload the service account authentication token.
  - Under CA Certificate , upload the CA certificate.
If you have selected the kubernetes type as Karbon , then do the following.
1. In the Cluster list, select the respective kubernetes cluster that you want to add.
Click Save .
To verify the credentials of the account, click Verify .
Calm lists the account as an active account after successful credential authentication and account verification.

Configuring Amazon EKS, Azure Kubernetes Service, Anthos, or Red Hat OpenShift

For Calm to manage workloads on Amazon EKS, Azure Kubernetes Service (AKS), Anthos or Red Hat OpenShift, enable the generic authentication mechanism and create a service account on the Kubernetes cluster. You can then use the service account to communicate with the cluster.

Procedure

Create a service account by running the following Kubernetes command:
kubectl create serviceaccount ntnx-calm

A service account is a user that the Kubernetes API manages. A service account is used to provide an identity for the processes that run in a pod.
Bind the cluster admin role to the Calm service account using the following command:
kubectl create clusterrolebinding ntnx-calm-admin --clusterrole cluster-admin --serviceaccount default:ntnx-calm
Get the service account secret name using the following command:
SECRET_NAME=$(kubectl get serviceaccount ntnx-calm -o jsonpath='{$.secrets[0].name}')

Secrets are objects that contain sensitive data such as a key, token, or password. Placing such information in a Secret allows better control and reduces the risk of exposure.
Get the service account token using the following command:
kubectl get secret ${SECRET_NAME} -o jsonpath='{$.data.token}' | base64 –decode
Get the CA certificate using the following command:
kubectl config view --minify --raw -o jsonpath='{.clusters[*].cluster.certificate-authority-data}' | base64 –decode

What to do next

After receiving the service token, you can add the account in Calm and use the token to communicate with the cluster. For more information on adding the account, see Configuring a Kubernetes Account.

Configuring a Xi Cloud Account

Before you begin

Ensure that you meet the following conditions.

You enabled Xi leap in Prism Central.
Your Prism Central is paired with Xi Cloud.
Your Prism Central and Xi Cloud are connected to a VPN.
You added the routes to Xi gateway in Prism Central.

Procedure

Click the Settings icon in the left pane.
Click the Accounts tab.
The account inspector panel appears.
Click +Add Account .
The Account Settings page appears.
In the Name field, type a name for the Xi cloud.
From the Provider list, select Xi .
Calm automatically add the paired availability zones in the Availability Zones field.
Click Save .
To verify the credentials of the account, click Verify .
Calm lists the account as an active account after successful credential authentication and account verification.

What to do next

You can use the configured Xi cloud to host blueprints and application by using Calm. For more information, see Calm Blueprints Overview.

Platform Sync for Provider Accounts

You can specify an interval after which the platform sync must run for a cluster. For more information, see Configuring a Remote Prism Central Account and Configuring a VMware Account.

Synchronizing Platform Configuration Changes

About this task

Procedure

Click the Settings icon in the left pane.
The Settings page appears.
Click the Accounts tab.
Select the Nutanix or VMware account for which you want to sync up configuration changes in the left pane.
On the Account Settings page, click the Sync Now button.

Figure. Sync Now Click to enlarge

Allocating Resource Quota to an Account

About this task

Note: You can allocate resource quotas to Nutanix and VMware accounts only.

Before you begin

Ensure that you configured your Nutanix or VMware account. For more details about configuring an account, see Provider Account Settings in Calm.
Ensure that you enabled the policy engine on the Settings page. For more details about enabling the policy engine, see Enabling policy Engine.

Procedure

Click the Settings icon in the left pane.
The Settings page appears.
Click the Accounts tab.
Select the Nutanix or VMware account in the left pane.
On the Account Settings page, select the Quotas check box.
If you have set up the quota defaults on the General tab of the Settings page, the default values populate automatically in the vCPU , Memory , and Disk fields of the discovered clusters.
Figure. Quota Definition Click to enlarge
Allocate required quota values to the discovered clusters.
The Physical Resources row below the quota fields shows the physical resource already used and the total physical resource of the cluster. You can use this information when you allocate resource quotas to the account.
Click Save .

Viewing Quota Utilization Report

Before you begin

Ensure that you have enabled the policy engine on the Settings tab. For more details about enabling the policy engine, see Enabling policy Engine.
Ensure that you have allocated resource quotas to the provider. For more details, see Allocating Resource Quota to an Account.
Ensure that you have allocated resource quotas to projects. For more details, see Adding Accounts to a Project.

Procedure

Click the Settings icon in the left pane.
Click the Accounts tab.
Select the Nutanix or VMware account in the left pane.
The Account Settings page appears.
In the Quotas section, do the following to view the resources consumed for each cluster:
1. In the Quota Utilization | View Report row, hover your mouse over the status bar of a resource.
  The ToolTip displays the resources consumed and the resources allocated to the cluster.
  Figure. Quota Utilization Status Bar Click to enlarge
  
  Note: You can also use the status bar to view the overall status and percentage of resources consumed.
2. Click View Report .
  The Utilization Report window appears.
  Figure. Utilization Report Click to enlarge
3. View project-wise consumption of resources along with the amount of compute, memory, and storage that the projects used.

Credentials in Calm

Credentials Overview

Credentials are used in multiple Calm entities and workflows.

Environment
Environment allows a Project Admin to add multiple credentials and configure VM default specifications for each of the selected providers as a part of project and environment configurations.

Project admins must configure an environment before launching an application from the marketplace. The recommendation is to have at least one credential of each secret type (SSH or password) to be defined under each environment in the project. These values get patched wherever the credential values are empty when you launch your marketplace items.
Blueprints and runbooks
Developers can add credentials to a blueprint. These credentials are referenced after the VM is provisioned. Credentials defined within an environment of a project have no significance or impact on the credentials you define within the blueprint.

Calm supports export and import of blueprints across different Prism Central or Calm instances along with the secrets. The developer uses a passphrase to encrypt credentials and then decrypts credentials in a different instance using the same passphrase to create a blueprint copy.
Marketplace
All global marketplace items have empty credentials values. However, locally published blueprints can have the credential values if the developer published the blueprint with the Publish with Secret s option enabled.

When you launch a marketplace item, credentials are patched wherever the value is empty. In case there are multiple credentials of a particular type configured within the environment of a project, you get the option to select a credential for the launch.
Applications
Owners can change the credential value of an application multiple times until the application is deleted. The latest value of a credential that is available at that point in the application instance is used when an action is triggered.

Any change in the credential value at the application level does not impact the credential value at the corresponding blueprint level.

Calm allows managing the following types of credentials:

Static Credentials
Static credentials in Calm are modelled to store secrets (password or SSH private key) in the credential objects that are contained in the blueprints that the applications copy.
Dynamic Credentials
Calm supports external credential store integration for dynamic credentials. A credential store holds username and password or key certificate combinations and enables applications to retrieve and use credentials for authentication to external services whenever required. As a developer, you can:
- Define credential attributes that you want to pass on to the credential provider from the blueprint during execution.
- Define variables that the credential provider must use. By default, Calm defines the secret variable when you configure your credential provider.
  Note: To use the credential in the blueprint, the variables in the credential and the blueprint must match.
- Define a runbook with eScript tasks in the dynamic credential provider definition. The tasks you define in the runbook can set the username, password, private key, or passphrase values for the credential.
For more information about configuring a credential provider, see Configuring a Credential Provider.

When a blueprint uses a dynamic credential, the secret (password or SSH private key) is not stored in the credential objects within the blueprint. The secret values are fetched on demand by executing the runbook within the credential provider that you configure in Calm and associate with the blueprint.
Note:
- You cannot add a dynamic credential when you configure an environment in our project. You can, however, allow the credential provider in the environment.
- You cannot use dynamic credentials for HTTP variables, such as profile variables, service variables, runbooks, and so on.
- You cannot use dynamic credentials for HTTP endpoints and Open Terminal in applications.
- For ready-to-use blueprints or blueprints that are published without secrets, the empty credential values are patched with the credential along with its associated runbook and variable values.

Configuring a Credential Provider

Calm supports external credential store integration for dynamic credentials.

About this task

As a developer, you can define variable, runbook, and attributes in a dynamic credential provider definition.

Procedure

Click the Settings icon in the left pane.
On the Credential Providers tab, click Add Credential Provider .

Figure. Add Credential Provider Click to enlarge
On the Credentials Provider Account Settings page, enter a name for the credential provider in the Name field.

Figure. Credential Provider Click to enlarge
Enter the server address of the credential provider in the Provider Server Address field.
Enter the secret for the account in the Provider Secret field. The secret for the provider can be a key, token, or password.
To add the credential attributes, click the + icon next to Credential Attributes and do the following:
1. Enter a name for the credential attribute in the Name field.
2. Select a data type for the credential attribute in the Data Type field.
3. Provide a value for the data type you selected in the Value field. You can select the Secret check box to hide the value of the credential attribute.
  Credential attributes are the variables that you pass on to the credential provider from the blueprint during execution. Developers require these attributes in blueprints and runbooks to use the credential provider.
To add variables, click the + icon in the Variables section and do the following:
1. Enter a name for the variable in the Name field.
2. Select a data type for the variable in the Data Type field.
3. Provide a value for the data type you selected in the Value field. You can select the Secret check box to hide the value of the variable.
  The variables that you add during the credential provider configuration are only used in the runbooks that you define for the credential provider.
  
  To use the credential in the blueprint, the variables in the credential and the blueprint must match.
Configure a runbook for the credential provider. For information on runbook configuration, see Runbooks Overview.
You can define a runbook with an eScript task. The tasks are used to set the username, password, private key, or passphrase values for the credential.
Note: When the runbook uses the eScript task, then do the following in the Set Variable eScript task to fetch SSH keys or multi-line secrets from the credential provider.
- Encode the secrets.
- Set the is_secret_encoded variable to True.
The runbook uses the variables you defined during the credential provider configuration. You can click Variable/Attributes button within the runbook to view, edit, or add variables. After your runbook is defined, you can click Test to test the runbook.
Click Save .

What to do next

You can add the credential provider to a project. For more information, see Adding Accounts to a Project.

Projects Overview

For more information on the Project Summary view and Project Details view, see Project Summary View and Project Details View.

For more information on how to create a project, add users, add infrastructure, configure environments, and managing quota and snapshot policies, see Projects Overview in the Prism Central Guide.

Calm Blueprints Overview

You create a blueprint to represent the architecture of your application and then run the blueprint repeatedly to create an instance, provision, and launch applications.

You can use blueprints to model the applications of various complexities; from simply provisioning a single virtual machine to provisioning and managing a multi-node, multi-tier application.

Building Blocks of a Blueprint

Calm uses services, application profiles, packages, substrates, and actions as building blocks for a blueprint to define applications.

Services
An application is made up of multiple components (or services) working together. The architecture of an application is composed of compute, storage, network, and their connections and dependencies. Services are logical entities that are exposed by an IP address. End users and services communicate with each other over a network through their exposed IP addresses and ports. For more information, see Services Overview.
Application Profiles
Any useful blueprint requires infrastructure for instantiation. A blueprint can specify the exact infrastructure or can be completely left to the blueprint user to specify at the time of instantiation.

An application profile provides different combinations of the service, package, and VM (infrastructure choices) while configuring a blueprint. The application profile allows you to use the same set of services and packages on the different platforms. You select an application profile while launching your blueprint.

Application profiles determine where an application should run, for example, on a Nutanix provider account or on an Azure account. Application profiles also control the T-shirt sizing of an application. T-shirt sizing means that the value of a variable might change based on the selection of a small or a large instance of an application.

If Showback feature is enabled, the application profile also displays service cost of the resources used for an application.

Figure. Application Profile Click to enlarge
Package (Install and Uninstall)
Package Install and Uninstall are operations that are run when you first launch a blueprint or when you finally delete the entire application. In other words, these operations are run during the Create or Delete profile actions. Package Install and Uninstall are unique to each application profile, which means that the tasks or the task contents can vary depending upon the underlying cloud or the size.

Package install is commonly used for installing software packages. For example, installing PostgreSQL with sudo yum -y install postgresql-server postgresql-contrib .
Substrates
Substrates are a combination of the underlying cloud and the virtual machine instance. When you select the desired cloud, Calm displays all of the fields required for creating a virtual machine instance on that particular cloud. The combination of all these fields constitutes a substrate. Substrates are the infrastructure abstraction layer for Calm. Calm can quickly change where or how applications are deployed by simply changing the substrate.
Actions
Actions are runbooks to accomplish a particular task on your application. You can use actions to automate any process such as backup, upgrade, new user creation, or clean-up, and enforce an order of operations across services. For more information, see Actions Overview.

Other Configurational Components

Calm also has a few other components that you can use while configuring your blueprints.

Macros
Calm macros are part of a templating language for Calm scripts. These are evaluated by Calm's execution engine before the script is run. Macros help in making scripts generic and creating reusable workflows. For more information, see Macros Overview.
Variables
Variables are either user defined or added to the entities by Calm. Variables are always present within the context of a Calm entity and are accessible directly in scripts running on that entity or any of its child entities. For more information, see Variables Overview.
Categories
Categories (or tags) are metadata labels that you assign to your cloud resources to categorize them for cost allocation, reporting, compliance, security, and so on. Each category is a combination of key and values. For more information, see Categories Overview.
Dependencies
Dependencies are used to define the dependence of one service in your application on another service or multiple other services for properties such as IP addresses and DNS names. For example, if service 2 is dependent on service 1, then service 1 starts first and stops after service 2.

For information about how to define dependencies between services, see Setting up the Service Dependencies.

Figure. Dependencies Click to enlarge

Note: If there are no dependencies between tasks in a service, Calm runs the tasks in any order or even in parallel.

Blueprint Types

You can configure the following blueprint types in Calm.

Single-VM Blueprint
A single-VM blueprint is a framework that you can use to create and provision an instance and launch applications that require only one virtual machine. Single-VM blueprints enable you to quickly provide Infrastructure-as-a-Service (IaaS) to your end users. For more information, see Creating a Single-VM Blueprint.
Multi-VM Blueprint
A multi-VM blueprint is a framework that you can use to create an instance, provision, and launch applications requiring multiple VMs. You can define the underlying infrastructure of the VMs, application details, and actions that are carried out on a blueprint until the termination of the application. For more information, see Creating a Multi-VM Blueprint.

Blueprint Editor

The blueprint editor provides a graphical representation of various components that allow you to visualize and configure the components and their dependencies in your environment.

Use the Blueprints tab to perform actions, such as:

Create application blueprints for single-VM or multiple-VM architectures. For more information, see Creating a Single-VM Blueprint and Creating a Multi-VM Blueprint.
Add update configuration. For more information, see Update Configuration for VM.
Add configuration for snapshots and restore. For more information, see Blueprint Configuration for Snapshots and Restore.
Publish blueprints. For more information, see Submitting a Blueprint for Approval.
Launch blueprints. For more information, see Launching a Blueprint.
Upload existing blueprints from your local machine. For more information, see Uploading a Blueprint.
View details of your blueprints. For more information, see Viewing a Blueprint.
Edit details of an existing blueprint. For more information, see Editing a Blueprint.

Services Overview

A service includes the following entities:

VM

Package

Service

For information about how to configure a service, see Configuring Nutanix and Existing Machine VM, Package, and Service.

Macros Overview

Calm macros are part of a templating language for Calm scripts. These are evaluated by Calm's execution engine before the script is run.

Macros enable you to access the value of variables and properties that are set on entities. The variables can be user defined or system generated. For more information, see Variables Overview.

Macro Usage

Macros help in making scripts generic and creating reusable workflows. You can use macros in tasks within the blueprints or in the configuration of Calm entities, such as the VM name.

Macro Syntax

Macros require a set of delimiters for evaluation. These are @@{ and }@@ . Everything within these delimiters is parsed and evaluated. For example,

To concatenate the value of a path and a string variable, you can use cd "@@{path + '/data'}@@" in your script.
To access credentials, you can use the @@{cred_name.username}@@ and @@{cred_name.secret}@@ formats, where cred_name is the name of the credential with which the credential is created.

Supported Entities

Macros support the following entities.

Application
Deployment
Service
Package
Virtual machine
Runbooks

Supported Data Types

Macros support the following data types.

Table 1. Supported Data Types
Data Type	Usage
String	@@{"some string"}@@ or @@{'some string'}@@ Note: Newline or other such special characters are not supported. You can use \ to escape quotes.
Numbers	Supports integer and float. For example, @@{ 10 + 20.63 }@@ Note: All variables are treated as strings.

Supported Operations

Macros support the following operations.

Supports basic binary operations or numbers. For example, @@{(2 * calm_int(variable1) + 10 ) / 32 }@@.
Supports string concatenation. For example, @@{ foo + bar }@@.
Supports slicing for strings. For example, @@{foo[3:6]}@@.
Note: For a comma separated value, slicing splits the string on comma (,). For example, @@{"x,y,z"[1]}@@ results in y.

Macros of an Array Service

Use the following syntax to retrieve the name of all the instances of VM separated by commas.
@@{calm_array_name}@@
Use the following syntax to retrieve the IP address of all the instances of VM separated by commas.
@@{calm_array_address}@@
Use the following syntax to retrieve the ID of all the instances of VM separated by commas.
@@{calm_array_id}@@

Built-in Macros

The following table lists the built-in macros that you can use to retrieve and display the entities.

Table 1. Built-in Macros
Macro	Usage
@@{calm_array_index}@@	Index of the entity within an array
@@{calm_blueprint_name}@@	Name of the blueprint from which the application was created
@@{calm_blueprint_uuid}@@	Universally unique identifier (UUID) of the blueprint from which the application was created
@@{calm_application_name}@@	Name of the application
@@{calm_application_uuid}@@	UUID of the application
@@{calm_uuid}@@	UUID of the entity within the application on which the current task is running
@@{calm_random}@@	A random number is generated each time this is used. This will be evaluated each time and should not be used in fields such as VM name.
@@{calm_unique}@@	A random number that is unique to this replica. This will be evaluated to the same value across runs.
@@{calm_jwt}@@	JWT for the currently logged in user for API authentication.
@@{calm_now}@@ @@{calm_today}@@	The current time stamp
@@{calm_time(“<format>”)}@@	The current time in the specified format
@@{calm_year(“YYYY”)}@@ @@{calm_year(“YY”)}@@	The current year in YYYY or YY format
@@{calm_month(“short”)}@@ @@{calm_month(“long”)}@@	Name of the current month in long or short format
@@{calm_day(“month”)}@@ @@{calm_day(“year”)}@@	Numeric day of the month or year
@@{calm_weeknumber}@@ @@{calm_weeknumber(“iso”)}@@	ISO Numeric week of the year
@@{calm_weekday(“number”)}@@ @@{calm_weekday(“name_short”)}@@ @@{calm_weekday(“name_long”)}@@	Day of the week in numeric or short name or long name
@@{calm_hour(“12”)}@@ @@{calm_hour(“24”)}@@ @@{calm_hour(“am_pm”)}@@	Numeric hour of the day in 12:00-hour or 24:00-hour format along with AM or PM
@@{calm_minute}@@	Numeric minute
@@{calm_second}@@	Numeric second
@@{calm_is_weekday}@@	Displays 1 if the current day is a weekday
@@{calm_is_long_weekday}@@	Displays 1 if the current day is a weekday from Monday to Saturday
@@{calm_is_within("time1", "time2")}@@	Displays 1 if the current time is within the time1 and time2 range
@@{calm_project_name}@@	Displays the project name
@@{calm_username + @nutanix.com}@@	Displays the username
@@{calm_float("32.65") * 2}@@ @@{calm_int(calm_array_index) + 1}@@	Typecast to integer. This is useful for binary operations.
@@{calm_string(256) + "-bit"}@@ @@{"xyz" + calm_string(42)}@@	Typecast to string. This is useful for string concatenation.
@@{calm_b64encode(api_response)}@@ @@{calm_b64encode("a,b,c")}@@	Base64 encode the data passed to this macro.
@@{calm_b64encode(b64_encoded_data)}@@ @@{calm_b64encode("YSxiLGM=")}@@	Base64 decode the data passed to this macro.

Platform Macros

You can access the properties of a VM by using the platform macros. The following section describes the macros to access the VM properties for different providers.

Table 1. AHV platform Macros
Macro	Usage
@@{platform}@@	To access all the properties of a VM.
@@{platform.status.cluster_reference.uuid}@@	To access the uuid of the cluster or the Prism element.
@@{platform.status.resources.nic_list[0].mac_address}@@	To access mac the address. Note: Use the nic_list index to access the mac address of a specific nic.
@@{platform.status.resources.nic_list[0].subnet_reference.name}@@	To access the NIC name.
@@{platform.status.resources.power_state}@@	To get the state of the VM.
@@{platform.status.num_sockets}@@	To access number of sockets of the VM.

Note: The @@{platform}@@ macro stores the GET response of the VM. You can access any VM information that is available through the GET API response.

Table 2. VMware platform Macros
Macro	Usage
@@{platform}@@	To access all the properties of a VM.
@@{platform.datastore[0].Name}@@	To access the datastore name.
@@{platform.num_sockets}@@	To access number of sockets of the VM.

Note: The @@{platform}@@ macro stores the GET response of the VM. You can access any VM information that is available through the GET API response.

Table 3. GCP platform Macros
Macro	Usage
@@{platform}@@	To access all the properties of a VM.
@@{platform.creationTimestamp}@@	To get the VM creation time stamp.
@@{platform.selfLink}@@	To access the self link of the VM.
@@{platform.networkInterfaces[0].subnetwork}@@	To access the network details of the VM.

Note: The @@{platform}@@ macro stores the GET response of the VM. You can access any VM information that is available through the GET API response.

Endpoint Macros

The following table lists the endpoint macros for HTTP, Linux, and Windows endpoint types.

Table 1. HTTP
Macro	Usage
@@{endpoint.name}@@	Name of the endpoint
@@{endpoint.type}@@	Type of the endpoint
@@{endpoint.length}@@	Number of IP Addresses in the endpoint
@@{endpoint.index}@@	Index of the IP address or VM in a given endpoint
@@{endpoint.base_url}@@	Base URL of the HTTP endpoint
@@{endpoint.connection_timeout}@@	Time interval in seconds after which the connection attempt to the endpoint stops
@@{endpoint.retry_count}@@	Number of attempts the system performs to create a task after each failure
@@{endpoint.retry_interval}@@	Time interval in seconds for each retry if the task fails
@@{endpoint.tls_verify}@@	Verification for the URL of the HTTP endpoint with a TLS certificate
@@{endpoint.proxy_type}@@	HTTP(s) proxy/SOCKS5 proxy to use
@@{endpoint.base_urls}@@	Base URLs of HTTP endpoints
@@{endpoint.authentication_type}@@	Authentication method to connect to an HTTP endpoint: Basic or None
@@{endpoint.credential.username}@@	User name in the credential to access the endpoint
@@{endpoint.credential.secret}@@	Credential secret type to access the endpoint: Passphrase or SSH Private Key

Table 2. Linux
Macro	Usage
@@{endpoint.name}@@	Name of the endpoint
@@{endpoint.type}@@	Type of the endpoint
@@{endpoint.length}@@	Number of IP Addresses in the endpoint
@@{endpoint.index}@@	Index of the IP address or VM in a given endpoint
@@{endpoint.address}@@	IP address to access the endpoint device
@@{endpoint.port}@@	Port number to access the endpoint
@@{endpoint.value_type}@@	Target type of the endpoint: IP address or VM
@@{endpoint.addresses}@@	IP addresses to access endpoint devices
@@{endpoint.credential.secret}@@	Credential secret type to access the endpoint: Passphrase or SSH Private Key
@@{endpoint.credential.username}@@	User name in the credential to access the endpoint

Table 3. Windows
Macro	Usage
@@{endpoint.name}@@	Name of the endpoint
@@{endpoint.type}@@	Type of the endpoint
@@{endpoint.length}@@	Number of IP Addresses in the endpoint
@@{endpoint.index}@@	Index of the IP address or VM in a given endpoint
@@{endpoint.address}@@	IP address to access the endpoint device
@@{endpoint.port}@@	Port number to access the endpoint
@@{endpoint.value_type}@@	Target type of the endpoint: IP address or VM
@@{endpoint.connection_protocol}@@	Connection protocol to access the endpoint: HTTP or HTTPS
@@{endpoint.addresses}@@	IP addresses to access endpoint devices
@@{endpoint.credential.secret}@@	Credential secret type to access the endpoint: Passphrase or SSH Private Key
@@{endpoint.credential.username}@@	User name in the credential to access the endpoint

Note: To call an endpoint variable from another object, replace endpoint with the other endpoint name.

Runbook Macros

The following table lists the runbook macros.

Table 1. Runbook Macros
Macro	Usage
@@{calm_runbook_name}@@	Name of the runbook
@@{calm_runbook_uuid}@@	Universally unique identifier (UUID) of the runbook

Virtual Machine Common Properties

The following table lists the common properties of the virtual machine that are available for usage.

Table 1. Virtual Machine Common Properties
Properties	Usage
@@{address}@@	IP address of the instance that is used by Calm to access the VM
@@{id}@@	ID of the platform identifier
@@{name}@@	Name of the VM or container
@@{mac_address}@@	Mac address of the VM
@@{platform}@@	Platform response for a GET query. This is the response in JSON format from provider.

Note: For an existing machine, only the address property is applicable.

Variables Overview

Note: User defined variables in Calm cannot have macros in their values.

Variable Value Inheritance

The variable value of a parent entity can be accessed by the child entity unless the properties or the variables are overridden by another entity.

Variable Access

For example, on a service with 2 replicas, if you set a backup_dir variable through a set variable Escript task such as:

print "backup_dir=/tmp/backup_@@{calm_array_index}@@"

You get /tmp/backup_0 and /tmp/backup_1 values for replica 0 and 1 respectively.

When a task runs on this service with the echo "@@{backup_dir}@@" script, the script evaluates the following values in each replica of the service:

Replica 0
/tmp/backup_0
Replica 1
/tmp/backup_1

When you change the script to echo "@@{calm_array_backup_dir}@@" , the script evaluates to the following values in each replica of the service:

Replica 0
/tmp/backup_0,/tmp/backup_1
Replica 0
/tmp/backup_0,/tmp/backup_1

Example 1: If a blueprint contains a service by the name of app_container , you can access the IP address of the app_container service in any other service using @@{app_container.address}@@ syntax.
Example 2: If you need addresses of a service (S1) in a task on another service (S2), you can use @@{S1.address}@@ in the script for the task running on S2. The script will evaluate to the value, such as 10.0.0.3,10.0.0.4,10.0.0.5 in case S1 has 3 replicas.

Action-Level Variables

Type of action (in this case install or uninstall)
Name of the package

With multiple runs of this action, you can then install or uninstall multiple packages on the VM.

Nutanix Variables

The following table lists the Nutanix variables that are available for usage.

Table 1. Nutanix Variables
Variables	Usage
@@{address}@@	IP address of the instance that is used by Calm to access the VM
@@{id}@@	ID of the platform identifier
@@{name}@@	Name of the VM or container
@@{mac_address}@@	Mac address of the VM
@@{platform}@@	Platform response for a GET query. This is the response in JSON format from provider.

Note: For an existing machine, only the address property is applicable.

VMware Variables

The following table lists the built-in VMware macros that you can use to retrieve and display the entities.

Table 1. VMware Macros
Properties	Usage
@@{address}@@	IP address of the instance that is used by Calm to access the VM
@@{id}@@	ID of the platform identifier
@@{name}@@	Name of the VM or container
@@{mac_address}@@	Mac address of the VM
@@{platform}@@	Platform response for a GET query. This is the response in JSON format from provider.

Note: For an existing machine, only the address property is applicable.

AWS Variables

The following table lists the built-in AWS macros that you can use to retrieve and display the entities.

Table 1. AWS Macros
Macros	Usage
@@{address}@@	IP address of the instance that is used by Calm to access the VM. Note: The VM Name field does not support this macro.
@@{id}@@	Internal ID of the instance that is used within the Prism. Note: The VM Name field does not support this macro.
@@{name}@@	Name of the VM. Note: The VM Name field does not support this macro.
@@{aws_instance_id}@@	Instance ID of AWS
@@{private_ip_address}@@	Private IP address
@@{private_dns_name}@@	Private DNS name
@@{public_ip_address}@@	Public IP address
@@{public_dns_name}@@	Public DNS name
@@{vm_zone}@@	AWS zone of instance
@@{platform}@@	Platform response for a GET query. This is the response in JSON format from provider.

GCP Variables

The following table lists the built-in GCP macros that you can use to retrieve and display the entities.

Table 1. GCP Macros
Macros	Usage
@@{address}@@ @@{ip_address}@@ @@{public_ip_address}@@	IP address of the instance that is used by Calm to access the VM. Note: The VM Name field does not support this macro.
@@{id}@@	Internal ID of the instance that is used within the Prism. Note: The VM Name field does not support this macro.
@@{name}@@	Name of the VM. Note: The VM Name field does not support this macro.
@@{zone}@@	Zone in which the VM instance is created.
@@{platform_data}@@	Platform response for a GET query. This is the response in JSON format from provider.
@@{internal_ips}@@	List of all the private IP addresses.
@@{external_ips}@@	List of all the public IP addresses.

Azure Variables

The following table lists the built-in Azure macros that you can use to retrieve and display the entities.

Table 1. Azure Macros
Macros	Usage
@@{address}@@	IP address of the instance that is used by Calm to access the VM. Note: The VM Name field does not support this macro.
@@{id}@@	Internal ID of the instance that is used within the Prism. Note: The VM Name field does not support this macro.
@@{name}@@	Name of the VM. Note: The VM Name field does not support this macro.
@@{private_ip_address}@@	Private IP address
@@{public_ip_address}@@	Public IP address
@@{resource_group}@@	Resource group name in which the VM instance is created.
@@{platform_data}@@	Platform response for a GET query. This is the response in JSON format from provider.

Kubernetes Variables

The following table lists the Kubernetes variables that are available for usage.

Table 1. Kubernetes Variables
Properties	Usage
@@{K8sPublishedService.address}@@	IP address of the service.
@@{K8sPublishedService.name}@@	Name of the service.
@@{K8sPublishedService.ingress}@@	Load balancer IP for public service.
@@{K8sPublishedService.platform}@@	Platform data for the service.
@@{K8sDeployement.name}@@	Name of the deployment.
@@{K8sDeployement.platform}@@	Platform data for the deployment.

Note: Do not use deployment macros in publish service specs or publish macros in deployment service specs in the same calm deployment.

Runtime Variables Overview

Note: Ensure that the attributes marked as runtime variable are not null or empty and an initial value is configured.

Categories Overview

Your providers impose a limit to the number of tags that you can use for cloud governance. The following table lists the category or tag limit imposed by each provider:

Table 1. Tag or Category Limit
Providers	Category or Tag Limit
Nutanix	30
AWS	50
VMware	No limit
GCP	15
Azure	15

The following table lists the Calm-specific categories or tags and their availability for different providers:

Table 2. Calm-Specific Categories or Tags
Categories or Tags	Nutanix	AWS	VMware	GCP	Azure
account_uuid		X	X	X	X
CalmApplication	X	X	X	X	X
CalmService	X	X	X	X	X
CalmUsername	X	X	X	X	X
Calm Project		X	X	X	X
OSType	X	X	X	X	X

Single-VM Blueprints in Calm

A single-VM blueprint is a framework that you can use to create and provision an instance and launch applications that require only one virtual machine.

Creating a Single-VM Blueprint

Single-VM blueprints enable you to quickly provide Infrastructure-as-a-Service (IaaS) to your end users.

About this task

You can create single-VM blueprints with your Nutanix, VMware, AWS, GCP, or Azure accounts. Use these steps to create a single-VM blueprint with any of your provider accounts.

Before you begin

Ensure that the Prism web console (also known as Prism Element) is registered with your Prism Central.

Procedure

Set up your single-VM blueprint. In this step, you provide the name and description for the blueprint and select the project and environment for the blueprint. This step is common for all provider accounts. For more information, see Setting up a Single-VM Blueprint.
Add VM details to your blueprint. In this step, you provide a VM name and associate a provider account and an operating system to the blueprint. This step is also common for all provider accounts. For more information, see Adding VM Details to a Blueprint.
Configure the VM of your blueprint. This options available for VM configuration are derived from either the project or the environment that you selected while setting up the blueprint. For more information, see VM Configuration.
Configure advanced options. In this optional step, you add credentials, configure options to check the logon status of the VM after blueprint provisioning, add pre-create and post-delete tasks, or add packages. For more information, see Configuring Advanced Options for a Blueprint.

Setting up a Single-VM Blueprint

Perform the following steps to do the preliminary setup of your single-VM blueprint.

Before you begin

Procedure

Click the Blueprint icon in the left pane.
Click + Create Blueprint > Single VM Blueprint .
On the Blueprint Settings tab, enter a name and a description for your blueprint.
From the Project list, select a project.
From the Environment list, select an environment to configure your blueprint.
To save your blueprint setup, click Save .

What to do next

Click VM Details to provide a VM name and associate a provider account and an operating system to the blueprint. For more information, see Adding VM Details to a Blueprint.

Adding VM Details to a Blueprint

Perform the following steps to add VM details to your blueprint.

Before you begin

Ensure that you set up your single-VM blueprint. For more information, see Setting up a Single-VM Blueprint.

Procedure

On the VM Details tab, enter a name for the VM.
From the Account list, select the provider account that you want to associate to your blueprint.
If your provider account does not appear in the Account list, ensure that you selected the correct project on the Blueprint Settings tab. The project must have the required provider account configured.
From the Operating System list, select either Linux or Windows as the operating system for the VM.
To save the configurations, click Save .

What to do next

Click VM Configuration and configure the VM in your single-VM blueprint. For more information, see VM Configuration.

VM Configuration

Configuring VM for Nutanix Account

Perform the following steps to configure the VM in a single-VM blueprint for your Nutanix account.

Before you begin

Ensure that you set up your single-VM blueprint. For more information, see Setting up a Single-VM Blueprint.
Ensure that you added the VM details to your blueprint. For more information, see Adding VM Details to a Blueprint.

Procedure

If you have configured an environment during the project creation, then on the VM Configuration tab, click the Clone from environment button to autofill the VM configuration details. This step is optional.
The Clone from environment button appears only when you select a specific environment you configured for the account from the Environment list on the Blueprint Settings tab. The option does not appear if you select All Project Accounts as your environment.

You can also click the View Configuration option to review the configuration details before cloning the environment.
In the Cluster list, select the cluster that you want to associate to the blueprint.
The Cluster list displays the clusters that you allowed in the project.

The VLAN subnets have direct association with the cluster. When you select a VLAN subnet under the Network Adapters (NICs) section, the associated cluster is auto-populated in the Cluster list. However, if you intend to use overlay subnets, you must select the cluster in list.

If you mark the cluster as runtime editable, the selected subnets also become runtime editable.

Figure. General Configuration Click to enlarge
Edit the VM name in the VM Name field.
You can use Calm macros to provide a unique name to the VM. For example, vm-@@{calm_time}@@ . For more information on Calm macros, see Macros Overview.
Configure the processing unit of the VM by entering the number of vCPU, cores of each vCPU, and total memory in GB of the VM in the vCPU , cores per vCPU , and Memory (GiB) fields.
(Optional) If you want to customize the default OS properties of the VM, select the Guest Customization check box.
Guest customization allows you to modify the properties of the VM operating system. You can prevent conflicts that might result due to the deployment of virtual machines with identical settings, such as duplicate VM names or same SID. You can also change the computer name or network settings by using a custom script.
1. Select Cloud-init for Linux or SysPrep for Windows, and enter or upload the script in the Script panel.
  For Sysprep, you must use double back slash for all escape characters . For example, \\v.
2. For Sysprep script, click Join a Domain check box and configure the following fields.
  - Enter the domain name of the Windows server in the Domain Name field.
  - Select a credential for the Windows VM in the Credentials list. You can also add new credentials.
  - Enter the IP address of the DNS server in the DNS IP field.
  - Enter the DNS search path for the domain in the DNS Search Path field.
Under the Disks section, do the following:
1. To add a disk, click the + icon next to Disks .
2. Select the device from the Device Type list.
  You can select CD-ROM or DISK .
3. Select the device bus from the Device Bus list.
  You can select IDE or SATA for CD-ROM and SCSI , IDE , PCI , or SATA for DISK.
4. From the Operation list, select one of the following:
  - To allocate the disk memory from the storage container, select Allocate on Storage Container .
  - To clone an image from the disk, select Clone from Image Service .
5. If you selected Allocate on Storage Container , enter the disk size in GB in the Size (GiB) field.
6. If you selected Clone from Image Service , select the image you want to add to the disk in the Image field.
  All the images that you uploaded to Prism Central are available for selection. For more information about image configuration, see Image Management section in the Prism Central Guide .
7. Select the Bootable check box for the image that you want to use to start the VM.
Note: You can add more than one disk and select the disk with which you want to boot up the VM.
Under the Boot Configuration section, select a firmware type to boot the VM.
- To boot the VM with legacy BIOS firmware, select Legacy BIOS .
- To boot the VM with UEFI firmware, select UEFI . UEFI firmware supports larger hard drives, faster boot time, and provides more security features.
- To boot the VM with the Secure Boot feature of UEFI, select Secure Boot . Secure Boot ensures a safe and secure start by preventing unauthorized software such as a malware to take control during the VM bootup.
(For GPU-enabled clusters only) To configure a vGPU, click the + icon under the vGPUs section and do the following:
1. From the Vendor list, select the GPU vendor.
2. From the Device ID list, select the device ID of the GPU.
3. From the Mode list, select the GPU mode.
Under the Categories section, select a category in the Key: Value list.
Use this option to tag your VM to a defined category in Prism Central. The list options are available based on your Prism Central configuration. If you want to protect your application by a protection policy, select the category defined for the policy in your Prism Central.
To add a network adapter, click the + icon next to the Network Adapters (NICS) field.

Figure. Network Adapters Click to enlarge

The NIC list shows all the VLAN and overlay subnets. The VLAN subnets have direct association with the cluster. Therefore, when you select a VLAN subnet, the associated cluster is auto-populated in the Cluster list.

The NICs of a VM can either use VLAN subnets or overlay subnets. For example, if you select an overlay subnet in NIC 1 and then add NIC 2, the NIC 2 list displays only the overlay subnets.

If you select a VLAN subnet in NIC 1, all subsequent VLAN subnets belong to the same cluster. Similarly, if you select an overlay subnet, all subsequent overlay subnets belong to the same VPC.
To add a serial port to the VM, click the + icon next to the Serial Ports field.
You can use serial ports to connect a physical port or a file on the VM.
To save the blueprint, click Save .

What to do next

You can optionally configure the advanced options in the blueprint. For more information, see Configuring Advanced Options for a Blueprint.
You can view the blueprint on the Blueprint tab. You can use the blueprint to model your application. For more information, see Blueprints Management in Calm.

Configuring VM for VMware Account

Perform the following steps to configure the VM in a single-VM blueprint for your VMware account.

Before you begin

Ensure that you set up your single-VM blueprint. For more information, see Setting up a Single-VM Blueprint.
Ensure that you added the VM details to your blueprint. For more information, see Adding VM Details to a Blueprint.

Procedure

(Optional) If you have configured an environment during the project creation, then on the VM Configuration tab, click Clone from environment to autofill the VM configuration details.
The Clone from environment option appears only when you select a specific environment you configured for the account from the Environment list on the Blueprint Settings tab. The option does not appear if you select All Project Accounts as your environment.

You can also click the View Configuration option to review the configuration details before cloning the environment.
Select the Compute DRS Mode check box to enable load sharing and automatic VM placement.
Distributed Resource Scheduler (DRS) is a utility that balances computing workloads with available resources in a virtualized environment. For more information about DRS mode, see the VMware documentation .
- If you selected Compute DRS Mode , then select the cluster where you want to host your VM from the Cluster list.
- If you have not selected Compute DRS Mode , then select the host name of the VM from the Host list.
Do one of the following:
- Select the VM Templates radio button and then select a template from the Template list.
  Templates allow you to create multiple virtual machines with the same characteristics, such as resources allocated to CPU and memory or the type of virtual hardware. Templates save time and avoid errors when configuring settings and other parameters to create VMs. The VM template retrieves the list options from the configured vCenter.
  Note:
  - Install the VMware Tools on the Windows templates. For Linux VMs, install Open-vm-tools or VMware-tools and configure the Vmtoolsd service for automatic start-up.
  - Support for Open-vm-tools is available. When using Open-vm-tools , install Perl for the template.
  - Do not use SysPrepped as the Windows template image.
  - If you select a template that has unsupported version of VMware Tools, then a warning appears stating VMware tool or version is unsupported and could lead to VM issues .
  - You can also edit the NIC type when you use a template.
  For more information, refer to VMware KB articles.
- Select the Content Library radio button, a content library in the Content Library list, and then select an OVF template or VM template from the content library.
  A content library stores and manages content (VMs, vApp templates, and other types of files) in the form of library items. A single library item can consist of one file or multiple files. For more information about the vCenter content library, see the VMware Documentation .
  
  Caution: Content Library support is currently a technical preview feature in Calm. Do not use any technical preview features in a production environment.
If you want to use the storage DRS mode, then select the Storage DRS Mode check box and a datastore cluster from the Datastore Cluster list.
The datastore clusters are referred as storage pod in vCenter. A datastore cluster is a collection of datastores with shared resources and a shared management interface.
If you do not want to use storage DRS mode, then do not select the Storage DRS Mode check box, and select a datastore from the Datastore list.
In the VM Location field, specify the location of the folder in which the VM must be created when you deploy the blueprint. Ensure that you specify a valid folder name already created in your VMware account.
To create a subfolder in the location you specified, select the Create a folder/directory structure here check box and specify a folder name in the Folder/Directory Name field.

Note: Calm gives preference to the VM location specified in the environment you select while launching an application. For example, you specify a subfolder structure as the VM location in the blueprint and the top-level folder in the environment. When you select this environment while launching your application, Calm considers the VM location you specified in the environment and creates the VM at the top-level folder.

Select the Delete empty folder check box to delete the subfolder created within the specified location, in case the folder does not contain any VM resources. This option helps you to keep a clean folder structure.
Enter the instance name of the VM in the Instance Name field.
This field is pre-populated with a macro as suffix to ensure name uniqueness. The service provider uses this name as the VM name.
Under Controllers , click the + icon to add the type of controller.
You can select either SCSI or SATA controller. You can add up to three SCSI and four SATA controllers.
Under the Disks section, click the + icon to add vDisks and do the following:
1. Select the device type from the Device Type list.
  You can either select CD-ROM or DISK .
2. Select the adapter type from the Adapter Type list.
  You can select IDE for CD-ROM.
  
  You can select SCSI , IDE , or SATA for DISK.
3. Enter the size of the disk in GiB.
4. In the Location field, select the disk location.
5. If you want to add a controller to the vDisk, select the type of controller in the Controller list to attach to the disk.
  
  Note: You can add either SCSI or SATA controllers. The available options depend on the adapter type.
6. In the Disk mode list, select the type of the disk mode. Your options are:
  - Dependent : Dependent disk mode is the default disk mode for the vDisk.
  - Independent - Persistent : Disks in persistent mode behave like conventional disks on your physical computer. All data written to a disk in persistent mode are written permanently to the disk.
  - Independent - Nonpersistent : Changes to disks in nonpersistent mode are discarded when you shut down or reset the virtual machine. With nonpersistent mode, you can restart the virtual machine with a virtual disk in the same state every time. Changes to the disk are written to and read from a redo log file that is deleted when you shut down or reset.
You can also mark the vDisks runtime editable so you can add, delete, or edit the vDisks while launching the blueprint. For more information about runtime editable attributes, see Runtime Variables Overview.
Under the Tags section, select tags from the Category: Tag pairs field.
You can assign tags to your VMs so you can view the objects associated with your VMs in your VMware account. For example, you can create a tag for a specific environment and assign the tag to multiple VMs. You can then view all the VMs that are associated with the tag.
(Optional) If you want to customize the default OS properties of the VM, then click the Enable check box under VM Guest Customization and select a customization from the Predefined Guest Customization list.
If you do not have any predefined customization available, select None .
Select Cloud-init or Custom Spec .
If you selected Cloud-init , enter or upload the script in the Script field.
If you have selected Custom Spec , enter the details for the VM in the following fields:
1. Enter the hostname in the Hostname field.
2. Enter the domain in the Domain field.
3. Select timezone from the Timezone list.
4. Select Hardware clock UTC check box to enable hardware clock UTC.
5. Click the + icon to add network settings.
  To automatically configure DHCP server, enable the Use DHCP check box and then skip to the DNS Setting section.
6. Enter a name for the network configuration you are adding to the VM in the Setting name field.
  Settings name is the saved configuration of your network that you want to connect to your VM.
7. Enter values in the IP Address , Subnet Mask , Default Gateway , and Alternative Gateway fields.
8. Under the DNS Settings section, enter the DNS primary, DNS secondary, DNS tertiary, and DNS search path name.
Note: You can launch a single-VM blueprint without a NIC or network adapter with your VMware account.
To save the blueprint, click Save .

What to do next

You can optionally configure the advanced options in the blueprint. For more information, see Configuring Advanced Options for a Blueprint.
You can view the blueprint on the Blueprint tab. You can use the blueprint to model your application. For more information, see Blueprints Management in Calm.

Configuring VM for GCP Account

Perform the following steps to configure the VM in a single-VM blueprint for your GCP account.

Before you begin

Ensure that you set up your single-VM blueprint. For more information, see Setting up a Single-VM Blueprint.
Ensure that you added the VM details to your blueprint. For more information, see Adding VM Details to a Blueprint.

Procedure

(Optional) If you have configured an environment during the project creation, then on the VM Configuration tab, click Clone from environment to autofill the VM configuration details.
The Clone from environment option appears only when you select a specific environment you configured for the account from the Environment list on the Blueprint Settings tab. The option does not appear if you select All Project Accounts as your environment.

You can also click the View Configuration option to review the configuration details before cloning the environment.
(Optional) Edit the VM name in the Instance Name field.
This field is pre-populated with a macro as suffix to ensure name uniqueness. The service provider uses this name as the VM name.
Select a zone from the Zone list.
A zone is a physical location where you can host the VM.
Select the type of machine from the Machine type list.
The machine types are available based on your zone. A machine type is a set of virtualized hardware resources available to a virtual machine (VM) instance, including the system memory size, virtual CPU (vCPU) count, and persistent disk limits. In Compute Engine, machine types are grouped and curated by families for different workloads.
Under the DISKS section, click the + icon to add a disk.
You can also mark the added vDisks runtime editable so you can add, delete, or edit the vDisks while launching the blueprint. For more information about runtime editable attributes, see Runtime Variables Overview.
To use an existing disk configuration, select the Use existing disk check box, and then select the persistent disk from the Disk list.
If you have not selected the Use existing disk check box, then do the following:
1. Select the type of storage from the Storage Type list. The available options are as follows.
  - pd-balanced : Use this option as an alternative to SSD persistent disks with a balanced performance and cost.
  - pd-extreme : Use this option to use SSD drives for high-end database workloads. This option has higher maximum IOPS and throughput and allows you to provision IOPS and capacity separately.
  - pd-ssd : Use this option to use SSD drives as your persistent disk.
  - pd-standard : Use this option to use HDD drives as your persistent disk.
  The persistent disk types are durable network storage devices that your instances can access like physical disks in a desktop or a server. The data on each disk is distributed across several physical disks.
2. Select the image source from the Source Image list.
  The images available for your selection are based on the selected zone.
3. Enter the size of the disk in GB in the Size in GB field.
4. To delete the disk configuration after the instance is deleted, select the Delete when instance is deleted check box under the Disks section.
To add a blank disk, click the + icon under the Blank Disks section and configure the blank disk.
To add networking details to the VM, click the + icon under the Networking section.
To configure a public IP address, select the Associate Public IP address check box and configure the following fields.
1. Select the network from the Network list and the sub network from the Subnetwork list.
2. Enter a name of the network in the Access configuration Name field and select the access configuration type from the Access configuration type list.
  These fields appear when you select the Associate public IP Address check box.
To configure a private IP address, clear the Associate Public IP address check box and select the network and sub network.
Under the SSH Key section, click the + icon and enter or upload the username key data in the Username field.
Select Block project-wide SSH Keys to enable blocking project-wide SSH keys.
Under the Management section, do the following:
1. Enter the metadata in the Metadata field.
2. Select the security group from the Network Tags list.
  Network tags are text attributes you can add to VM instances. These tags allow you to make firewall rules and routes applicable to specific VM instances.
3. Enter the key-value pair in the Labels field.
  A label is a key-value pair that helps you organize the VMs created with GCP as the provider. You can attach a label to each resource, then filter the resources based on their labels.
Under the API Access section, do the following:
1. Specify the service account in the Service Account field.
2. Under Scopes, select Default Access or Full Access .
To save the blueprint, click Save .

What to do next

You can optionally configure the advanced options in the blueprint. For more information, see Configuring Advanced Options for a Blueprint.
You can view the blueprint on the Blueprint tab. You can use the blueprint to model your application. For more information, see Blueprints Management in Calm.

Configuring VM for AWS Account

Perform the following steps to configure the VM in a single-VM blueprint for your AWS account.

Before you begin

Ensure that you set up your single-VM blueprint. For more information, see Setting up a Single-VM Blueprint.
Ensure that you added the VM details to your blueprint. For more information, see Adding VM Details to a Blueprint.

Procedure

(Optional) If you have configured an environment during the project creation, then on the VM Configuration tab, click Clone from environment to autofill the VM configuration details.
The Clone from environment option appears only when you select a specific environment you configured for the account from the Environment list on the Blueprint Settings tab. The option does not appear if you select All Project Accounts as your environment.

You can also click the View Configuration option to review the configuration details before cloning the environment.
Edit the VM name in the Instance Name field.
This field is pre-populated with a macro as suffix to ensure name uniqueness. The service provider uses this name as the VM name.
Select the Associate Public IP Address check box to associate a public IP address with your AWS instance.
If you do not select the Associate Public IP Address check box, ensure that the AWS account and Calm are on the same network for the scripts to run.
Select an AWS instance type from the Instance Type list.
Instance types include varying combinations of CPU, memory, storage, and networking capacity and give you the flexibility to select the appropriate mix of resources for your applications. Each instance type includes one or more instance sizes that allows you to scale your resources to the requirements of your target workload.

The list displays the instances that are available in the AWS account. For more information, see AWS documentation.
Select a region from the Region list and do the following:

Note: The list displays the regions that are selected while configuring the AWS setting.
1. Select an availability zone from the Availability Zone list.
  An availability zone is one or more discrete data centers with redundant power, networking, and connectivity in an AWS region. Availability zones allow you to operate production applications and databases that are more highly available, fault tolerant, and scalable than would be possible from a single data center.
2. Select a machine image from the Machine Image list.
  An Amazon Machine Image is a special type of virtual appliance that is used to create a virtual machine within the Amazon Elastic Compute Cloud. It serves as the basic unit of deployment for services delivered using EC2.
3. Select an IAM role from the IAM Role list.
  An IAM role is an AWS Identity and Access Management entity with permissions to make AWS service requests.
4. Select a key pair from the Key Pairs list.
  A key pair (consisting of a private key and a public key) is a set of security credentials that you use to prove your identity when connecting to an instance.
5. Select the VPC from the VPC list and do the following:
  Amazon Virtual Private Cloud (Amazon VPC) allows you to provision a logically isolated section of the AWS cloud where you can launch AWS resources in your defined virtual network.
  - Select the Include Classic Security Group check box to enable security group rules.
  - Select security groups from the Security Groups list.
  - Select a subnet from the Subnet list.
Enter or upload the AWS user data in the User Data field.
Enter AWS tags in the AWS Tags field.
AWS tags are key and value pair to manage, identify, organize, search for, and filter resources. You can create tags to categorize resources by purpose, owner, environment, or other criteria.
Under the Storage section, configure the following to boot the AWS instance with the selected image.
1. From the Device list, select the device to boot the AWS instance.
  The available options are based on the image you have selected.
2. In the Size(GiB) field, enter the required size for the bootable device.
3. From the Volume Type list, select the volume type. You can select either General Purpose SSD , Provisioned IOPS SSD , and EBS Magnetic HDD .
  For more information on the volume types, see AWS documentation.
4. Optionally, select the Delete on termination check box to delete the storage when the instance is terminated.
You can also add more secondary storages by clicking the + icon next to the Storage section.
To save the blueprint, click Save .

What to do next

You can optionally configure the advanced options in the blueprint. For more information, see Configuring Advanced Options for a Blueprint.
You can view the blueprint on the Blueprint tab. You can use the blueprint to model your application. For more information, see Blueprints Management in Calm.

Configuring VM for Azure Account

Perform the following steps to configure the VM in a single-VM blueprint for your Azure account.

Before you begin

Ensure that you set up your single-VM blueprint. For more information, see Setting up a Single-VM Blueprint.
Ensure that you added the VM details to your blueprint. For more information, see Adding VM Details to a Blueprint.

Procedure

(Optional) If you have configured an environment during the project creation, then on the VM Configuration tab, click Clone from environment to autofill the VM configuration details.
The Clone from environment option appears only when you select a specific environment you configured for the account from the Environment list on the Blueprint Settings tab. The option does not appear if you select All Project Accounts as your environment.

You can also click the View Configuration option to review the configuration details before cloning the environment.
Edit the VM name in the Instance Name field.
This field is pre-populated with a macro as suffix to ensure name uniqueness. The service provider uses this name as the VM name.
Select a resource group from the Resource Group list or select the Create Resource Group check box to create a resource group.
Each resource in Azure must belong to a resource group. A resource group is simply a logical construct that groups multiple resources together so you can manage the resources as a single entity. For example, you can create or delete resources as a group that share a similar life cycle, such as the resources for an n-tier application.

The Resource Group list displays the resource groups that are associated with the subscriptions you selected in your Azure account. In case you have not selected any subscriptions, Calm considers all the subscriptions that are available in the Azure service principal to display the resource groups. Each resource group in the list also displays the associated subscription.
If you selected a resource group from the Resource Group list, then do the following:
1. Select the geographical location of the datacenter from the Location list.
2. Select Availability Sets or Availability Zones from the Availability Option list.
  You can then select an availability set or availability zone. An availability set is a logical grouping capability to ensure that the VM resources are isolated from each other to provide High Availability if deployed within an Azure datacenter. An availability zone allows you to deploy your VM into different datacenters within the same region.
3. Select the hardware profile as per your hardware requirements from the Hardware Profile list.
  The number of data disks and NICs depends upon the selected hardware profile. For information about the sizes of Windows and Linux VMs, see Windows and Linux Documentation.
If you selected the Create Resource Group check box to create a resource group, then do the following:
1. Select a subscription associated to your Azure account in the Subscription field.
2. Enter a unique name for the resource group in the Name field.
3. Select the geographical location of the datacenter that you want to add to the resource group in the Location list.
4. Under Tags , enter a key and value pair in the Key and Value fields respectively.
  Tags are key and value pairs that enable you to categorize resources. You can apply a tag to multiple resource groups.
5. If you want to automatically delete a resource group that has empty resources while deleting an application, click the Delete Empty Resource Group check box.
6. Specify the location and hardware profile.
Under the Secrets section, click the + icon and do the following:
1. Enter a unique vault ID in the Vault ID field.
2. Under Certificates , click the + icon.
3. Enter the URL of the configuration certificate in the URL field.
  The URL of the certificate is uploaded to the key vault as a secret.
Under the Admin Credentials section, do the following:
1. Enter the username in the Username field.
2. Select a secret type from the Secret Type list.
  You can either select Password or SSH Private Key.
3. Do one of the following.
  - If you selected password, then enter the password in the Password field.
  - If you selected SSH Private Key, then enter or upload the SSH Private Key in the SSH Private Key field.
  - You can use the selected or default credential as the default credential for the VM.
  - You cannot use key-based credential for Windows VMs.
  - Username and password must adhere to the complexity requirements of Azure.
(For Windows) Select the Provision Windows Guest Agent check box.
This option indicates whether or not to provision the virtual machine agent on the virtual machine. When this property is not specified in the request body, the default behavior is to set it to true. This ensures that the VM Agent is installed on the VM, and the extensions can be added to the VM later.
(For Windows) To indicate that the VM is enabled for automatic updates, select the Automatic OS Upgrades check box.
Under the Additional Unattended Content section, click the + icon and do the following:
1. Select a setting from the Setting Name list.
  You can select Auto Logon or First Logon Commands .
  Note: Guest customization is applicable only on images that allows or support guest customization.
2. Enter or upload the xml content. See Sample Auto Logon and First Logon Scripts.
Under the WinRM Listeners section, click the + icon and do the following:
1. Select the protocol from the Protocol list.
  You can select HTTP or HTTPS .
2. If you selected HTTPS, then select the certificate URL from the Certificate URL list.
Under the Storage Profile section, select the Use Custom Image check box to use a custom VM image created in your subscription.
You can then select a custom image or publisher-offer-SKU-version from the Custom Image list.
Under the VM Image Details section, select an image type in the Source Image Type list.
You can select Marketplace , Subscription , or Shared Image Gallery .
- If you selected Marketplace , then specify the publisher, offer, SKU, and version for the image.
- If you selected Subscription , then select the custom image.
- If you selected Shared Image Gallery , then select the gallery and the image.
Under the OS Disk Details section, do the following:
1. Select the storage type from the Storage Type list.
  You can select Standard HDD , Standard SSD , or Premium SSD .
2. Select a disk storage account from the Disk Storage list.
  This field is available only when the Use Custom Image check box is enabled.
3. Select disk caching type from the Disk Caching Type list.
  You can select None , Read-only , or Read write .
4. Select disk create option from the Disk Create Option list.
  You can select Attach , Empty , or From Image .
Under the Data Disk section, do the following:
1. Select the storage type from the Storage Type list.
  You can select Standard HDD , Standard SSD , or Premium SSD .
2. Select disk caching type from the Disk Caching Type list.
  You can select None , Read-only , or Read write .
3. Enter the size in GB in the Size field.
4. Enter disk logical unit number (LUN) in the Disk LUN field.
  
  Note: The LUN value should be unique across data disk list.
Under the Network Profile section, add NICs as per your requirement and do the following for each NIC:
1. Select a security group from the Security Group list.
2. Select a virtual network from the Virtual Network list.
3. Under Public IP Config , enter a name and select an allocation method.
4. Under Private IP Config , select an allocation method.
  If you selected Static as the allocation method, then enter the private IP address in the IP Address field.
Enter tags in the Tags field.
To save the blueprint, click Save .

What to do next

You can optionally configure the advanced options in the blueprint. For more information, see Configuring Advanced Options for a Blueprint.
You can view the blueprint on the Blueprint tab. You can use the blueprint to model your application. For more information, see Blueprints Management in Calm.

Configuring VM for Xi Cloud Account

Perform the following steps to configure the VM in a single-VM blueprint for your Xi Cloud account.

Before you begin

Ensure that you set up your single-VM blueprint. For more information, see Setting up a Single-VM Blueprint.
Ensure that you added the VM details to your blueprint. For more information, see Adding VM Details to a Blueprint.

Procedure

On the VM Configuration tab, edit the VM name in the VM Name field.
You can use Calm macros to provide a unique name to the VM. For example, vm-@@{calm_time}@@ . For more information on Calm macros, see Macros Overview.
Configure the processing unit of the VM by entering the number of vCPU, cores of each vCPU, and total memory in GB of the VM in the vCPU , cores per vCPU , and Memory fields.
If you want to customize the default OS properties of the VM, select the Guest Customization check box.
Guest customization allows you to modify the properties of the VM operating system. You can prevent conflicts that might result due to the deployment of virtual machines with identical settings, such as duplicate VM names or same SID. You can also change the computer name or network settings by using a custom script.
Select Cloud-init for Linux or SysPrep for Windows, and enter or upload the script in the Script panel.
For Sysprep, you must use double back slash for all escape characters . For example, \\v.
For Sysprep script, click Join a Domain check box and configure the following fields.
- Enter the domain name of the Windows server in the Domain Name field.
- Select a credential for the Windows VM in the Credentials list. You can also add new credentials.
- Enter the IP address of the DNS server in the DNS IP field.
- Enter the DNS search path for the domain in the DNS Search Path field.
Select the image from the Image list.
The list displays the images that are available in the cluster. You can add more than one image by clicking the + icon.

All the images that you uploaded to Prism Central are available for selection. For more information about image configuration, see Image Management section in the Prism Central Guide .
Select the device from the Device Type list.
You can select CD-ROM or Disk .
Select the device bus from the Device Bus list.
You can select IDE or SATA for CD-ROM and SCSI , IDE , PCI , or SATA for DISK.
Select the Bootable check box for the image that you want to use to start the VM.
To add a vDisk, click the + icon and specify the device type, device bus, and disk size.
You can also mark the vDisks runtime editable so you can add, delete, or edit the vDisks while launching the blueprint. For more information about runtime editable attributes, see Runtime Variables Overview.
Under Categories , select a category in the list.
Use this option to tag your VM to a defined category in Prism Central. The list options are available based on your Prism Central configuration. If you want to protect your application by a protection policy, select the category defined for the policy in your Prism Central.
Under the Network section, select the VPC from the VPC list. For more information about VPC, see Nutanix Cloud Infrastructure Service Admininistration Guide .
To save the blueprint, click Save .

What to do next

You can optionally configure the advanced options in the blueprint. For more information, see Configuring Advanced Options for a Blueprint.
You can view the blueprint on the Blueprint tab. You can use the blueprint to model your application. For more information, see Blueprints Management in Calm.

Configuring Advanced Options for a Blueprint

Perform the following steps to configure advanced options such as credentials, packages, pre-create and post-delete tasks. Configuring advanced options is optional for a blueprint.

Before you begin

Ensure that you set up your single-VM blueprint. For more information, see Setting up a Single-VM Blueprint.
Ensure that you added the VM details to your blueprint. For more information, see Adding VM Details to a Blueprint.
Ensure that you configured the VM in your blueprint. For more information, see VM Configuration.

Procedure

Add credentials to enable packages and actions. For more information, see Adding Credentials.
Configure the connection in your blueprint. For more information, see Configuring Check Log-In.
Configure pre-create or post-delete tasks and packages in the blueprint. For more information, see Configuring Tasks or Packages in a Blueprint.
Add an action. For more information, see Adding an Action to a Single-VM Blueprint.
Click Save .

What to do next

You can configure application variables in the blueprint. For more information, see Configuring Application Variables in a Blueprint.
You can view the blueprint on the Blueprint tab. You can use the blueprint to model your application. For more information, see Blueprints Management in Calm.

Configuring Tasks or Packages in a Blueprint

Perform the following steps to configure pre-create task, post-delete task, install package, or uninstall package in a single-VM blueprint.

Before you begin

Ensure that you set up your single-VM blueprint. For more information, see Setting up a Single-VM Blueprint.
Ensure that you added the VM details to your blueprint. For more information, see Adding VM Details to a Blueprint.
Ensure that you configured the VM in your blueprint. For more information, see VM Configuration.

Procedure

On the Advanced Options tab, do one of the following:
- To configure a pre-create or post-delete task, click Edit next to the Pre VM create tasks or Post VM delete tasks field under the PreCreate & PostDelete section.
- To configure an install or uninstall package, click the Edit button next to the Package Install or Package Uninstall field under the Packages section.
Click + Add Task .
Click the Task button.
Enter the task name in the Task Name field.
Select the type of tasks from the Type list.
The available options are:
- Execute : Use this task type to run eScripts on the VM. For more information, see Creating an Execute Task.
- Set Variable : Use this task to change variables in a blueprint. For more information, see Creating a Set Variable Task.
- Delay : Use this task type to set a time interval between two tasks or actions. For more information, see Creating a Delay Task.
- HTTP Task : Use this task type to query REST calls from a URL. An HTTP task supports GET, PUT, POST, and DELETE methods. For more information, see Creating an HTTP Task.
To add another task or package, do one of the following:
- To add another pre-create or post-delete task, click the Pre create or Pre delete button and repeat steps 3 to 5.
- To add another task for package install or uninstall, click the Package Install or Package Uninstall button.
To establish a connection between tasks, click Add Connector and use the arrow to create the connection.
To delete a task, click the Delete button next to the task.
To add variables, do one of the following:
- To add a pre-create or post-delete variable, click the Pre create Variables or Post delete Variables tab.
- To add a package install or uninstall variable, click the Package Install Variables or Package Uninstall Variables tab.
Click the + icon next to Variables .
In the Name field, enter a name for the variable.
From the Data Type list, select one of the base type variables or import a custom library variable type.
If you selected a base type variable, configure all the variable parameters. For more information about configuring variable parameters, see Creating Variable Types.

If you imported a custom variable type, all the variable parameters are auto filled.
If you want to hide the variable value, select the Secret check box.
Click Done .

Configuring Application Variables in a Blueprint

Perform the following steps to configure application variables in your blueprint.

Procedure

On the blueprint page, click App variables .
Click + Add Variable .
In the Name field, enter a name for the variable.
From the Data Types list, select one of the base type variables or import a custom library variable type. Your options are:
- String
- Integer
- Multi-line string
- Date
- Time
- Date Time
If you selected a base type variable, then configure all the variable parameters. For more information about configuring variable parameters, see Creating Variable Types.

If you have imported a custom variable type, all the variable parameters are auto filled.
Enter a value for the selected data type in the Value field.
You can select the Secret check box to hide the variable value.
Click Show Additional Options .
In the Input Type field, select one of the following input types:
- Simple : Use this option for default value.
- Predefined : Use this option to assign static values.
- eScript : Use this option to attach a script that you run to retrieve values dynamically at runtime. Script can return single or multiple values depending on the selected base data type.
- HTTP : Use this option to retrieve values dynamically from the defined HTTP end point. Result is processed and assigned to the variable based on the selected base data type.
If you selected Simple , then enter the value for the variable in the Value field.
If you selected Predefined , then enter the value for the variable in the Option field.
To add multiple values for the variable, click + Add Option , and enter values in the Option field.

Note: To make any value as default, select Default for the option.
If you selected eScript , enter the eScript in the field.
You can upload the script from the library or from your computer by clicking the upload icon.

You can also publish the script to the library by clicking the publish button.
Note:
- You cannot add macros to eScripts.
- If you have selected Multiple Input (Array) check box with input type as eScript, then ensure that the script returns a list of values separated by comma. For example, CentOS, Ubuntu, Windows.
If you selected HTTP , then configure the following fields.
1. In the Request URL field, enter the URL of the server that you want to run the methods on.
2. In the Request Method list, select one of the following request methods.
  - Use the GET method to retrieve data from a specified resource.
  - Use the PUT method to send data to a server to update a resource.
  - Use the POST method to send data to a server to create a resource.
  - Use the DELETE method to send data to a server to delete a resource.
  In the Request Body field, enter the PUT, POST, or DELETE request. You can also upload the request by clicking the upload icon.
3. In the Content Type list, select the type of the output format.
  The available options are XML , JSON , and HTML .
4. In the Connection Timeout (sec) field, enter the timeout interval in seconds.
5. (Optional) In the Authentication field, select Basic and do the following:
  - In the Username field, enter the user name.
  - In the Password field, enter the password.
6. If you want to verify the TLS certificate for the task, select the Verify TLS Certificate check box.
7. If you want to use a proxy server that you configured in Prism Central, select the Use PC Proxy configuration check box.
  
  Note: Ensure that the Prism Central has the appropriate HTTP proxy configuration.
8. In the Retry Count field, enter the number of attempts the system must perform to create a task after each failure.
  By default, the retry count is zero. It implies that the task creation procedure stops after the first attempt.
9. In the Retry Interval field, enter the time interval in seconds for each retry if the task fails.
10. Under the Headers section, enter the HTTP header key and value in the Key and Value fields respectively.
  If you want to publish the HTTP header key and value pair as secret, select the Secrets check box.
11. Under the Expected Response Options section, enter the details for the following fields:
  - In the Response Code field, enter the response code.
  - From the Response Status list, select either Success or Failure as the response status for the task.
12. In the Set Response Path for Variable field, enter the variables from the specified response path.
  The example of json format is $.x.y and xml format is //x/y. For example, if the response path for variable is $.[*].display for response.
```
[
    {
        "display": "HTML Tutorial",
        "url": "https://www.w3schools.com/html/default.asp"
    },
    {
        "display": "CSS Tutorial",
        "url": "https://www.w3schools.com/css/default.asp"
    },
    {
        "display": "JavaScript Tutorial",
        "url": "https://www.w3schools.com/js/default.asp"
    },
    {
        "display": "jQuery Tutorial",
        "url": "https://www.w3schools.com/jquery/default.asp"
    },
    {
        "display": "SQL Tutorial",
        "url": "https://www.w3schools.com/sql/default.asp"
    },
    {
        "display": "PHP Tutorial",
        "url": "https://www.w3schools.com/php/default.asp"
    },
    {
        "display": "XML Tutorial",
        "url": "https://www.w3schools.com/xml/default.asp"
    }
]
```
  Then, during the launch time the list options are ["HTML Tutorial","CSS Tutorial","JavaScript Tutorial","jQuery Tutorial","SQL Tutorial","PHP Tutorial","XML Tutorial"].
(Optional) Enter a label and description for the variable.
(Optional) Set variable options.
- Select the Mark this variable private check box to make the variable private. Private variables are not shown during the blueprint launch or in the application.
- Select the Mark this variable mandatory check box to make the variable a requisite for application launch.
- Select the Validate with Regular Expression check box if you want to test the Regex values. Click Test Regex , provide the value for the Regex, and test or save the Regex. You can enter regex values in PCRE format. For more details, see from http://pcre.org/.
Click Done .

Multi-VM Blueprints in Calm

A multi-VM blueprint is a framework that you can use to create an instance, provision, and launch applications that require multiple VMs.

Creating a Multi-VM Blueprint

In a Multi-VM blueprint, you can define the underlying infrastructure of the VMs, application details, and actions that are carried out on a blueprint until the termination of the application.

About this task

You can create and configure multi-VM blueprints with your Nutanix, VMware, AWS, GCP, or Azure accounts.

Before you begin

Ensure that you have configured an account and a project for your blueprint.

Procedure

Add a service. For more information, see Adding a Service.
Configure VM, package, and service for your provider account. For more information, see Configure Multi-VM, Package, and Service.
Set the service dependencies. For more information, see Setting up the Service Dependencies.
Add and configure an application profile. For more information, see Adding and Configuring an Application Profile.
(Optional) Add and configure Scale Out and Scale In. For more information, see Adding and Configuring Scale Out and Scale In.
Create an action. For more information, see Adding an Action to a Multi-VM Blueprint.

Adding a Service

About this task

For more information about services in Calm, see Services Overview.

Procedure

Click the Blueprint icon in the left pane.
The Blueprint page is displayed.
From the + Create Blueprint list, select Multi VM/Pod Blueprint .
The Blueprint Setup window appears.
Enter the name of the blueprint in the Name field.
Optionally, provide a description about the blueprint in the Description field.
Select a project from the Project list.

Note: The available account options depend on the selected project.
Click Proceed .
The Multi-VM Blueprint Editor page appears.
Figure. Multi-VM Blueprint Editor Click to enlarge
To add a service, click the + icon next to Service in the Overview Panel.
The service inspector appears in the Blueprint Canvas.
Figure. Service Inspector Click to enlarge

What to do next

Configure the VM, package, and service. For more information, see Configure Multi-VM, Package, and Service.

Configure Multi-VM, Package, and Service

Configuring Nutanix and Existing Machine VM, Package, and Service

You can define the underlying infrastructure of the VM, application details, and actions that are carried out on a blueprint until the termination of the application on a Nutanix platform.

Before you begin

Ensure that you have completed the pre-configuration requirements. For more information, see Creating a Multi-VM Blueprint.
Ensure that you have created a project and configured an environment for Nutanix. For more information, see Creating a Project and Configuring Nutanix Environment.

Procedure

Perform the basic blueprint setup, and add a service. For more information, see Adding a Service.

Figure. Blueprint Configuration Click to enlarge
Enter a name of the service in the Service Name field.
On the VM tab, in the Name field, enter a name for the VM.
Select the provider account from the Account list.
You can select Existing Machine or a Nutanix account.

Note: The account options depend on the project you selected while setting up your blueprint.
If you selected Existing Machine , then do the following:
1. Select Windows or Linux from the Operating System list.
2. In the Configuration section, enter the IP address of the existing machine in the IP Address field
3. In the Select tunnel to connect with list, select a tunnel that you want to use to connect with this VM if the VM is within the VPC. This step is optional.
4. Configure the connection in your blueprint. For more information, see Configuring Check Log-In.
Figure. Existing Machine Click to enlarge
If you selected a Nutanix account, then select Windows or Linux from the Operating System list.
If you have configured an environment during the project creation, then under the Preset VM Config section, click the Clone from environment button to autofill the VM configuration details. This step is optional.
The Clone from environment button appears only when you select a specific environment you configured for the account from the Environment list in the application profile. The option does not appear if you select All Project Accounts as your environment.

You can also click the View Configuration option to review the configuration details before cloning the environment.
In the Cluster list, select the cluster you want to associate to the service.
The Cluster list displays the clusters that you allowed in the project.

The VLAN subnets have direct association with the cluster. When you select a VLAN subnet under the Network Adapters (NICs) section, the associated cluster is auto-populated in the Cluster list. However, if you intend to use overlay subnets, you must select the cluster in list.

If you mark the cluster as runtime editable, the selected subnets also become runtime editable.
Under the VM Configuration section, enter the name of the VM in the VM Name field.
You can use Calm macros to provide a unique name to the VM. For example, vm-@@{calm_array_index}@@-@@{calm_time}@@ . For more information on Calm macros, see Macros Overview.
Configure the processing unit of the VM by entering the number of vCPU, cores of each vCPU, and total memory in GB of the VM in the vCPU , cores per vCPU , and Memory (GiB) fields.
(Optional) If you want to customize the default OS properties of the VM, select the Guest Customization check box.
Guest customization allows you to modify the properties of the VM operating system. You can prevent conflicts that might result due to the deployment of virtual machines with identical settings, such as duplicate VM names or same SID. You can also change the computer name or network settings by using a custom script.
1. Select Cloud-init for Linux or SysPrep for Windows, and enter or upload the script in the Script panel.
  For Sysprep, you must use double back slash for all escape characters . For example, \\v.
2. For Sysprep script, click Join a Domain check box and configure the following fields.
  - Enter the domain name of the Windows server in the Domain Name field.
  - Select a credential for the Windows VM in the Credentials list. You can also add new credentials.
  - Enter the IP address of the DNS server in the DNS IP field.
  - Enter the DNS search path for the domain in the DNS Search Path field.
Under the DISKS section, do the following:
1. To add a disk, click the + icon next to DISKS .
2. Select the device from the Device Type list.
  You can select CD-ROM or DISK .
3. Select the device bus from the Device Bus list.
  You can select IDE or SATA for CD-ROM and SCSI , IDE , PCI , or SATA for DISK.
4. From the Operation list, select one of the following:
  - To allocate the disk memory from the storage container, select Allocate on Storage Container .
  - To clone an image from the disk, select Clone from Image Service .
5. If you selected Allocate on Storage Container , enter the disk size in GB in the Size (GiB) field.
6. If you selected Clone from Image Service , select the image you want to add to the disk in the Image field.
  All the images that you uploaded to Prism Central are available for selection. For more information about image configuration, see Image Management section in the Prism Central Guide .
7. Select the Bootable check box for the image that you want to use to start the VM.
Note: You can add more than one disk and select the disk with which you want to boot up the VM.
Select one of the following firmwares to boot the VM.
- Legacy BIOS : Select legacy BIOS to boot the VM with legacy BIOS firmware.
- UEFI : Select UEFI to boot the VM with UEFI firmware. UEFI firmware supports larger hard drives, faster boot time, and provides more security features.
- To boot the VM with the Secure Boot feature of UEFI, select Secure Boot . Secure Boot ensures a safe and secure start by preventing unauthorized software such as a malware to take control during the VM bootup.
Under the Categories section, select a category in the Key: Value list.
Use this option to tag your VM to a defined category in Prism Central. The list options are available based on your Prism Central configuration. If you want to protect your application by a protection policy, select the category defined for the policy in your Prism Central.
To add a network adapter, click the + icon next to the Network Adapters (NICS) field and select the subnet from the NIC list.
The NIC list shows all the VLAN and overlay subnets. The VLAN subnets have direct association with the cluster. Therefore, when you select a VLAN subnet, the associated cluster is auto-populated in the Cluster list.

Figure. Network Adapter Click to enlarge

The NICs of a VM can either use VLAN subnets or overlay subnets. For example, if you select an overlay subnet in NIC 1 and then add NIC 2, the NIC 2 list displays only the overlay subnets.

If you select a VLAN subnet in NIC 1, all subsequent VLAN subnets belong to the same cluster. Similarly, if you select an overlay subnet, all subsequent overlay subnets belong to the same VPC.
To add a serial port to the VM, click the + icon next to the Serial Ports field.
You can use serial ports to connect a physical port or a file on the VM.
Configure the connection in your blueprint. For more information, see Configuring Check Log-In.
On the Package tab, enter the package name in the Package Name field.
1. Click one of the following:
  - To create a task to install a package, click Configure install .
  - To create a task to uninstall a package, click Configure uninstall .
2. In the Blueprint Canvas, click + Task .
  
  Figure. Package Click to enlarge
3. Enter the task name in the Task Name field.
To create a task, select the type of task from the Type list.
The available options are:
- Execute : To create the Execute task type, see Creating an Execute Task.
- Set Variable : To create the Set Variable task type, see Creating a Set Variable Task.
- HTTP : To create the HTTP type, see Creating an HTTP Task.
- Delay : To create the Delay task type, see Creating a Delay Task.
For Execute and Set Variable tasks, you can use endpoints as targets for script execution. For more information, see Endpoints Overview.
To reuse a task from the task library, do the following.
1. Click Browse Library .
2. Select the task from the task library.
  When you select a task, the task inspector panel displays the selected task details.
3. Click Select .
4. Optionally, edit the variable or macro names as per your blueprint.
  The variable or macro names used in the task can be generic, you can update them with corresponding variable or macro names as per your blueprint.
5. To update the variable or macro names, click Apply .
6. To copy the task, click Copy .
On the Service tab, do the following:
1. Under Deployment Config , enter the number of default, minimum and maximum service replicas that you want to create in the Default , Min , and Max fields respectively.
  The Min and Max fields define the scale-in and scale-out actions. The scale-in and scale-out actions cannot scale beyond the defined minimum and maximum numbers. The default field defines the number of default replicas the service creates.
  
  If there is an array of three VMs, define the minimum number as three.
2. In the Variables section, click the + icon to add variable types to your blueprint.
3. In the Name field, enter a name for the variable.
4. From the Data Type list, select one of the base type variables or import a custom library variable type.
5. If you have selected a base type variable, configure all the variable parameters. For more information about configuring variable parameters, see Creating Variable Types.
6. If you have imported a custom variable type, all the variable parameters are auto filled.
7. Select the Secret check box if you want to hide the value of the variable.
Add credentials to the blueprint. For more information, see Adding Credentials.
Click Save on the Blueprint Editor page.
The blueprint is saved and listed on the Blueprints page.

What to do next

Define the service dependencies. See Setting up the Service Dependencies.

Configuring AWS VM, Package, and Service

You can define the underlying infrastructure of the VM, application details, and actions that are carried out on a blueprint until the termination of the application on an AWS platform.

Before you begin

Ensure that you have completed the pre-configuration requirements. See Creating a Multi-VM Blueprint.
Ensure that you have created a project and configured an environment for AWS. For more information, See Creating a Project and Configuring AWS Environment.

Procedure

Perform the basic blueprint setup, and add a service. For more information, see Adding a Service.

Figure. Blueprint Configuration Click to enlarge
Enter a name of the service in the Service Name field.
On the VM tab, enter a name for the VM in the Name field.
Select the AWS account from the Account list.

Note: The account options depend on the project you selected while setting up your blueprint.
Select Windows or Linux from the Operating System list.
(Optional) If you have configured an environment during the project creation, then click Clone from environment to autofill the VM configuration details.
The Clone from environment option appears only when you select a specific environment you configured for the account from the Environment list in the application profile. The option does not appear if you select All Project Accounts as your environment.

You can also click the View Configuration option to review the configuration details before cloning the environment.
Edit the VM name in the Instance Name field.
This field is pre-populated with a macro as suffix to ensure name uniqueness. The service provider uses this name as the VM name.
Select the Associate Public IP Address check box to associate a public IP address with your AWS instance.
If you do not select the Associate Public IP Address check box, ensure that the AWS account and Calm are on the same network for the scripts to run.
Select an AWS instance type from the Instance Type list.
Instance types include varying combinations of CPU, memory, storage, and networking capacity and give you the flexibility to select the appropriate mix of resources for your applications. Each instance type includes one or more instance sizes that allows you to scale your resources to the requirements of your target workload.

The list displays the instances that are available in the AWS account. For more information, see AWS documentation.
Select a region from the Region list and do the following:

Note: The list displays the regions that are selected while configuring the AWS setting.
1. Select an availability zone from the Availability Zone list.
  An availability zone is one or more discrete data centers with redundant power, networking, and connectivity in an AWS region. Availability zones allow you to operate production applications and databases that are more highly available, fault tolerant, and scalable than would be possible from a single data center.
2. Select a machine image from the Machine Image list.
  An Amazon Machine Image is a special type of virtual appliance that is used to create a virtual machine within the Amazon Elastic Compute Cloud. It serves as the basic unit of deployment for services delivered using EC2.
3. Select an IAM role from the IAM Role list.
  An IAM role is an AWS Identity and Access Management entity with permissions to make AWS service requests.
4. Select a key pair from the Key Pairs list.
  A key pair (consisting of a private key and a public key) is a set of security credentials that you use to prove your identity when connecting to an instance.
5. Select the VPC from the VPC list and do the following:
  Amazon Virtual Private Cloud (Amazon VPC) allows you to provision a logically isolated section of the AWS cloud where you can launch AWS resources in your defined virtual network.
Enter AWS tags in the AWS Tags field.
AWS tags are key and value pair to manage, identify, organize, search for, and filter resources. You can create tags to categorize resources by purpose, owner, environment, or other criteria.
Under the Storage section, configure the following to boot the AWS instance with the selected image.
1. From the Device list, select the device to boot the AWS instance.
  The available options are based on the image you have selected.
2. In the Size(GiB) field, enter the required size for the bootable device.
3. From the Volume Type list, select the volume type. You can select either General Purpose SSD , Provisioned IOPS SSD , and EBS Magnetic HDD .
  For more information on the volume types, see AWS documentation.
4. Optionally, select the Delete on termination check box to delete the storage when the instance is terminated.
You can also add more secondary storages by clicking the + icon next to the Storage section.
Configure the connection in your blueprint. For more information, see Configuring Check Log-In.
On the Package tab, enter the package name in the Package Name field.
1. Click one of the following:
  - Configure install : To create a task to install a package.
  - Configure uninstall : To create a task to uninstall a package.
2. In the Blueprint Canvas, click + Task .
  
  Figure. Package Click to enlarge
3. Enter the task name in the Task Name field.
To create a task, select the type of task from the Type list.
The available options are:
- Execute : To create the execute type of task, see Creating an Execute Task.
- Set Variable : To create the set variable type of task, see Creating a Set Variable Task.
- HTTP : To create the HTTP Task type, see Creating an HTTP Task.
- Delay : To create the Delay task type, see Creating a Delay Task.
For Execute and Set Variable tasks, you can use endpoints as targets for script execution. For more information, see Endpoints Overview.
To reuse a task from the task library, do the following.
1. Click Browse Library .
2. Select the task from the task library.
  When you select a task, the task inspector panel displays the selected task details.
3. Click Select .
4. Optionally, edit the variable or macro names as per your blueprint.
  The variable or macro names used in the task can be generic, you can update them with corresponding variable or macro names as per your blueprint.
5. To update the variable or macro names, click Apply .
6. To copy the task, click Copy .
On the Service tab, configure the following.
1. In the Deployment Config pane, enter the number of default, minimum and maximum service replicas that you want to create in the Default , Min , and Max fields respectively.
  The Min and Max fields define the scale-in and scale-out actions. The scale-in and scale-out actions cannot scale beyond the defined minimum and maximum numbers. The default field defines the number of default replicas the service creates.
  
  If there is an array of three VMs, define the minimum number as three.
2. In the Variables section, click the + icon to add variable types to your blueprint.
3. In the Name field, enter a name for the variable.
4. From the Data Type list, select one of the base type variable or import a custom library variable type.
5. If you have selected a base type variable, configure all the variable parameters. For more information about configuring variable parameters, see Creating Variable Types.
6. If you have imported a custom variable type, all the variable parameters are auto filled.
7. Select the Secret check box if you want to hide the value of the variable.
Add credentials to the blueprint. For more information, see Adding Credentials.
Click Save on the Blueprint Editor page.
The blueprint is saved and listed on the Blueprints page.

What to do next

Define the service dependencies. See Setting up the Service Dependencies.

Configuring VMware VM, Package, and Service

You can define the underlying infrastructure of the VM, application details, and actions that are carried out on a blueprint until the termination of the application on a VMware platform.

Before you begin

Ensure that you complete the pre-configuration requirements. See Creating a Multi-VM Blueprint.
Ensure that you have created a project and configured an environment for VMware. For more information, see Creating a Project and Configuring VMware Environment.
You need licenses for both Compute and Storage distributed resource scheduler (DRS) in order to use the VMware DRS mode.
Ensure that storage DRS is enabled and set to fully automated in vCenter.

Procedure

Perform the basic blueprint setup, and add a service. For more information, see Adding a Service.

Figure. Blueprint Configuration Click to enlarge
Enter a name of the service in the Service Name field.
On the VM tab, enter the name of the VM in the Name field.
Select VMware from the Account list.

Note: The account options depend on the project you selected while setting up the blueprint.
Select Windows or Linux from the Operating System list.
(Optional) If you have configured an environment during the project creation, then click Clone from environment to autofill the VM configuration details.
The Clone from environment option appears only when you select a specific environment you configured for the account from the Environment list in the application profile. The option does not appear if you select All Project Accounts as your environment.

You can also click the View Configuration option to review the configuration details before cloning the environment.
Select the Compute DRS Mode check box to enable load sharing and automatic VM placement.
Distributed Resource Scheduler (DRS) is a utility that balances computing workloads with available resources in a virtualized environment. For more information about DRS mode, see the VMware documentation .
- If you selected Compute DRS Mode , then select the cluster where you want to host your VM from the Cluster list.
- If you have not selected Compute DRS Mode , then select the host name of the VM from the Host list.
Do one of the following:
- Select the VM Templates radio button and then select a template from the Template list.
  Templates allow you to create multiple virtual machines with the same characteristics, such as resources allocated to CPU and memory or the type of virtual hardware. Templates save time and avoid errors when configuring settings and other parameters to create VMs. The VM template retrieves the list options from the configured vCenter.
  Note:
  - Install the VMware Tools on the Windows templates. For Linux VMs, install Open-vm-tools or VMware-tools and configure the Vmtoolsd service for automatic start-up.
  - Support for Open-vm-tools is available. When using Open-vm-tools , install Perl for the template.
  - Do not use SysPrepped as the Windows template image.
  - If you select a template that has unsupported version of VMware Tools, then a warning appears stating VMware tool or version is unsupported and could lead to VM issues .
  - You can also edit the NIC type when you use a template.
  For more information, refer to VMware KB articles.
- Select the Content Library radio button, a content library in the Content Library list, and then select an OVF template or VM template from the content library.
  A content library stores and manages content (VMs, vApp templates, and other types of files) in the form of library items. A single library item can consist of one file or multiple files. For more information about the vCenter content library, see the VMware Documentation .
  
  Caution: Content Library support is currently a technical preview feature in Calm. Do not use any technical preview features in a production environment.
If you want to use the storage DRS mode, then select the Storage DRS Mode check box and a datastore cluster from the Datastore Cluster list.
The datastore clusters are referred as storage pod in vCenter. A datastore cluster is a collection of datastores with shared resources and a shared management interface.
If you do not want to use storage DRS mode, then do not select the Storage DRS Mode check box, and select a datastore from the Datastore list.
In the VM Location field, specify the location of the folder in which the VM must be created when you deploy the blueprint. Ensure that you specify a valid folder name already created in your VMware account.
To create a subfolder in the location you specified, select the Create a folder/directory structure here check box and specify a folder name in the Folder/Directory Name field.

Note: Calm gives preference to the VM location specified in the environment you select while launching an application. For example, you specify a subfolder structure as the VM location in the blueprint and the top-level folder in the environment. When you select this environment while launching your application, Calm considers the VM location you specified in the environment and creates the VM at the top-level folder.

Select the Delete empty folder check box to delete the subfolder created within the specified location, in case the folder does not contain any VM resources. This option helps you to keep a clean folder structure.
Enter the instance name of the VM in the Instance Name field.
This field is pre-populated with a macro as suffix to ensure name uniqueness. The service provider uses this name as the VM name.
Under Controllers , click the + icon to add the type of controller.
You can select either SCSI or SATA controller. You can add up to three SCSI and four SATA controllers.
Under the Disks section, click the + icon to add vDisks and do the following:
1. Select the device type from the Device Type list.
  You can either select CD-ROM or DISK .
2. Select the adapter type from the Adapter Type list.
  You can select IDE for CD-ROM.
  
  You can select SCSI , IDE , or SATA for DISK.
3. Enter the size of the disk in GiB.
4. In the Location field, select the disk location.
5. If you want to add a controller to the vDisk, select the type of controller in the Controller list to attach to the disk.
  
  Note: You can add either SCSI or SATA controllers. The available options depend on the adapter type.
6. In the Disk mode list, select the type of the disk mode. Your options are:
  - Dependent : Dependent disk mode is the default disk mode for the vDisk.
  - Independent - Persistent : Disks in persistent mode behave like conventional disks on your physical computer. All data written to a disk in persistent mode are written permanently to the disk.
  - Independent - Nonpersistent : Changes to disks in nonpersistent mode are discarded when you shut down or reset the virtual machine. With nonpersistent mode, you can restart the virtual machine with a virtual disk in the same state every time. Changes to the disk are written to and read from a redo log file that is deleted when you shut down or reset.
You can also mark the vDisks runtime editable so you can add, delete, or edit the vDisks while launching the blueprint. For more information about runtime editable attributes, see Runtime Variables Overview.
Under the Tags section, select tags from the Category: Tag pairs field.
You can assign tags to your VMs so you can view the objects associated with your VMs in your VMware account. For example, you can create a tag for a specific environment and assign the tag to multiple VMs. You can then view all the VMs that are associated with the tag.
(Optional) If you want to customize the default OS properties of the VM, then click the Enable check box under VM Guest Customization and select a customization from the Predefined Guest Customization list.
If you do not have any predefined customization available, select None .
Select Cloud-init or Custom Spec .
If you selected Cloud-init , enter or upload the script in the Script field.
If you have selected Custom Spec , enter the details for the VM in the following fields:
1. Enter the hostname in the Hostname field.
2. Enter the domain in the Domain field.
3. Select timezone from the Timezone list.
4. Select Hardware clock UTC check box to enable hardware clock UTC.
5. Click the + icon to add network settings.
  To automatically configure DHCP server, enable the Use DHCP check box and then skip to the DNS Setting section.
6. Enter a name for the network configuration you are adding to the VM in the Setting name field.
  Settings name is the saved configuration of your network that you want to connect to your VM.
7. Enter values in the IP Address , Subnet Mask , Default Gateway , and Alternative Gateway fields.
8. Under the DNS Settings section, enter the DNS primary, DNS secondary, DNS tertiary, and DNS search path name.
Configure the connection in your blueprint. For more information, see Configuring Check Log-In.
On the Package tab, enter the package name in the Package Name field.
1. Click one of the following:
  - Configure install : To create a task to install a package.
  - Configure uninstall : To create a task to uninstall a package.
2. In the Blueprint Canvas, click + Task .
  
  Figure. Package Click to enlarge
3. Enter the task name in the Task Name field.
To create a task, select the type of task from the Type list.
The available options are:
- Execute : To create the Execute type of task, see Creating an Execute Task.
- Set Variable : To create the set variable type of task, see Creating a Set Variable Task.
- HTTP : To create the HTTP task type, see Creating an HTTP Task.
- Delay : To create the Delay task type, see Creating a Delay Task.
For Execute and Set Variable tasks, you can use endpoints as targets for script execution. For more information, see Endpoints Overview.
To reuse a task from the task library, do the following.
1. Click Browse Library .
2. Select the task from the task library.
  When you select a task, the task inspector panel displays the selected task details.
3. Click Select .
4. Optionally, edit the variable or macro names as per your blueprint.
  The variable or macro names used in the task can be generic, you can update them with corresponding variable or macro names as per your blueprint.
5. To update the variable or macro names, click Apply .
6. To copy the task, click Copy .
On the Service tab, configure the following.
1. In the Deployment Config pane, enter the number of default, minimum and maximum service replicas that you want to create in the Default , Min , and Max fields respectively.
  The Min and Max fields define the scale-in and scale-out actions. The scale-in and scale-out actions cannot scale beyond the defined minimum and maximum numbers. The default field defines the number of default replicas the service creates.
  
  If there is an array of three VMs, define the minimum number as three.
2. In the Variables section, click the + icon to add variable types to your blueprint.
3. In the Name field, enter a name for the variable.
4. From the Data Type list, select one of the base type variable or import a custom library variable type.
5. If you have selected a base type variable, configure all the variable parameters. For more information about configuring variable parameters, see Creating Variable Types.
6. If you have imported a custom variable type, all the variable parameters are automatically filled.
7. Select the Secret check box if you want to hide the value of the variable.
Add credentials to the blueprint. For more information, see Adding Credentials.
Click Save on the Blueprint Editor page.

What to do next

Define the service dependencies. See Setting up the Service Dependencies.

Supported VMware Guest Tools Versions

To know the supported VMware guest tools versions, see the

VMware Product Interoperability Matrices .

Configuring GCP VM, Package, and Service

You can define the underlying infrastructure of the VM, application details, and actions that are carried out on a blueprint until the termination of the application on a GCP platform.

Before you begin

Ensure that you complete the pre-configuration requirements. See Creating a Multi-VM Blueprint.
Ensure that you have created a project and configured an environment for AWS. For more information, see Creating a Project and Configuring GCP Environment.

Procedure

Perform the basic blueprint setup, and add a service. For more information, see Adding a Service.

Figure. Blueprint Configuration Click to enlarge
Enter a name of the service in the Service Name field.
On the VM tab, enter the name of the VM in the Name field.
Select a GCP account from the Account list.

Note: The account options depend on the selected project while setting up the blueprint.
Select Windows or Linux from the Operating System list.
(Optional) If you have configured an environment during the project creation, then click Clone from environment to autofill the VM configuration details.
The Clone from environment option appears only when you select a specific environment you configured for the account from the Environment list in the application profile. The option does not appear if you select All Project Accounts as your environment.

You can also click the View Configuration option to review the configuration details before cloning the environment.
(Optional) Edit the VM name in the Instance Name field.
This field is pre-populated with a macro as suffix to ensure name uniqueness. The service provider uses this name as the VM name.
Select a zone from the Zone list.
A zone is a physical location where you can host the VM.
Select the type of machine from the Machine type list.
The machine types are available based on your zone. A machine type is a set of virtualized hardware resources available to a virtual machine (VM) instance, including the system memory size, virtual CPU (vCPU) count, and persistent disk limits. In Compute Engine, machine types are grouped and curated by families for different workloads.
Under the DISKS section, click the + icon to add a disk.
You can also mark the added vDisks runtime editable so you can add, delete, or edit the vDisks while launching the blueprint. For more information about runtime editable attributes, see Runtime Variables Overview.
To use an existing disk configuration, select the Use existing disk check box, and then select the persistent disk from the Disk list.
If you have not selected the Use existing disk check box, then do the following:
1. Select the type of storage from the Storage Type list. The available options are as follows.
  - pd-balanced : Use this option as an alternative to SSD persistent disks with a balanced performance and cost.
  - pd-extreme : Use this option to use SSD drives for high-end database workloads. This option has higher maximum IOPS and throughput and allows you to provision IOPS and capacity separately.
  - pd-ssd : Use this option to use SSD drives as your persistent disk.
  - pd-standard : Use this option to use HDD drives as your persistent disk.
  The persistent disk types are durable network storage devices that your instances can access like physical disks in a desktop or a server. The data on each disk is distributed across several physical disks.
2. Select the image source from the Source Image list.
  The images available for your selection are based on the selected zone.
3. Enter the size of the disk in GB in the Size in GB field.
4. To delete the disk configuration after the instance is deleted, select the Delete when instance is deleted check box under the Disks section.
To add a blank disk, click the + icon under the Blank Disks section and configure the blank disk.
To add networking details to the VM, click the + icon under the Networking section.
To configure a public IP address, select the Associate Public IP address check box and configure the following fields.
1. Select the network from the Network list and the sub network from the Subnetwork list.
2. Enter a name of the network in the Access configuration Name field and select the access configuration type from the Access configuration type list.
  These fields appear when you select the Associate public IP Address check box.
To configure a private IP address, clear the Associate Public IP address check box and select the network and sub network.
Under the SSH Key section, click the + icon and enter or upload the username key data in the Username field.
Select Block project-wide SSH Keys to enable blocking project-wide SSH keys.
Under the Management section, do the following:
1. Enter the metadata in the Metadata field.
2. Select the security group from the Network Tags list.
  Network tags are text attributes you can add to VM instances. These tags allow you to make firewall rules and routes applicable to specific VM instances.
3. Enter the key-value pair in the Labels field.
  A label is a key-value pair that helps you organize the VMs created with GCP as the provider. You can attach a label to each resource, then filter the resources based on their labels.
Under the API Access section, do the following:
1. Specify the service account in the Service Account field.
2. Under Scopes, select Default Access or Full Access .
Configure the connection in your blueprint. For more information, see Configuring Check Log-In.
On the Package tab, enter the package name in the Name field.
1. Click one of the following:
  - Configure install : To create a task to install a package.
  - Configure uninstall : To create a task to uninstall a package.
2. In the Blueprint Canvas, click + Task .
  
  Figure. Package Click to enlarge
3. Enter the task name in the Task Name field.
To create a task, select the type of task from the Type list.
The available options are:
- Execute : To create the Execute task type, see Creating an Execute Task.
- Set Variable : To create the Set Variable task type, see Creating a Set Variable Task.
- HTTP : To create the HTTP Task type, see Creating an HTTP Task.
- Delay : To create the Delay task type, see Creating a Delay Task.
For Execute and Set Variable tasks, you can use endpoints as targets for script execution. For more information, see Endpoints Overview.
To reuse a task from the task library, do the following.
1. Click Browse Library .
2. Select the task from the task library.
  When you select a task, the task inspector panel displays the selected task details.
3. Click Select .
4. Optionally, edit the variable or macro names as per your blueprint.
  The variable or macro names used in the task can be generic, you can update them with corresponding variable or macro names as per your blueprint.
5. To update the variable or macro names, click Apply .
6. To copy the task, click Copy .
On the Service tab, configure the following.
1. In the Deployment Config pane, enter the number of default, minimum and maximum service replicas that you want to create in the Default , Min , and Max fields respectively.
  The Min and Max fields define the scale-in and scale-out actions. The scale-in and scale-out actions cannot scale beyond the defined minimum and maximum numbers. The default field defines the number of default replicas the service creates.
  
  If there is an array of three VMs, define the minimum number as three.
2. In the Variables section, click the + icon to add variable types to your blueprint.
3. In the Name field, enter a name for the variable.
4. From the Data Type list, select one of the base type variable or import a custom library variable type.
5. If you have selected a base type variable, configure all the variable parameters. For more information about configuring variable parameters, see Creating Variable Types.
6. If you have imported a custom variable type, all the variable parameters are auto filled.
7. Select the Secret check box if you want to hide the value of the variable.
Add credentials to the blueprint. For more information, see Adding Credentials.
Click Save on the Blueprint Editor page.
The blueprint is saved and listed under blueprints tab.

What to do next

Define the service dependencies. See Setting up the Service Dependencies.

Configuring Azure VM, Package, and Service

You can define the underlying infrastructure of the VM, application details, and actions that are carried out on a blueprint until the termination of the application on an Azure platform.

Before you begin

Ensure that you have configured the following entities in the Azure account.
- Resource Group
- Availability set
- Network Security Group
- Virtual Network
- Vault Certificates
Ensure that you complete the pre-configuration requirements. See Creating a Multi-VM Blueprint.
Ensure that you have created a project and configured an environment for Azure. For more information, see Creating a Project and Configuring Azure Environment.

Procedure

Perform the basic blueprint setup, and add a service. For more information, see Adding a Service.

Figure. Blueprint Configuration Click to enlarge
Enter a name of the service in the Service Name field.
Under the VM tab, enter the name of the VM in the Name field.
Select Azure from the Account list.

Note: The account options depend on the selected project while creating the blueprint.
Select Windows or Linux from the Operating System list.
(Optional) If you have configured an environment during the project creation, then click Clone from environment to autofill the VM configuration details.
The Clone from environment option appears only when you select a specific environment you configured for the account from the Environment list in the application profile. The option does not appear if you select All Project Accounts as your environment.

You can also click the View Configuration option to review the configuration details before cloning the environment.
Edit the VM name in the Instance Name field.
This field is pre-populated with a macro as suffix to ensure name uniqueness. The service provider uses this name as the VM name.
Select a resource group from the Resource Group list or select the Create Resource Group check box to create a resource group.
Each resource in Azure must belong to a resource group. A resource group is simply a logical construct that groups multiple resources together so you can manage the resources as a single entity. For example, you can create or delete resources as a group that share a similar life cycle, such as the resources for an n-tier application.

The Resource Group list displays the resource groups that are associated with the subscriptions you selected in your Azure account. In case you have not selected any subscriptions, Calm considers all the subscriptions that are available in the Azure service principal to display the resource groups. Each resource group in the list also displays the associated subscription.
If you selected a resource group from the Resource Group list, then do the following:
1. Select the geographical location of the datacenter from the Location list.
2. Select Availability Sets or Availability Zones from the Availability Option list.
  You can then select an availability set or availability zone. An availability set is a logical grouping capability to ensure that the VM resources are isolated from each other to provide High Availability if deployed within an Azure datacenter. An availability zone allows you to deploy your VM into different datacenters within the same region.
3. Select the hardware profile as per your hardware requirements from the Hardware Profile list.
  The number of data disks and NICs depends upon the selected hardware profile. For information about the sizes of Windows and Linux VMs, see Windows and Linux Documentation.
If you selected the Create Resource Group check box to create a resource group, then do the following:
1. Select a subscription associated to your Azure account in the Subscription field.
2. Enter a unique name for the resource group in the Name field.
3. Select the geographical location of the datacenter that you want to add to the resource group in the Location list.
4. Under Tags , enter a key and value pair in the Key and Value fields respectively.
  Tags are key and value pairs that enable you to categorize resources. You can apply a tag to multiple resource groups.
5. If you want to automatically delete a resource group that has empty resources while deleting an application, click the Delete Empty Resource Group check box.
6. Specify the location and hardware profile.
Under the Secrets section, click the + icon and do the following:
1. Enter a unique vault ID in the Vault ID field.
2. Under Certificates , click the + icon.
3. Enter the URL of the configuration certificate in the URL field.
  The URL of the certificate is uploaded to the key vault as a secret.
4. Enter store in the Store field.
  - For Windows VMs, the Store field specifies the certificate store on the virtual machine to which the certificate is added. The specified certificate store is implicitly created in the LocalMachine account.
  - For Linux VMs, the certificate file is placed under the /var/lib/waagent directory. The format of the file name is <UppercaseThumbprint>.crt for the X509 certificate and <UppercaseThumbpring>.prv for private key. Both of these files are .pem formatted.
(For Windows) Select the Provision Windows Guest Agent check box.
This option indicates whether or not to provision the virtual machine agent on the virtual machine. When this property is not specified in the request body, the default behavior is to set it to true. This ensures that the VM Agent is installed on the VM, and the extensions can be added to the VM later.
(For Windows) To indicate that the VM is enabled for automatic updates, select the Automatic OS Upgrades check box.
Under the Additional Unattended Content section, click the + icon and do the following:
1. Select a setting from the Setting Name list.
  You can select Auto Logon or First Logon Commands .
  Note: Guest customization is applicable only on images that allows or support guest customization.
2. Enter or upload the xml content. See Sample Auto Logon and First Logon Scripts.
Under the WinRM Listeners section, click the + icon and do the following:
1. Select the protocol from the Protocol list.
  You can select HTTP or HTTPS .
2. If you selected HTTPS, then select the certificate URL from the Certificate URL list.
Under the Storage Profile section, select the Use Custom Image check box to use a custom VM image created in your subscription.
You can then select a custom image or publisher-offer-SKU-version from the Custom Image list.
Under the VM Image Details section, select an image type in the Source Image Type list.
You can select Marketplace , Subscription , or Shared Image Gallery .
- If you selected Marketplace , then specify the publisher, offer, SKU, and version for the image.
- If you selected Subscription , then select the custom image.
- If you selected Shared Image Gallery , then select the gallery and the image.
Under the OS Disk Details section, do the following:
1. Select the storage type from the Storage Type list.
  You can select Standard HDD , Standard SSD , or Premium SSD .
2. Select a disk storage account from the Disk Storage list.
  This field is available only when the Use Custom Image check box is enabled.
3. Select disk caching type from the Disk Caching Type list.
  You can select None , Read-only , or Read write .
4. Select disk create option from the Disk Create Option list.
  You can select Attach , Empty , or From Image .
Under the Data Disk section, do the following:
1. Select the storage type from the Storage Type list.
  You can select Standard HDD , Standard SSD , or Premium SSD .
2. Select disk caching type from the Disk Caching Type list.
  You can select None , Read-only , or Read write .
3. Enter the size in GB in the Size field.
4. Enter disk logical unit number (LUN) in the Disk LUN field.
  
  Note: The LUN value should be unique across data disk list.
Under the Network Profile section, add NICs as per your requirement and do the following for each NIC:
1. Select a security group from the Security Group list.
2. Select a virtual network from the Virtual Network list.
3. Under Public IP Config , enter a name and select an allocation method.
4. Under Private IP Config , select an allocation method.
  If you selected Static as the allocation method, then enter the private IP address in the IP Address field.
Optionally, enter tags in the Tags field.
Configure the connection in your blueprint. For more information, see Configuring Check Log-In.
On the Package tab, enter the package name in the Name field.
1. Click one of the following:
  - Configure install : To create a task to install a package.
  - Configure uninstall : To create a task to uninstall a package.
2. In the Blueprint Canvas, click + Task .
  
  Figure. Package Click to enlarge
3. Enter the task name in the Task Name field.
To create a task, select the type of task from the Type list.
The available options are:
- Execute : To create the execute type of task, see Creating an Execute Task.
- Set Variable : To create the set variable type of task, see Creating a Set Variable Task.
- HTTP : To create the HTTP Task type, see Creating an HTTP Task.
- Delay : To create the Delay task type, see Creating a Delay Task.
For Execute and Set Variable tasks, you can use endpoints as targets for script execution. For more information, see Endpoints Overview.
Select the script from the Script Type list.
For shell, PowerShell, and eScript scripts, you can access the available list of macros by using @@{ .

Note: Azure library SDK support is available for eScripts.
To reuse a task from the library do the following.
1. Click Browse Library .
2. Select the task from the library.
  When you select a task, the task inspector panel displays the selected task details.
3. Click Select .
4. Optionally, edit the variable or macro names as per your blueprint.
  The variable or macro names used in the task can be generic, you can update them with corresponding variable or macro names as per your blueprint.
5. Click Apply to update the variable or macro names.
6. Click Copy to copy the task.
On the Service tab, configure the following.
1. In the Deployment Config pane, enter the number of default, minimum and maximum service replicas that you want to create in the Default , Min , and Max fields respectively.
  The Min and Max fields define the scale-in and scale-out actions. The scale-in and scale-out actions cannot scale beyond the defined minimum and maximum numbers. The default field defines the number of default replicas the service creates.
  
  If there is an array of three VMs, define the minimum number as three.
2. In the Variables section, click the + icon to add variable types to your blueprint.
3. In the Name field, enter a name for the variable.
4. From the Data Type list, select one of the base type variables or import a custom library variable type.
5. If you have selected a base type variable, configure all the variable parameters. For more information about configuring variable parameters, see Creating Variable Types.
6. If you have imported a custom variable type, all the variable parameters are automatically filled.
7. Select the Secret check box if you want to hide the value of the variable.
8. In the Port List pane, enter the name, protocol, and port number in the Name , Protocol , and Port fields.
Add credentials to the blueprint. For more information, see Adding Credentials.
Click Save on the Blueprint Editor page.
The blueprint is saved and listed under blueprints tab.

What to do next

Define the service dependencies. See Setting up the Service Dependencies.

Azure Troubleshooting

The following section describes Azure troubleshooting.

For settings save or verification failure, you can check the logs at the following location.
/home/calm/log/styx.log
For application blueprints save failure, you can check the logs at the following locations.
- /home/calm/log/hercules_*.log
- /home/calm/log/styx.log
For provisioning failure, you can check the logs at the following locations.
- Task logs on UI
- /home/epsilon/log/indra_*.log [Signature: Encountered ERROR]
- /home/epsilon/log/durga_*.log
- /home/epsilon/log/arjun_*.log
- /home/calm/log/hercules_*.log
- /home/calm/log/styx.log

Configuring Xi VM, Package, and Service

You can define the underlying infrastructure of the VM, application details, and actions that are carried out on a blueprint until the termination of the application on Xi cloud provider.

Before you begin

Ensure that you have configured DNS in the VPC section in the Xi Cloud dashboard in the Prism Central.

Procedure

Perform the basic blueprint setup, and add a service. For more information, see Adding a Service.
Enter a name of the service in the Service Name field.
On the VM tab, enter the name of the VM in the Name field.
Select Xi from the Account list.

Note: The account options depend on the project you selected while setting up the blueprint.

The Availability Zone field is automatically filled.
Select Windows or Linux from the Operating System list.
Under VM Configuration , enter the instance name of the VM in the VM Name field. This field displays the macro as suffix to ensure name uniqueness.
The service provider uses this name as the VM name.
In the vCPUs field, enter the required number of vCPUs for the VM.
In the Cores per vCPU field, enter the number of cores per vCPU for the VM.
In the Memory field, enter the required memory in GiB for the VM.
(Optional) If you want to customize the default OS properties of the VM, select the Guest Customization check box and do the following.
Guest customization allows you to upload custom scripts to modify the properties of the OS of the VM.
1. Select Cloud-init or SysPrep type and enter the script in the Script panel.
  Note:
  - Select Cloud-init for Linux and Sysprep for Windows. For Sysprep, you must use double back slash for all escape characters . For example, \\v.
  - You can also upload the script by clicking the upload icon.
2. For Sysprep script, click Join a Domain check box and configure the following fields.
  - Domain Name : Enter the domain name of the Windows server.
  - Credentials : From the Credentials list, enter a credential for the Windows VM. You can also create new credentials. For more information, see step 22.
  - DNS IP : Enter the IP address of the DNS server.
  - DNS Search Path : Enter the DNS search path for the domain.
To add a vDisk, click + vDisks and do the following.
1. Select the device type from the Device Type list.
  You can select CD-ROM or Disk .
2. Select the device bus from the Device Bus list.
  You can select IDE or SATA for CD-ROM .
  
  You can select SCSI , IDE , PCI , or SATA for Disk .
3. Enter the size of the vDisk in GiB.
You can also make the vDisks as runtime editable. If you have marked the vDisk attribute as runtime editable, you can add, delete, or edit vDisks while launching the blueprint. For more information about runtime editable attributes, see Runtime Variables Overview.
Select categories from the Categories list.

Note: Categories field allows you to tag your VM to a defined category in the Prism Central. Based on the Prism Central configuration, the list options are available.
Under Network , select the VPC from the VPC list. For more information about VPC, see Xi Infrastructure Service Admininistration Guide.
Configure the connection in your blueprint. For more information, see Configuring Check Log-In.
Under the Package tab, enter the package name in the Name field.
1. Click one of the following:
  - Configure install : To create a task to install a package.
  - Configure uninstall : To create a task to uninstall a package.
2. In the Blueprint Canvas, click + Task .
  
  Figure. Package Click to enlarge
3. Enter the task name in the Task Name field.
If you want to create a task, select the type of task from the Type list.
The available options are:
- Execute : To create the Execute task type, see Creating an Execute Task.
- Set Variable : To create the Set Variable task type, see Creating a Set Variable Task.
- HTTP : To create the HTTP Task type, see Creating an HTTP Task.
- Delay : To create the Delay task type, see Creating a Delay Task.
(Optional) To reuse a task from the task library, do the following.
1. Click Browse Library .
2. Select the task from the task library.
  When you select a task, the task inspector panel displays the selected task details.
3. Click Select .
4. (Optional) Edit the variable or macro names as per your blueprint.
  The variable or macro names used in the task can be generic, you can update them with corresponding variable or macro names as per your blueprint.
5. To update the variable or macro names, click Apply .
6. To copy the task, click Copy .
On the Service tab, configure the following.
1. In the Deployment Config pane, enter the number of default, minimum and maximum service replicas that you want to create in the Default , Min , and Max fields respectively.
  The Min and Max fields define the scale-in and scale-out actions. The scale-in and scale-out actions cannot scale beyond the defined minimum and maximum numbers. The default field defines the number of default replicas the service creates.
  
  If there is an array of three VMs, define the minimum number as three.
2. In the Variables section, click the + icon to add variable types to your blueprint.
3. In the Name field, enter a name for the variable.
4. From the Data Type list, select one of the base type variables or import a custom library variable type.
5. If you have selected a base type variable, configure all the variable parameters. For more information about configuring variable parameters, see Creating Variable Types.
6. If you have imported a custom variable type, all the variable parameters are auto filled.
7. Select the Secret check box if you want to hide the value of the variable.
Click Save on the Blueprint Editor page.
The blueprint is saved and listed under blueprints tab.

Configuring Kubernetes Deployment, Containers, and Service

Perform the following procedure to configure Kubernetes Deployment, Containers, and Service.

Before you begin

Ensure that you have completed the pre-configuration requirements. See Creating a Multi-VM Blueprint.
Ensure that the selected project has Kubernetes or GCP with GKE enabled or both as part of it.
Refer Kubernetes Documentation to get detailed information about the kubernetes attributes and configuration.

Procedure

To add a service to the blueprint, see Adding a Service.
To add a Pod, click + against the Pod .

A Pod is the basic execution unit of a Kubernetes application and the smallest and simplest unit in the Kubernetes object model that you create or deploy. A Pod represents processes running on your cluster.

The Pod service inspector panel appears.
Enter a name of the pod in the Pod Name field.
Under the Deployment tab, select the account from the Account list. All the accounts added to the project are available for selection.
Optionally, edit the Calm deployment name in the Calm Deployment Name field.
This filed is auto-populated.
Optionally, edit the K8s deployment name in the K8s Deployment Name field.
This filed is automatically populated.
Enter namespace in the Namespace field.
Namespace is a kubernetes field to use in environments with many users spread across multiple teams, or projects.
Enter the number of replicas in the Replica field.
Optionally, enter annotations in the Annotations field.
You can use kubernetes annotations to attach arbitrary non-identifying metadata to objects.
Enter selector in the Selectors field.
The selector field defines how the Deployment finds which pods to manage.
Enter label in the Label field.

Labels are key/value pairs that are attached to objects, such as pods. You can use Labels to specify identifying attributes of objects that are meaningful and relevant to users, but do not directly imply semantics to the core system. You can also use Labels to organize and to select subsets of objects. You can attach Labels to objects either at the creation time or later. Each object can have a set of key/value labels defined. Each key must be unique for a given object.
Optionally, you can edit the pod name in the K8s Pod Name field.
This field is auto-populated.
Enter value of image pull secrets in the Image Pull Secrets field.
You can provide the list of secret names (pre-configured in a Kubernetes cluster by using Kubernetes Docker secret object) to be use by Kubernetes cluster to pull the container images from registries that require authentication.
Select DNS policy from the DNS Policy list.
Under Containers tab, optionally edit the Calm service name in the Calm Service Name field.
Optionally, you can edit the K8s service name in the K8s Service Name field.
This field is auto-populated.
Enter arguments for the container in the Args field.
Enter Docker image in the Image field.
Select a value from the Image Pull Policy .
You can either select Never or Always or IfNotPresent (default).
Under Pre Stop Lifecycle , select an action.
You can select None (default) or Exec or HTTP Get Action or TCP Socket .

This hook is called immediately before a container is terminated. It is blocking, meaning it is synchronous, so it must complete before the call to delete the container can be sent. No parameters are passed to the handler.
Under Post Stop Lifecycle , select an action.
You can select None (default) or Exec or HTTP Get Action or TCP Socket .

This hook runs immediately after a container is created. However, there is no guarantee that the hook runs before the container ENTRYPOINT. No parameters are passed to the handler.
Under Container Port , enter the port number in the Port field.
1. Enter name of the port in the Name field.
2. Select protocol from the Protocol list.
  You can either select TCP or UDP .
Under Readiness Probe , enter command in the Command field.
The kubelet uses readiness probes to know when a Container is ready to start accepting traffic. A pod is ready after all of its Containers are ready. One use of this signal is to control the pods used as backends for Services. When a pod is not ready, it is removed from Service load balancers.
Under Resource Limit , enter the cores per CPU in the CPU field.
When you specify a pod, you can optionally specify how much CPU and memory (RAM) each Container needs. CPU and memory are each a resource type. A resource type has a base unit. You can specify CPU in units of cores and memory in bytes.
1. Enter the bytes of memory in the Memory field.
Under Resource Request , enter the termination message path in the Termination Message Path field.
Termination messages provide a way for containers to write information about fatal events to a location where you can easily retrieve and surface these events by tools like dashboards and monitoring software.
Under Service tab, optionally you can edit the Calm Published Service Name field.
Optionally, you can edit the K8s Service Name field.
Select a service type from the Service Type list. You can select one of the following.
- ClusterIP : Exposes the service on a cluster-internal IP. Choosing this value makes the Service only reachable from within the cluster.
- NodePort : Exposes the service on each node's IP at a static port (the NodePort ). A ClusterIP Service, to which the NodePort Service routes, is automatically created. You'll be able to contact the NodePort Service, from outside the cluster, by requesting <NodeIP>:<NodePort> .
- LoadBalancer : Exposes the service externally using a cloud provider's load balancer. NodePort and ClusterIP Services, to which the external load balancer routes, are automatically created.
Enter namespace in the Namespace field.
You can use Namespaces in environments with many users spread across multiple teams, or projects.
Enter label in the Label field.

Labels are key/value pairs that are attached to objects, such as pods. You can use Labels to specify identifying attributes of objects that are meaningful and relevant, but do not directly imply semantics to the core system. You can also use Labels to organize and select subsets of objects. You can attach Labels to objects at creation time and add or modify at any time. Each object can have a set of key/value labels defined. Each key must be unique for a given object.
Enter selector in the Selectors field.
The selector field defines how the Deployment finds which pods to manage.
Under Port List , enter the port name in the Port Name field.
1. Enter node port in the Node Port field.
2. Enter port number in the Port field.
3. Select protocol from the Protocol list.
  You can either select TCP or UDP .
4. Enter the target port in the Target Port field.
To upload the POD specification file in .JSON or .YAML format from your local machine, click against the icon next to the Pod Name field and upload the specification file.
You can also download the POD specification file in .JSON or .YAML format.
To edit the uploaded POD specification, click the Spec Editor toggle button and click Edit .
The Script Editor page is displayed. You can edit the specification file in .YAML or .JSON format.
To save the edited POD specification file, click Done .
Click Save .
The blueprint is saved and listed under blueprints tab.

What to do next

Define the service dependencies. See Setting up the Service Dependencies.

Setting up the Service Dependencies

Dependencies are used to define the order in which tasks must get executed. Perform the following procedure to set up the service dependency.

Before you begin

Ensure that at least more than one service must be available. See Adding a Service.
Ensure that you have completed the pre-configuration requirements. See Creating a Multi-VM Blueprint.

Procedure

Select the service.
Select the dependency icon and drag to the service on which you want to create the dependency.

Figure. Create Dependency Click to enlarge

What to do next

Configure the application profile. See Adding and Configuring an Application Profile.

Adding and Configuring an Application Profile

An application profile provides different combinations of the service, package, and VM while configuring a blueprint. You configure application profiles and use them while launching a blueprint.

Before you begin

Ensure that you have completed the pre-configuration requirements. See Creating a Multi-VM Blueprint.

Procedure

To create an application profile, click the + icon next to Application Profile in the Overview Panel.

Figure. Application Profile Click to enlarge
In the Inspector Panel, enter the name of the application profile in the Application Profile Name field.
Optionally, select an environment for the application profile from the Environment list.
The environment available for the selection in the Environment list depends on the project you selected in the Blueprint Setup window. If you selected a default environment while configuring your environments for the project, the default environment automatically appears in the Environment list. You can select a different environment if required.
Click the + icon next to Variables .
Enter a name for the variable in the Name field.
Select a data type from the Data Type list. You can select one of the following data type:
- String
- Integer
- Multi-line string
- Date
- Time
- Date Time
Enter a value for the selected data type in the Value field.
You can select the Secret check box to hide the variable value.
Click Show Additional Options .
In the Input Type field, select one of the following input type:
- Simple: Use this option for default value.
- Predefined: Use this option to assign static values.
- eScript: Use this option to attach a script that is run to retrieve values dynamically at runtime. Script can return single or multiple values depending on the selected base data type.
- HTTP: Use this option to retrieve values dynamically from the defined HTTP end point. Result is processed and assigned to the variable based on the selected base data type.
If you have selected Simple , enter the value for the variable in the Value field.
If you have selected Predefined , enter the value for the variable in the Option field.
1. To add multiple values for the variable, click + Add Option , and enter values in the Option field.
  
  Note: To make any value as default, select the Default radio button for the option.
If you have selected eScript , enter the eScript in the field.
You can also upload the script from the library or from the computer by clicking the upload icon.

You can also publish the script to the library by clicking the publish button.
Note:
- You cannot add macros to eScripts.
- If you have selected Multiple Input (Array) check box with input type as eScript, then ensure that the script returns a list of values separated by comma. For example, CentOS, Ubuntu, Windows.
If you have selected HTTP , configure the following fields.
- Request URL : In the Request URL field, enter the URL of the server that you want to run the methods on.
- Request Method : In the Request Method list, select one of the following request methods. The available options are GET, PUT, POST, and DELETE.
- Request Body : In the Request Body field, enter the PUT request. You can also upload the PUT request by clicking the upload icon.
- Content Type : In the Content Type list, select the type of the output format. The available options are XML , JSON, and HTML.
- Connection Timeout (sec) : In the Connection Timeout (sec) field, enter the timeout interval in seconds.
- Authentication : Optionally, if you have selected authentication type as BASIC, enter the user name and the password in the User name and Password fields respectively.
- SSL Certificate Verification : If you want to verify SSL certificate for the task, click the SSL Cerificate Verification field.
- Retry Count : Enter the number of attempts the system performs to create a task after each failure. By default, the retry count is zero. It implies that the task creation procedure stops after the first attempt.
- Retry Interval : Enter the time interval in seconds for each retry if the task fails.
- Headers : In the Header area, enter the HTTP header key and value in the Key and Value fields respectively. If you want to publish the HTTP header key and value pair as secret, click the Secrets fields.
- Response Code : Enter the response code for the selected response status.
- Response Status : Select either Success or Failure as the response status for the task.
- Set Response Path for Variable : Enter the variables from the specified response path. The example of json format is $.x.y and xml format is //x/y. For example, if the response path for variable is $.[*].display for response.
```
[
    {
        "display": "HTML Tutorial",
        "url": "https://www.w3schools.com/html/default.asp"
    },
    {
        "display": "CSS Tutorial",
        "url": "https://www.w3schools.com/css/default.asp"
    },
    {
        "display": "JavaScript Tutorial",
        "url": "https://www.w3schools.com/js/default.asp"
    },
    {
        "display": "jQuery Tutorial",
        "url": "https://www.w3schools.com/jquery/default.asp"
    },
    {
        "display": "SQL Tutorial",
        "url": "https://www.w3schools.com/sql/default.asp"
    },
    {
        "display": "PHP Tutorial",
        "url": "https://www.w3schools.com/php/default.asp"
    },
    {
        "display": "XML Tutorial",
        "url": "https://www.w3schools.com/xml/default.asp"
    }
]
```
  Then, during the launch time the list options are ["HTML Tutorial","CSS Tutorial","JavaScript Tutorial","jQuery Tutorial","SQL Tutorial","PHP Tutorial","XML Tutorial"].
Optionally, enter a label and description for the variable.
Optionally, do the following:
- Mark this variable private : Select this to make the variable private. Private variables are not shown at luanch or in the application.
- Mark this variable mandatory : Select this to make the variable a requisite for application launch.
- Validate with Regular Expression : Select this if you want to test the Regex values. Click Test Regex , provide the value for the Regex, and test or save the Regex. You can enter Regex values in PCRE format. For more details, see from http://pcre.org/.
Click Save on the Blueprint Editor page.

What to do next

After you added the application profile and its variables, you can create actions in the profile. For more information, see Adding an Action to a Multi-VM Blueprint.

Blueprint Configurations in Calm

Blueprint configuration involves adding tasks, actions, snapshot and restore configurations, and VM update configurations.

Configuring a Blueprint

Perform the following procedure to configure a blueprint.

Procedure

Click the Blueprint icon in the left pane.
The Blueprint page displays the list of all the available blueprints.
Click the blueprint that you want to configure.
The blueprint editor page is displayed.
Click Configuration .
The Blueprint Configuration window is displayed.
In the Blueprint Name field, enter a name of the blueprint.
In the Blueprint Description field, enter a brief description about the blueprint.
Click + against the Downloadable Image Configuration field and configure the following:
1. In the Package Name field, enter the name of the package.
2. In the Description field, enter a brief description about the package.
3. In the Image Name field, enter the name of the image.
4. In the Image Type list, select the type of image.
5. In the Architecture list, select the architecture.
6. In the Source URI field, enter the source URI to download the image.
In the Product Name field, enter the name of the product.
In the Product Version field, enter the version of the product.
Click one of the following:
- To save the configuration, click Save .
- To go back to the previous screen, click Back .

Adding Credentials

Credentials are used to authenticate a user to access various services in Calm. Calm supports static and dynamic credentials with key-based and password-based authentication methods.

Procedure

To add a credential, do one of the following:
- To add a credential in a single-VM blueprint, click Add/Edit Credentials on the Advanced Options tab and then click + Add Credentials .
- To add a credential in a multi-VM blueprint or a brownfield application, click Credentials on the Blueprint Editor page and then click Credentials + .
- To add a credential in a task, click Add New Credential in the Credential list.
In the Name field, type a name for the credential.
Under the Type section, select the type of credential that you want to add.
- Static : Credentials store keys and passwords in the credential objects that are contained in the blueprints.
- Dynamic : Credentials fetch keys and passwords from an external credential store that you integrate with Calm as the credential provider.
In the Username field, type the user name.
For dynamic credentials, specify the @@(username)@@ that you defined while configuring the credential provider.

Note: A dynamic credential provider definition requires username and secret. The secret variable is defined by default when you configure your credential provider. However, you must configure a runbook in the dynamic credential provider definition for the username variable before you use the variable in different entities.
Select either Password or SSH Private Key as the secret type.
Do one of the following to configure the secret type.
- If you selected Static as the credential type and Password as the secret type, then type the password in the Password field.
- If you selected Static as the credential type and SSH Private Key as the secret type, then enter or upload the key in the SSH Private Key field.
- If you selected Dynamic as the credential type and Password or SSH Private Key as the secret type, then select a credential provider in the Provider field. After you select the provider, verify or edit the attributes defined for the credential provider.
If the private key is password protected, click +Add Passphrase to provide the passphrase. For dynamic credentials, you must configure a runbook in the dynamic credential provider definition for the passphrase variable and then use the @@{passphrase}@@ variable.

The type of SSH key supported is RSA. For information on how to generate a private key, see Generating SSH Key on a Linux VM or Generating SSH Key on a Windows VM.
If you want this credential as your default credential, select the Use as default check box.
Click Done to add the credential.

Configuring Check Log-In

You configure a check log-in task to check whether you are able to SSH into the VM you create. Perform the following steps to configure check log-in.

Procedure

Under Connection , select the Check log-in upon create check box to check the log on status after creating the VM.
In the Credential list, select Add New Credential to add a new credential and do the following:
1. Enter a name for the credential in the Name field.
2. Select the type of credential you want to add under the Type section. Your options are:
  - Static : Credentials store keys and passwords in the credential objects that are contained in the blueprints.
  - Dynamic : Credentials fetch keys and passwords from an external credential store that you integrate with Calm as the credential provider.
3. Enter the user name in the Username field.
  For dynamic credentials, specify the @@(username)@@ that you defined while configuring the credential provider.
  
  Note: A dynamic credential provider definition requires username and secret. The secret variable is defined by default when you configure your credential provider. However, you must configure a runbook in the dynamic credential provider definition for the username variable to use in different entities.
4. Select either Password or SSH Private Key as the secret type.
5. Do one of the following to configure the secret type.
  - If you selected Static as the credential type and Password as the secret type, then type the password in the Password field.
  - If you selected Static as the credential type and SSH Private Key as the secret type, then enter or upload the key in the SSH Private Key field.
  - If you selected Dynamic as the credential type and Password or SSH Private Key as the secret type, then select a credential provider in the Provider field. After you select the provider, verify or edit the attributes defined for the credential provider.
  If the private key is password protected, click +Add Passphrase to provide the passphrase. For dynamic credentials, you must configure a runbook in the dynamic credential provider definition for the passphrase variable and then use the @@{passphrase}@@ variable.
  
  The type of SSH key supported is RSA. For information on how to generate a private key, see Generating SSH Key on a Linux VM or Generating SSH Key on a Windows VM.
6. If you want this credential as your default credential, select the Use as default check box.
7. Click Done .
Select address from the Address list.

You can either select the public IP address or private IP address of a NIC.
Select the connection from the Connection Type list.
Select SSH for Linux or Windows (Powershell) for Windows.

If you selected Windows (Powershell) , then select the protocol from the Connection Protocol list. You can select HTTP or HTTPS .

The Connection Port field is automatically populated depending upon the selected Connection Type . For SSH, the connection port is 22 and for PowerShell the connection port is 5985 for HTTP and 5986 for HTTPS.
Enter the delay in seconds in the Delay field.

Delay timer defines the time period when the check login script is run after the VM starts. It allows you to configure the delay time to allow guest customization script, IP, and all other services to come up before running the check login script.
In the Retries field, enter the number of log-on attempts the system must perform after each log on failure.
To save the blueprint, click Save .

Tasks Overview

You have the following basic types of tasks.

Execute: Used to run eScripts on a VM. For more information, see Creating an Execute Task.
Set variable: Used to change variables in a task. For more information, see Creating a Set Variable Task.
HTTP: Used to query REST calls from a URL. For more information, see Creating an HTTP Task.
Delay: Used to set a time interval between two tasks or actions. For more information, see Creating a Delay Task.

Pre-reate and Post-delete Tasks

Creating an Execute Task

You can create the Execute task type to run scripts on the VM.

About this task

Use this procedure to create an Execute task.

Procedure

In the Script Type list, select one of the following:
- Shell
- EScript
- Powershell
For Shell, PowerShell, and eScript scripts, you can access the available list of macros by using @@{ .

Note: You can use macro expansions for variables used for eScripts.

For sample eScripts , see Supported eScript Modules and Functions. For sample Powershell scripts, see Sample Powershell Script.
If you have selected the script type as Shell or Powershell , do the following:
1. In the Endpoint list, select an endpoint for the task or click Add New Endpoint to create an endpoint. For more information about creating an endpoint, see Creating an Endpoint.
2. In the Credential list, select an existing credential or click Add New Credential to add a credential. For more information about adding a credential, see Adding Credentials.
3. Enter the install or uninstall script in the Script panel.
  For example, see Sample Scripts for Installing and Uninstalling Services.
  
  You can also upload a script by clicking the upload icon.
4. If you want to test the script in Calm playground, click Test Script .
  Calm playground allows you to test a script by running and reviewing the output and making required changes.
  
  The Test Script page is displayed.
5. On the Authorization tab, enter the following fields:
  - IP Address : Enter the IP address of the test machine.
  - Port : Enter the port number of the test machine.
  - Select tunnel to connect with (Optional) : Select the tunnel to get access to the VMs within the VPC.
  - Credential : Select the credential from the list.
  - User name : Enter a user name.
  - Password : Enter a password.
6. Click Login and Test .
  The Test script page is displayed.
  
  You can also view your script in the Source Script field.
7. (Optional) You can edit your script in the Source Script field.
8. If you are using macros in your script, provide the variable values in the macro inspector panel and click Assign and Test .
9. Click Test .
  The test result is displayed in the Output field.
10. To go back to the previous screen, click Done .
If you have selected the script type as EScript , do the following:
1. In the Select tunnel to connect with list, select a tunnel to access VMs in the VPC. This step is optional.
2. In the Script field, enter the script.
  You can also upload a script by clicking the upload icon.
3. Click Test Script .
  The Test EScript page is displayed.
  
  You can also view your script in the Source Script field.
4. If you are using macros in your script, provide the variable values in the macro inspector panel and click Assign and Test .
5. To test the script, click Test .
  The test result is displayed in the Output field.
6. To go back to the previous screen, click Done .
To publish this task to the task library, click Publish to Library .
The task is published to the Library and you can browse and use the task while creating a blueprint.

Creating a Set Variable Task

You can create a Set Variable task type to change variables in a blueprint.

About this task

Use this procedure to create a Set Variable task.

Procedure

In the Script Type list, select one of the following:
- Shell
- Powershell
- EScript
For Shell, Powershell, and EScript scripts, you can access the available list of macros by using @@{ .

For sample Escripts , see Supported eScript Modules and Functions. For sample Powershell scripts, see Sample Powershell Script.
If you have selected the script type as Shell or Powershell , do the following:
1. In the Endpoint list, select an endpoint for the task or click Add New Endpoint to create an endpoint. For more information about creating an endpoint, see Creating an Endpoint.
2. In the Credential list, select an existing credential or click Add New Credential to add a credential. For more information about adding a credential, see Adding Credentials.
If you have selected the script type as EScript , then select a tunnel to access VMs in the VPC in the Select tunnel to connect with list. This step is optional.
Enter the install or uninstall script in the Script panel.
For example, see Sample Scripts for Installing and Uninstalling Services.
In the Output field, enter the name of the variable that you have defined through the set variable task.
If you are setting multiple variables, enter the variable name for each of the variables by clicking the Output field.
To publish this task to the task library, click Publish to Library .
The task is published to the Library and you can browse and use the task while creating a blueprint.

Creating an HTTP Task

You can create an HTTP task type to query REST calls from a URL. An HTTP task supports GET, PUT, POST, and DELETE methods.

About this task

Note: You can use macro expansions for variables used in an HTTP task.

Procedure

In the Request URL field, enter the URL of the server that you want to run the methods on.
In the Select tunnel to connect with list, select a tunnel to access VMs in the Virtual Private Cloud (VPC). This step is optional.
In the Request Method list, select one of the following request methods.
- GET : Use this method to retrieve data from a specified resource.
- PUT : Use this method to send data to a server to update a resource. In the Request Body field, enter the PUT request. You can also upload the put request by clicking the upload icon.
- POST : Use this method to send data to a server to create a resource. In the Request Body field, enter the POST request. You can also upload the post request by clicking the upload icon.
- DELETE : Use this method to send data to a server to delete a resource. In the Request Body field, enter the DELETE request. You can also upload the delete request by clicking the upload icon.
In the Content Type list, select the type of the output format.
The available options are XML , JSON , and HTML .
In the Header area, enter the HTTP header key and value in the Key and Value fields respectively.
If you want to publish the HTTP header key and value pair as secret, click the Secrets fields.
In the Connection Time Out field, enter the timeout interval in seconds.
Optionally, in the Authentication field, select Basic and do the following:
1. In the Username field, enter the user name.
2. In the Password field, enter the password.
If you want to verify SSL certificate for the task, click the SSL Cerificate Verification field.
If you want to use a proxy server as configured in the Prism Central, click the Use PC Proxy configuration .

Note: Ensure that the Prism Central has the appropriate HTTP proxy configuration.
In the Retry Count field, enter the number of attempts the system performs to create a task after each failure.
By default, the retry count is zero. It implies that the task creation procedure stops after the first attempt.
In the Retry Interval field, enter the time interval in seconds for each retry if the task fails.
In the Expected Response Options area, enter the details for the following fields:
- Response Status : Select either Success or Failure as the response status for the task.
- Response Code : Enter the response code for the selected response status.
Note: If the response code is not defined, then by default all the 2xx response codes are marked as success and any other response codes are marked as failure.
- Set Variables from response : Enter the variables from the specified response path. The example of json format is $.x.y and xml format is //x/y . For more information about json path syntax, see http://jsonpath.com.
  Note: To retrieve the output format in HTML format, add a * in the syntax.
If you want to test the script in Calm playground, click Test script .
Calm playground allows you to test a script by running and reviewing the output and making required changes.

The Test Script page is displayed. You can also edit the fields described from step 1–11.
Click Test .
The test result is displayed in the Output field .
To publish this task to the task library, click Publish to Library .
The task is published to the Library and you can browse and use the task while creating a blueprint.

Creating a Delay Task

You can create a Delay task type to set a time interval between two tasks or actions.

Procedure

In the Sleep Interval field, enter the sleep time interval in seconds for the task.

The delay task type is created. You can use the task type to set a time interval between two tasks or actions.

Adding a Pre-create or Post-delete Task

Pre-create tasks are actions that are performed before a service is provisioned in a blueprint. Post-delete tasks are actions that are performed after you delete a service in a blueprint.

Procedure

In the Overview Panel, under the service in which you want to add the task, expand VM , and then click Pre-create or Post-delete .

Figure. Pre-create or Post-delete Task Click to enlarge
In the Blueprint Canvas, click + Task for the pre-create or post-delete.
In the Inspector Panel, do the following:
1. Enter the task name in the Task Name field.
2. Select the type of tasks from the Type list.
  - Execute : Use this task type to run eScripts on the VM. To create the Execute task type, see Creating an Execute Task.
  - Set Variable : Use this task to change variables in a blueprint. To create the Set Variable task type, see Creating a Set Variable Task.
  - HTTP : Use this task type to query REST calls from a URL. An HTTP task supports GET, PUT, POST, and DELETE methods. To create the HTTP type, see Creating an HTTP Task.
  - Delay : Use this task type to set a time interval between two tasks or actions. To create the Delay task type, see Creating a Delay Task.
3. To use tasks from the library, click Browse Library , select the task in the Browse Task from Library page, and click Select . This step is optional.
4. Click Publish to Library to publish the task you configured to your task library. This step is optional.
Click Save .

Actions Overview

You can categorize actions into the following types.

Table 1. Action Types
Type	Description
Profile Actions	Application Profile Actions are a set of operations that you can run on your application. For example, when you launch a blueprint, the Create action is run. When you do not need the application for a period of time, you can run the Stop action to gracefully stop your application. When you are ready to resume your work, you can run Start action to bring the application back to the running state. You have the following types of profile actions. System-defined Profile Actions These actions are automatically created by Calm in every blueprint and the underlying application. Because these actions are system-defined, a blueprint developer cannot directly edit the tasks or the order of tasks within the action. Custom Profile Actions These actions are created by the blueprint developer and are added whenever the developer needs to expose a set of operations to the application user. Common custom profile actions are Upgrade, Scale In, and Scale Out. In these actions, individual tasks can be manually added in the desired order by the developer.
Service Actions	Service Actions are a set of operations that are run on an individual service. These actions cannot be run directly by the application user but can be run indirectly using either a profile actions or a package install or uninstall operation. Services span application profiles. For example, if you create a service action in the AHV profile, the same service action is available in the AWS profile as well. You have the following types of service actions. System-defined Service Actions These actions are automatically created by Calm in every blueprint and the underlying application. These actions cannot be run individually and are run only when the corresponding profile action is run. For example, any operations within the Stop service action are run when an application user runs the Stop profile action. Custom Service Actions These actions are created by the blueprint developer for any repeatable operations within the blueprint. For example, if the App service should fetch new code from git during both the Create and Upgrade profile actions, the blueprint developer can create a single custom service action. The developer can then reference the action in both the Create and Upgrade actions rather than maintaining two separate tasks that perform the same set of operations.

Custom Actions

The following are the most common custom actions that developers add to their blueprints:

Table 2. Custom Actions
Custom Action	Description
Scale In	The scale-in functionality enables you to decrease the number of replicas of a service deployment. The number of instances to be removed from a service for each scale-in action is defined in the blueprint while configuring the task in the profile level action. The scale count number must be less than or equals to the minimum number of replicas defined for the service. The VM that is created last is deleted first. For information on how to configure scale in, see Adding and Configuring Scale Out and Scale In.
Scale Out	The scale out functionality enables you to increase the number of replicas of a service deployment. The number of instances to be added to a service for each scale-out action is defined in the blueprint while configuring the task in the profile level action. The scale count number must be less than or equals to the maximum number of replicas defined for the service. For information on how to configure scale out, see Adding and Configuring Scale Out and Scale In.

For information about how to create an action, see Adding an Action to a Multi-VM Blueprint and Adding an Action to a Single-VM Blueprint.

Adding an Action to a Single-VM Blueprint

An action is a set of operations that you can run on your application that are created as a result of running a blueprint.

Before you begin

Ensure that you set up your single-VM blueprint. For more information, see Setting up a Single-VM Blueprint.
Ensure that you added the VM details to your blueprint. For more information, see Adding VM Details to a Blueprint.
Ensure that you configured the VM in your blueprint. For more information, see VM Configuration.
Ensure that you added credentials to enable packages and actions. For more information, see Adding Credentials.

Procedure

To add an action, click the + Add action next to Actions .

Figure. Blueprint Action Click to enlarge
To change the action name, click the edit icon on the Tasks tab.

Figure. Add Action Click to enlarge
Click the + Add Task button.
In the Blueprint Canvas, select the task and do the following in the Inspector Panel.
1. Enter the name of the task in the Task Name field.
2. Select the type of the task from the Type list.
  - Execute : Use this task type to run eScripts on the VM. To create the Execute task type, see Creating an Execute Task.
  - Set Variable : Use this task to change variables in a blueprint. To create the Set Variable task type, see Creating a Set Variable Task.
  - HTTP : Use this task type to query REST calls from a URL. An HTTP task supports GET, PUT, POST, and DELETE methods. To create the HTTP type, see Creating an HTTP Task.
  - Delay : Use this task type to set a time interval between two tasks or actions. To create the Delay task type, see Creating a Delay Task.
3. (Optional) To use tasks from the library, click Browse Library , select the task in the Browse Task from Library page, and click Select .
4. (Optional) Click Publish to Library to publish the task you configured to your task library.
Click Done .

Adding an Action to a Multi-VM Blueprint

An action is a set of operations that you can run on your application that are created as a result of running a blueprint.

Before you begin

Ensure that you have at least one service available. See Adding a Service.
Ensure that you have completed the pre-configuration requirements. See Creating a Multi-VM Blueprint.

Procedure

To add an action, click the + icon next to Actions in the Overview Panel.

Figure. Blueprint Action Click to enlarge
In the Blueprint Canvas, select + Action for the service, and do the following in the Inspector Panel.
1. Enter the task name in the Task Name field.
2. Select the action from the Service Actions list.
3. Click Save .
In the Blueprint Canvas, select + Task and do the following in the Inspector Panel.

Figure. Task Click to enlarge
1. Enter the name of the task in the Task Name field.
2. Select the type of the task from the Type list.
  You can select Execute or Set Variable .
3. Select the script from the Script Type list and enter the script in the Script field.
  You can select Shell , EScript , or Powershell .
  Note: To view the supported list of eScript modules and functions, refer to Supported eScript Modules and Functions.
  
  For the Shell and eScript scripts, you can access the available list of macros by using @@{ .
  
  When you select the Shell and Powershell script, you can optionally select or add an endpoint. You can also select or add credentials.
  
  You can click Publish to Library to publish the task you configured to your task library.
4. Enter the output of the script in the Output field.
5. Click Save on the Blueprint Editor page.

Adding and Configuring Scale Out and Scale In

Perform the following procedure to add and configure the Scale Out and Scale In task.

Procedure

Add a service. See Adding a Service.
Configure VM, Package and Service. See Configuring Nutanix and Existing Machine VM, Package, and Service.
Add an Application profile. See Adding and Configuring an Application Profile.
In the Overview Panel, under Application Profile , click the + icon next to Actions.

Figure. Scale In and Scale Out Click to enlarge
In the Blueprint Canvas, below the service inspector, click + Task .
In the Inspector Panel, enter the name of the task in the Task Name field.
Select Scale In or Scale Out from the Scaling Type list.
Enter the number in the Scaling Count field.
The Scaling out and Scaling in number should be less than the minimum and maximum number of replicas defined for the service.
Click Save .

What to do next

Blueprint Configuration for Snapshots and Restore

For VMware, AWS, and Azure platforms, the snapshot and restore feature is available by default only to the single-VM applications.

For more information on blueprint configuration for snapshots, see Configuring Single-VM Blueprints with Nutanix for Snapshots and Configuring Multi-VM Blueprints on Nutanix for Snapshots.

Configuring Single-VM Blueprints with Nutanix for Snapshots

About this task

Before you begin

Ensure that you set up your single-VM blueprint. For more information, see Setting up a Single-VM Blueprint.
Ensure that you added the VM details to your blueprint. For more information, see Adding VM Details to a Blueprint.
Ensure that you configured the VM in your blueprint. For more information, see VM Configuration.
Ensure that you added credentials to enable packages and actions. For more information, see Adding Credentials.
Ensure that you created the required snapshot policy. You associate snapshot policies when you launch the blueprint configured for snapshot and restore. For more information about creating snapshot policy, see Creating a Snapshot Policy.

Procedure

On the Advanced Options tab, next to Snapshot/Restore, click the + Add Snapshot/ Restore Config option.

Figure. Snapshot Config Click to enlarge
In the Add Snapshot and Restore window, do the following:
1. Enter the suffix that you want to associate to the snapshot/restore profile action.
2. Enter a name for the snapshot in the Snapshot Name field.
  You can use Calm macros to provide a unique name to the snapshot whenever they are generated. For example, snapshot-@@{calm_array_index}@@-@@{calm_time}@@ .
3. Under the Snapshot Location section, select Local or Remote Cluster to specify whether this configuration should manage your snapshots locally or on a remote cluster.
4. Select the Delete older VM after restore check box to delete the older VM after the service is restored from the snapshot.
5. Click Save .
  Saving the configuration generates separate profile actions for snapshot and restore.
On the Advanced Options tab, click Edit next to the snapshot or restore action to edit the configuration or add tasks. For more information about adding a task, see Configuring Tasks or Packages in a Blueprint.

What to do next

You can launch the blueprint after associating snapshot policies and rules. For more information, see Launching a Blueprint.
You can access the create snapshots from the Manage tab on the Applications page. For more information, see Creating Snapshots on a Nutanix Platform.

Configuring Multi-VM Blueprints on Nutanix for Snapshots

About this task

The snapshot/restore definition of a service generates snapshot configuration and its corresponding restore configuration. You can use these configurations to modify your snapshot and restore setup.

Before you begin

Ensure that you have completed the pre-configuration requirements. For more information, see Creating a Multi-VM Blueprint.
Ensure that you have at least one service available. For more information, see Adding a Service.
Ensure that you create the required snapshot policy. You associate snapshot policies when you launch the blueprint configured for snapshot and restore. For more information about creating snapshot policy, see Creating a Snapshot Policy.

Procedure

In the Overview Panel, expand the service to which you want to add the snapshot and restore action.
Click the + icon next to Snapshot/Restore .

Figure. Multi-VM Snapshot Click to enlarge
In the Add Snapshot and Restore window, do the following:

Figure. Multi-VM Snapshot Options Click to enlarge
1. Enter the suffix that you want to associate to the snapshot/restore profile action.
2. Enter a name for the snapshot in the Snapshot Name field.
  You can use Calm macros to provide a unique name to the snapshot whenever they are generated. For example, snapshot-@@{calm_array_index}@@-@@{calm_time}@@ .
3. Under the Snapshot Location section, select Local or Remote Cluster to specify whether this configuration should manage your snapshots locally or on a remote cluster.
4. In case of multiple replicas of the service, do one of the following:
  - Select Take snapshot of the first replica only to take snapshot of only the first replica.
  - Select Take snapshot of the entire replica set to take snapshot of the entire replica set.
5. Select the Delete older VM after restore check box to delete the older VM after the service is restored from the snapshot.
6. Click Save .
  Saving the configuration generates separate profile actions for snapshot and restore.
To view and edit the snapshot and restore configurations, expand the corresponding Snapshot/Restore under the service.
You can click the configuration to view the details in the Inspector Panel or make any changes to the configuration.
To view the profile actions for snapshot and restore or add more tasks and actions as part of snapshot and restore configuration, expand the Application Profile section.

What to do next

You can add more tasks and actions to the snapshot and restore application profiles. For more information, see Adding an Action to a Multi-VM Blueprint.
You can launch the blueprint after associating snapshot policies and rules. For more information, see Launching a Blueprint.
You can create snapshots from the Manage tab on the Applications page. For more information, see Creating Snapshots on a Nutanix Platform.

Update Configuration for VM

To update configurations of a running application VM, you need to perform the following actions:

Add an update configuration to the application blueprint.
Launch the update configuration

Add Update Configuration in the Blueprint

Specify the change factor (increase, decrease, or provide a definitive value) for VM configurations (vCPU, cores per vCPU, and memory). You can provide a minimum or maximum limit for each component based on the change factor you select and allow blueprint consumers to edit components during updates.
For example, consider a case where the original vCPU value in the blueprint is 4. You then add a change factor to the update configuration to increase the vCPU by 1 with a maximum limit of 5. When this update is launched, you can run the action only once to increase the vCPU to 5. Once the VM is upgraded to 5 vCPU, you cannot add any more vCPUs to the VM.
Add disks with a minimum and maximum limit for each disk. You can allow blueprint users to edit the disk size during updates until the value reaches the maximum or minimum limit. You can also allow blueprint users to remove existing vdisks from the VM.
Add categories (tags) to the running VM.
Add NICs to the VM or allow blueprint consumers to remove NICs. You can only add those NICs that belong to the same cluster and remove only those NICs that are not used to provide the address. You can also allow consumers to choose the desired subnet during updates.

The update configuration generates the corresponding action where you can add tasks to define how you want to execute the update.

For more information about adding update configuration to a blueprint, see Adding an Update Configuration to Single-VM Blueprints and Adding an Update Configuration to Multi-VM Blueprints.

Launch Update Configuration

You can update VM specifications from the Manage tab of applications on Nutanix. For more information, see Update VM Configurations of Running Applications.

Adding an Update Configuration to Single-VM Blueprints

As a blueprint developer, you can add an update configuration to a single-VM application blueprint.

About this task

The update configuration feature allows you to update the virtual machine of a running single-VM application to a higher or lower configuration. For more information, see Update Configuration for VM.

Before you begin

Ensure that you set up your single-VM blueprint. For more information, see Setting up a Single-VM Blueprint.
Ensure that you added the VM details to your blueprint. For more information, see Adding VM Details to a Blueprint.
Ensure that you configured the VM in your blueprint. For more information, see VM Configuration.

Procedure

On the Advanced Options tab, next to Update Configs, click the + Add Config option.
On the Update Configs page, click the edit icon next to the update config name to change the name of the configuration.
Under the VM Configuration section, select a change factor for the attributes and specify the value for the selected factor. To do that:
1. View the current value of vCPUs, No. of Cores, and Memory (GiB) in the Current Value column.
2. Click Update for the attribute that you want to update.
  
  Figure. Single-VM Update Config Options Click to enlarge
3. Select a value in the Operation list for the attribute. You can select Increase , Decrease , or Equal .
  For example, if the original vCPU value in the blueprint is 4 and you want to increase the vCPU by 1, then select Increase in the Operation list.
  
  Note: The update value is relative to the current value when you select Increase or Decrease . The update value is absolute when you select Equal .
4. Specify an update value in the Update column based on the Operation value you selected.
  For example, if the original vCPU value in the blueprint is 4 and you want to increase the vCPU by 1, then enter 1 in the Update field.
5. Specify the limit value to which the configuration of an attribute can be updated in the Min Value or Max Value column.
  For example, if the original vCPU value in the blueprint is 4 and you want to increase the vCPU to a maximum limit of 6, then specify 2 in the Max Value column. THe vCPU of the VM can be updated until its value reaches 6vCPU. After the VM reaches 6 vCPU, more vCPUs cannot be added to the VM.
  
  You can also enable the Editable toggle button of an attribute to allow your users to change its value within the limits you specify in the Min Value or Max Value column during the launch of the update.
Under the Disks section, do the following:
1. To add vdisk to the update configuration, click the + icon next to Add/Edit vDisks to this VM .
2. Select the device type and the device bus.
3. To define the disk size, specify the value for the vdisk size in the Value field.
  You can enable the Editable toggle button and specify the Min Value and Max Value for the vdisk.
4. To allow your users to remove existing vdisks from the VM during the launch of the update, click Advanced Settings and select the Allow users to remove existing vDisks check box.
Under the Categories section, do the following:
1. To add to the update configuration, select the categories in the Key: Value list.
  
  Note: The categories you select must have the default SSH port (port 22) open in the security policies.
2. To allow your users to remove existing categories during the launch of the update, click Advanced Settings and select the Allow users to remove existing categories check box.
3. To allow your users to add new categories during the launch of the update, select the Allow users to add new categories check box.
Under the Network Adapters section, do the following:
1. To add more NICs to the update configuration, click the + icon next to Add/Edit NICs to this VM and select the NIC from the list.
  The NICs of a VM can either use VLAN subnets or overlay subnets. For example, if an overlay subnet is selected for NIC 1 and you want to add NIC 2, the NIC 2 list displays only the overlay subnets.
  
  If you selected a VLAN subnet in NIC 1, any subsequent VLAN subnets belong to the same cluster. Similarly, if you select an overlay subnet, all subsequent overlay subnets belong to the same VPC.
  
  You can enable the Editable toggle button to allow your users to choose the desired subnet during the launch of the update.
2. To allow your users to remove existing NICs during the launch of the update, click Advanced Settings and select the Allow users to remove existing NICs check box.
To add variables to the update configuration, click the Variables tab and then the + icon next to Variables .
Click Done to save the update configuration.
Saving the update config generates the Config component. The Config component lets you open the Update Config window to edit the update configuration.
On the Advanced Options tab, click Save to save the blueprint and to generate the corresponding action for the update configuration.
Click Edit next to the configuration to add more tasks to the update configuration.

Adding an Update Configuration to Multi-VM Blueprints

As a blueprint developer, you can add an update configuration for a service to a multi-VM application blueprint.

About this task

The update configuration feature allows you to update virtual machines of running multi-VM applications to a higher or lower configuration. For more information, see Update Configuration for VM.

Procedure

Click the Blueprint icon in the left pane.
The Blueprint page appears.
Do one of the following:
- To add an update configuration to a new blueprint, select Multi VM/Pod Blueprint from the + Create Blueprint list, and create a blueprint. For more information, see Creating a Multi-VM Blueprint.
- To add an update configuration to an existing blueprint, click the blueprint name to open the blueprint editor.
Ensure that you have added the service to which you want to add the update configuration. For more information about adding a service, see Adding a Service.
In the Overview Panel, click the + icon next to Update Config .

Figure. Multi-VM Blueprint Update Config Click to enlarge

The Update Config window appears.
From the Select Service to Update list, select the service to which you want to add the update configuration.

Figure. Update Config Options Click to enlarge
In the Name the update configuration field, specify a name for the configuration.
Under the VM Configuration section, select a change factor for the attributes and specify the value for the selected factor. To do that:
1. View the current value of vCPUs, No. of Cores, and Memory (GiB) in the Current Value column.
2. Click Update for the attribute that you want to update.
3. Select a value in the Operation list for the attribute. You can select Increase , Decrease , or Equal .
  For example, if the original vCPU value in the blueprint is 4 and you want to increase the vCPU by 1, then select Increase in the Operation list.
  
  Note: The update value is relative to the current value when you select Increase or Decrease . The update value is absolute when you select Equal .
4. Specify an update value in the Update column based on the Operation value you selected.
  For example, if the original vCPU value in the blueprint is 4 and you want to increase the vCPU by 1, then enter 1 in the Update field.
5. Specify the limit value to which the configuration of an attribute can be updated in the Min Value or Max Value column.
  For example, if the original vCPU value in the blueprint is 4 and you want to increase the vCPU to a maximum limit of 6, then specify 2 in the Max Value column. THe vCPU of the VM can be updated until its value reaches 6vCPU. After the VM reaches 6 vCPU, more vCPUs cannot be added to the VM.
  
  You can also enable the Editable toggle button of an attribute to allow your users to change its value within the limits you specify in the Min Value or Max Value column during the launch of the update.
Under the Disks section, do the following:
1. To add vdisk to the update configuration, click the + icon next to Add/Edit vDisks to this VM .
2. Select the device type and the device bus.
3. To define the disk size, specify the value for the vdisk size in the Value field.
  You can enable the Editable toggle button and specify the Min Value and Max Value for the vdisk.
4. To allow your users to remove existing vdisks from the VM during the launch of the update, click Advanced Settings and select the Allow users to remove existing vDisks check box.
Under the Categories section, do the following:
1. To add to the update configuration, select the categories in the Key: Value list.
  
  Note: The categories you select must have the default SSH port (port 22) open in the security policies.
2. To allow your users to remove existing categories during the launch of the update, click Advanced Settings and select the Allow users to remove existing categories check box.
3. To allow your users to add new categories during the launch of the update, select the Allow users to add new categories check box.
Under the Network Adapters section, do the following:
1. To add more NICs to the update configuration, click the + icon next to Add/Edit NICs to this VM and select the NIC from the list.
  You can enable the Editable toggle button to allow your users to choose the desired subnet during the launch of the update.
2. To allow your users to remove existing NICs during the launch of the update, click Advanced Settings and select the Allow users to remove existing NICs check box.
Click Done to save the update configuration.
Saving the update config generates the Config component. The Config component lets you open the Update Config window to edit the update configuration.
On the Blueprint Editor page, click Save to save the blueprint and generate the corresponding action for the update configuration.
Saving the blueprint generates the Action component. The auto-generated Action component performs the start and stop of the service. You can also add tasks and actions to the component to define how you want your users to launch the update.

Blueprints Management in Calm

After you configure a blueprint, you can publish, unpublish, launch, or delete a blueprint.

Blueprint Publishing

Blueprint Launching

Launching a blueprint allows you to deploy your application on the blueprint and start using it.

The blueprint launch page provides the following views:

View as Consumer : This view of the blueprint launch page displays only the editable fields that consumers require to launch a blueprint. When you design your blueprint for consumers with minimum configurations at runtime, use this view to get an idea about the blueprint launching experience of your consumers.
Blueprints that are launched from the marketplace display only the fields that require inputs from consumers. Displaying only editable fields offers a simpler and easy launching experience for your consumers.
View as Developer : This view of the blueprint launch page displays all editable and noneditable fields that you configure for the blueprint. As a blueprint developer, you can switch between View as Consumer and View as Developer on the blueprint launch page.
You can switch to View as Developer after you develop your blueprints to verify how you configured different fields and the launching experience the configuration will provide to your consumers.

For more information, see Launching a Blueprint.

Submitting a Blueprint for Approval

Procedure

Click the Blueprint icon in the left pane.
The Blueprint page displays the list of all the available blueprints.
Click the blueprint that you want to publish.
The blueprint editor page is displayed.
Click Publish .

Figure. Publish Blueprint window Click to enlarge

The Publish Blueprint window is displayed.
If the blueprint is getting published for the first time, select New marketplace item and do the following.
1. To publish the blueprint with secret variables, click the Publish with Secrets toggle-button.
1. Enter the version number in the Initial Version field.
  
  Note: Ensure that the version number is in the x.x.x format.
2. Enter the blueprint description in the Description field.
If you want to revise a published blueprint version, select New version of an existing marketplace item and do the following.
1. To publish the blueprint with secret variables, enable the Publish with Secrets button.
2. Select the already published blueprint from the Marketplace Item list.
3. Enter the version number in the Initial Version field.
  
  Note: Ensure that the version number is in the x.x.x format.
4. Enter the blueprint description in the Description field.
5. Enter the log changes in the Change Log field.
If you want to upload an icon for the blueprint, click Change .
1. Click Upload from computer to browse and select an image from your local machine.
2. Click Open .
3. Provide a name to the image in the Name of the Icon field.
4. Click the right icon.
5. Click Select & Continue .
Note: User with administrator role can only upload an icon.
Optionally, if you want to select an icon, already available in a blueprint, click the right icon.
Optionally, to delete an icon, click the delete icon.
Click Submit for Approval .
The blueprint is submitted to the marketplace manager for approval. Your administrator can find the submitted blueprint on the Approval Pending tab of the Marketplace Manager page.

What to do next

Launching a Blueprint

You launch a blueprint to deploy an application on the blueprint and start using the application.

Before you begin

For blueprints on a Nutanix platform, ensure that you have created the snapshot policy. For more information about snapshot policy creation, see Creating a Snapshot Policy.

Procedure

Click the Blueprint icon in the left pane.
The Blueprint page is displayed.
Click the blueprint that you want to launch.
The blueprint details page is displayed.
Click Launch .
The blueprint launch page is displayed.
Figure. Launch Blueprint Click to enlarge
Enter a name for the application in the Application Name field.
Enter a description for the application in the Application Description field.
Select the environment from the Environment list.
If you select an environment that is different from the account that you used for blueprint configuration, Calm updates all platform-dependant fields to match with the selected environment configuration.

For example, you created the application blueprint using an account with an environment (ENV1) so that the platform-dependant fields are similar to ENV1. While launching the application blueprint, if you select a different environment (ENV2), Calm updates all platform-dependant fields to match with the ENV2 configuration.
Select the application profile from the App Profile field.
In case, any of the fields are marked runtime while creating the blueprint, those fields are editable and displayed here. To view the runtime variables, expand the service under VM Configurations .
In the sections for the service configuration and credentials configuration, verify and edit the configuration requirements for your application services and credentials.

Figure. Blueprint Launch - Service Configuration Click to enlarge

Use the View as Developer option at the top of the blueprint launch page to view all configuration fields.

Note: The View as Consumer view displays only the editable fields while the View as Developer view displays all configuration fields for your services and credentials. As a developer, you can select the View as Developer to view the configuration details of all fields.
If the blueprint is configured with a Nutanix account, do the following:
1. Under Snapshot Configurations, select a snapshot policy in the Snapshot Policy list.
2. Based on the policy you select, select a rule in the Select Local Rule or Select Remote Rule list.
  The Select Local Rule or Select Remote Rule list appears based on the Snapshot Location you defined in your blueprint. For more information, see Blueprint Configuration for Snapshots and Restore. The values in the list appear based on the snapshot policy you defined in the project and selected in the Snapshot Policy list. For more information, see Creating a Snapshot Policy. The values also depend on the VM categories you configured in your blueprint.
The Snapshot Configuration section appears depending on the environment you select while launching the blueprint. If you select a specific environment, you must provide the snapshot policy and snapshot rule to launch the blueprint. The Snapshot Configuration section does not appear in case you select the environment with all project accounts for the launch.

Note: Ensure that you have a valid NIC in the blueprint.
Click Deploy .
The system validates the provided platform-specific data against the selected provider and if the validation fails, an error message appears. To know more about the validation error, see Platform Validation Errors.
If the validation is successful, the application is available under the Application tab.

Platform Validation Errors

When you enter the platform data that is invalid for a provider while creating a blueprint, you get a validation error. The following table details the invalid platform data for each provider.

Providers	Invalid Platform Data
Nutanix	Image, NIC List, and Categories.
GCP	Machine Type, Disk Type, Network, SubNetwork, Source, Image, Zone, and Blank Disk.
AWS	Vpc, Security Groups, and Subnets.
VMware	Network name, NIC Type, NIC settings mismatch, Host, Template, Datastore, Datacenter, Storage Pod, and cluster.
Azure	Image details (publisher, offer, sku, version), Custom image, Resource group, Availability Set Id, NIC List, Network Security group, Virtual Network Name, and Subnet Name.

The platform validation error message appears as displayed in the following image.

Uploading a Blueprint

You can also upload configured blueprints to the Blueprints tab. Perform the following procedure to upload a blueprint.

Procedure

Click the Blueprint icon in the left pane.
The Blueprint page displays the list of all the available blueprints.
Click Upload Blueprint .
The browser window is displayed.
Browse to the location of the saved blueprint and select the blueprint.
Do one of the following.
- Double-click the selected blueprint.
- Select and click Open .
Figure. Upload Blueprint Click to enlarge

The Upload Blueprint window is displayed.
Enter the name of the blueprint in the Blueprint Name field.
Select the project from the Project list.
Click Upload .
The blueprint is uploaded and available for use.
Note: You must provide the credentials password or key of the blueprint.

Downloading a Blueprint

You can also download a configured blueprint to your local machine and use it later. Perform the following procedure to download a blueprint.

Before you begin

Ensure that at least one blueprint must be available.

Procedure

Click the Blueprint icon in the left pane.
The Blueprint page displays the list of all the available blueprints.
Do one of the following.
- Click the blueprint that you want to download and click Download .
- Select the blueprint that you want to download and Action > Download .
The Download Blueprint dialog box appears.
Optionally, if you want to download the blueprint with the credentials and secrets used in the blueprint, click the check box in the Download Blueprint dialog box.
In the Enter Passphrase field, type a password.
The Enter Passphrase field is a mandatory field and is activated only after you have clicked the check box to download the blueprint with credentials and secrets.
Click Continue .
The blueprint is downloaded to your local machine.

Viewing a Blueprint

Perform the following procedure to view a blueprint.

Procedure

Click the Blueprint icon in the left pane.
The Blueprint page displays the list of all the available blueprints.
Click the blueprint that you want to view the details of.
The selected blueprints details are displayed.

Editing a Blueprint

You can edit a configured blueprint from the blueprints tab. Perform the following procedure to edit a blueprint.

Procedure

Click the Blueprint icon in the left pane.
The Blueprint page is displayed.
Click the blueprint that you want to edit.
The blueprint details page is displayed.
Make the necessary edits in the layers ( Services , Actions , and Application Profiles ).

Note: You cannot delete System level actions.
Click Save .
The updated blueprint is saved and listed in the blueprints tab.

Deleting a Blueprint

Perform the following procedure to delete a blueprint.

Procedure

Click the Blueprint icon in the left pane.
The Blueprint page is displayed.
Select the listed blueprint that you want to delete.
Click Actions > Delete .
Click Yes to confirm.
The blueprint is deleted.

Viewing Blueprint Error

If you have configured wrong details in your blueprint, you can view the error message while saving or publishing a blueprint. Perform the following procedure to view blueprint error message.

Procedure

Click the Blueprint icon in the left pane.
The Blueprint page displays the list of all the available blueprints.
Click the blueprint that you want to view the details.
The selected blueprint details are displayed. If there is any error in the blueprint, then the error is denoted by ! .
Click ! .

Figure. Blueprint Error Click to enlarge

The blueprint errors are displayed.

Recovering Deleted Blueprints

You can recover the deleted application blueprints within a time period of 90 days after you delete an application blueprint. This chapter describes the procedure to recover a deleted blueprint.

Procedure

Click the Blueprint icon in the left pane.
The Blueprint page displays the list of all the available blueprints.
In the search filter field, enter State:Deleted and press Enter.
You can view the list of all deleted blueprints based on the 90 days retention period.
Click the blueprint that you want to recover.
From the Action list, select Clone .
The Clone Blueprint page appears.
In the Blueprint Name field, enter a name for the blueprint and click Clone .
The name is used as the blueprint name after recovery.

A clone of the deleted blueprint is created and you can view the recovered blueprint in the blueprints page with the new name.

Marketplace in Calm

Marketplace Overview

The marketplace provides preconfigured application blueprints and runbooks for instant consumption. The marketplace is a common platform for both publishers and consumers.

The marketplace has banners to display featured applications. All listed applications display the icon of the platform that supports the application.

You can filter applications or runbooks based on their category and source. You can also search an application or runbook in the marketplace.

Before provisioning an application, you can view details such as application overview, changes made in different versions, and application-level actions.

Viewing Application Details

About this task

Video: Viewing Application Details

Procedure

Click Marketplace icon in the left pane.
The Marketplace page is displayed.
To view the details of an application, click the Get button on the application blueprint.

Figure. Application Details Click to enlarge

The Application Details page is displayed.

Filtering Application Blueprints or Runbooks

Perform the following procedure to filter application blueprints or runbooks in the marketplace.

Procedure

Click Marketplace icon in the left pane.
The Marketplace page is displayed.
Click the Filters button.
The Filters pane appears.
Figure. Marketplace Filters Click to enlarge
Select a category, type, or source value to filter applications and runbooks.
The Marketplace page displays all available applications and runbooks based on the selected category, type, and source value.

Searching an Application Blueprint or Runbook

Perform the following procedure to search an application blueprint or runbook.

Procedure

Click Marketplace icon in the left pane.
The Marketplace page is displayed.
Enter the name of the application or runbook that you want to search in the Search marketplace field.
The Marketplace page shows the search results as you enter the name in the Search marketplace field.

Launching a Blueprint from the Marketplace

Procedure

Click the Marketplace icon in the left pane.
The Marketplace page is displayed.
Click the Get button for the application that you want to launch.
The Application Details page is displayed.
Click Launch .
The Launch page is displayed.
Figure. Launch Blueprint Click to enlarge
Enter a name for the application in the Application Name field.
Following are the rules for naming convention.
- The name of the blueprint can start with an alphanumeric character or an underscore.
- The name must have at least one character.
- Use only space, underscore, and dash as special characters.
- Do not end the name with a dash.
Enter a description for the application in the Application Description field.
Select the project from the Project list.
Select the environment from the Environment list.
If you select an environment that is different from the account that you used for blueprint configuration, Calm updates all platform-dependant fields to match with the selected environment configuration.

For example, you created the application blueprint using an account with an environment (ENV1) so that the platform-dependant fields are similar to ENV1. While launching the application blueprint, if you select a different environment (ENV2), Calm updates all platform-dependant fields to match with the ENV2 configuration.
Select an application profile in the App Profile field.
Application profile provides different combinations of the service, package, and VM while configuring a blueprint.
In the section for the service configuration, verify the VM, disk, boot configuration, and network configuration. You can edit the fields based on your application requirements.

Figure. Application Launch - Service Configuration Click to enlarge
If the blueprint is configured with a Nutanix account, do the following:
1. Under Snapshot Configurations, select a snapshot policy in the Snapshot Policy list.
2. Based on the policy you select, select a rule in the Select Local Rule or Select Remote Rule list.
  The Select Local Rule or Select Remote Rule list appears based on the Snapshot Location you defined in your blueprint. For more information, see Blueprint Configuration for Snapshots and Restore. The values in the list appear based on the snapshot policy you defined in the project and selected in the Snapshot Policy list. For more information, see Creating a Snapshot Policy. The values also depend on the VM categories you configured in your blueprint.
The Snapshot Configuration section appears depending on the environment you select while launching the blueprint. If you select a specific environment, you must provide the snapshot policy and snapshot rule to launch the blueprint. The Snapshot Configuration section does not appear in case you select the environment with all project accounts for the launch.

Note: Ensure that you have a valid NIC in the blueprint.
Click Deploy .
The application blueprint is displayed under the Application tab.

Environment Patching Behavior

To patch a cloud provider VM that has a specific OS type, Calm finds the corresponding match in the environment. In case there are no matches available, Calm displays a notification.

The following table lists the environment patching behavior for platform-dependent and platform-independent fields:

Table 1. Environment Patching
Fields	Condition	Patching Behavior
Platform-Dependent Fields	When different accounts are associated with the blueprint and environment	Values from the environment get preference for patching, irrespective of the values in the blueprint.
Platform-Dependent Fields	When the blueprint and the environment have the same account	Values from the environment are patched only when the fields do not have any value in the blueprint.
Platform-Independent Fields	When different accounts are associated with the blueprint and environment	Values from the environment are patched only when the fields do not have any value in the blueprint.
Platform-Independent Fields	When the blueprint and the environment have the same account	Values from the environment are patched only when the fields do not have any value in the blueprint.

The following table lists the platform-dependent fields for different platforms.

Table 2. Platform-Dependent Fields
Platform	Platform-Dependent Fields
Nutanix	Image, Categories, Cluster, and NIC
AWS	Machine Image, Key, Instance Profile Name, VPC ID, Subnet ID, and Security Group List
GCP	Machine Type, Zone, Network, Disk Type, Source Image, and Email
VMware	Host, Template, Datastore, Cluster, Storage Pod, Network Name, NIC Type, Disk Location, Disk ISO Path, Folder, and Tag List
Azure	Resource Group, Location, Availability Set ID, Resource Group Details, Resource Group Operation, Network Security Group Name, Network Name, Subnet Name, Network Security Group ID, Virtual Network ID, Subnet ID, Publisher, Offer, SKU, Version, Source Image Type, and Source Image ID

Environment Patching Behavior with Nutanix – Example-1

Table 3. Environments
ENV1	ENV2
Account: PC1 NIC: PC1_Net1 Image: PC1_Image1 Categories: PC1_category1 and PC1_category2 Cluster: PC1_Cluster1 Operating System: Linux	Account: PC2 NIC: PC2_Net1 Image: PC2_Image1 Categories: PC2_category1 and PC2_category2 Cluster: PC2_Cluster1 Operating System: Linux

You then create a blueprint with a Nutanix service under Project1 having the following configuration:

Account: PC1
Image: PC1_Image2
Categories: PC1_category3
Cluster: PC1_Cluster2
NIC: PC1_Net2

When you publish this blueprint in the marketplace and launch the blueprint with a different environment, the environment patching happens as follows:

When you select Project1 and ENV2 for launching, the account in the blueprint is PC1, and the account in ENV2 is PC2.
Because different accounts are associated with the blueprint and environment, all platform-dependent field values are patched from the environment to the blueprint, irrespective of the values already available in the blueprint. The blueprint is launched with the following configuration.
- Image: PC2_Image1
- Categories: PC2_category1 and PC2_category2
- Cluster: PC2_Cluster1
- NIC: PC2_Net1
When you select Project1 and ENV1 for launching, the account in both the blueprint and ENV1 is PC1.
Because the account is same for both blueprint and environment and all the platform-dependent fields already have values, the patching does not happen. The blueprint is launched with the following configuration.
- Image: PC1_Image2
- Categories: PC1_category3
- Cluster: PC1_Cluster2
- NIC: PC1_Net2

Environment Patching Behavior with Nutanix – Example-2

Assume that you have a Prism Central account PC1 that is associated with two Prism Elements PE1 and PE2, and you add PC1 to your project (Project1).

Assume that the associated Prism Elements have the following networks.

PE1: PE1_Net1 and PE1_Net2
PE2: PE2_Net1 and PE2_Net2

You then create two environments with the following VM configuration:

Table 4. Environments
ENV1	ENV2
NIC: PE1_Net1 Image: PC1_Image1 Categories: PC1_category1 and PC1_category2 Operating System: Linux	NIC: PE2_Net1 Image: PC1_Image2 Categories: PC1_category3 and PC1_category4 Operating System: Linux

You then create a blueprint with a Nutanix service under Project1 having the following configuration:

NIC: PE1_Net2
Image: PC1_Image3
Categories: PC1_category5 and PC1_category6

When you publish this blueprint in the marketplace and launch the blueprint with a different environment, the environment patching happens as follows:

When you select Project1 and ENV2 for launching:
Prism Element accounts are derived from the NIC or subnet. The PE1_Net2 network used in the blueprint associates the blueprint to Prism Element PE1, and the PE2_Net1 network used in ENV2 associates the environment to Prism Element PE2.

Because these two networks are connected to two different Prism Element account_uuid , Calm considers this case as two different accounts associated with the blueprint and environment. All platform-dependent field values are, therefore, patched from the environment to the blueprint, irrespective of the values already available in the blueprint. The blueprint is launched with the following configuration.
- NIC: PE2_Net1
- Image: PC1_Image2
- Categories: PC1_category3 and PC1_category4
When you select Project1 and ENV1 for launching:
The PE1_Net2 network used in the blueprint and the PE1_Net1 network used in ENV belong to the same Prism Element account.

Because these two networks share the same Prism Element account_uuid , Calm considers this case as the same account associated with both the blueprint and environment. Platform-dependent fields in this case already have values, and the patching does not happen. The blueprint is launched with the following configuration.
- NIC: PE1_Net2
- Image: PC1_Image3
- Categories: PC1_category5 and PC1_category6

Credentials Patching

Patching of credentials happens only when you publish your blueprints in the marketplace without secrets.

For example, if the blueprint and the environment have the following configurations:

Table 5. VM Configuration
Blueprint	Environment
Credential Name: BP_Credentials Username: BP_User1 Password: BP_Password Provider Account: Nutanix Operating System: Linux	Credential Name: ENV_Credentials Username: ENV_User1 Password: ENV_Password Provider Account: Nutanix Operating System: Linux

The credentials patching in the blueprint happens as follows:

Table 6. Credential Patching
When Blueprint is Published with Secrets	When Blueprint is Published without Secrets
Credential Name: BP_Credentials Username: BP_User1 Password: BP_Password	Credential Name: BP_Credentials Username: BP_User1 Password: ENV_Password

Patching for Clusters and Subnets

Table 1. Conditions for Cluster Patching
Condition	Patching Behavior
When the cluster reference in the blueprint and in the environment VM configuration is the same.	No patching happens. The cluster reference from the blueprint is used for the launch.
When the cluster reference in the blueprint and in the environment VM configuration is different.	Patching happens. The cluster value is patched from the environment for the launch.
When the cluster reference in the blueprint is a macro. Note: Cluster reference can be a macro only when all the subnets are overlay subnets or all the subnets are macros.	No patching happens. The cluster value will remain as a macro. When the reference is a macro, it is independent of the environment or the account that is being used for launch.

Overlay subnets are VPC dependent. The environment patching logic of these subnets depends on the VPC reference in the blueprint and the VPC reference of the associated environment VM configuration.

All subnets in the substrate of a blueprint can either have overlay subnets or VLAN subnets. If subnets are overlay subnets, then all the subnets in the substrate must belong to the same VPC.

Table 2. Conditions for Subnet Patching
Condition	Patching Behavior
When the VLAN subnets in the blueprint and in the environment VM configuration is the same.	No patching happens. VLAN subnets are platform dependent. The VLAN subnet values referred in the blueprint are used.
When the VLAN subnets in the blueprint and in the environment VM configuration is different.	Patching happens. VLAN subnets are platform dependent. The VLAN subnet values are patched from the environment.
When the VPC reference of the subnets (overlay subnets) in the blueprint and the environment VM configuration is the same.	No patching happens. The subnet values of the blueprint are used for the launch. Values from the environment is patched only if it is empty in the blueprint or not allowed in the destination environment.
When the VPC reference of the subnets (overlay subnets) in the blueprint and the environment VM configuration is different.	Patching happens. The subnet values are patched directly from the environment.
When the network type in the blueprint and the environment VM configuration are different (for example, overlay subnets in the blueprint and VLAN subnets in the environment).	Patching happens. The subnet values are patched directly from the environment.
When the subnet reference of the any of the NICs in the blueprint is a macro.	Patching follows the usual conditions. However, the macros are never patched.

Executing a Runbook from the Marketplace

You can execute a runbook an approved and published runbook using the Marketplace tab.

Before you begin

Ensure that the runbook that you want to execute is approved and published in the marketplace. For more information, see Approving and Publishing a Blueprint or Runbook.

Procedure

Click the Marketplace icon in the left pane.
The Marketplace page is displayed.
Click the Get button for the runbook that you want to execute.
The runbook overview page appears.
Figure. Runbooks Overview Click to enlarge
Click Execute .
The Execute Runbook window appears.
Figure. Execute Runbook Click to enlarge
Select the project for the runbook execution from the Project list.
Optionally, if you want to change the default endpoint for the execution, select an endpoint from the Default Endpoint list.

Note: If you have published runbook without endpoints, then you need to select the endpoint from the project in which you are executing the runbook.
Optionally, if you want to update the added variable in the runbook, click the respective variable field and edit the variable.

Note: You can update the variable only if the variable is marked as runtime editable while adding the variable in the runbook.
Click Execute .

Cloning an Application Blueprint or Runbook

You can clone an application blueprint or runbook from the marketplace.

Procedure

Click Marketplace icon in the left pane.
The Marketplace page is displayed.
Click the Get button for the application blueprint or runbook that you want to clone.
The Overview page for the application or runbook appears.
Figure. Blueprint Cloning Click to enlarge
Click Clone .
The Clone window appears.
Enter the name for the clone.
Select the project that you want to assign to the cloned application blueprint or runbook from the Project list.
Click Clone .
The cloned blueprint or runbook appears on their respective Blueprints or Runbooks tabs.

Marketplace Manager in Calm

Marketplace Manager Overview

You can perform the following actions on blueprints or runbooks.

You can approve blueprints or runbooks and publish them to the marketplace for consumption. You can also publish the ready-to-use application blueprints to the marketplace. For more information, see Approving and Publishing a Blueprint or Runbook.
You can unpublish blueprints or runbooks to remove them from the marketplace. For more information, see Unpublishing a Blueprint or Runbook.
You can also delete an unpublished blueprint or runbook. For more information, see Deleting an Unpublished Blueprint or Runbook.

Marketplace Version

Approving and Publishing a Blueprint or Runbook

About this task

Before you begin

To publish a blueprint, ensure that you have configured a blueprint and submitted the blueprint for approval. For more information, see Calm Blueprints Overview and Submitting a Blueprint for Approval.
To publish a runbook, ensure that you have submitted a runbook for publishing. For more information, see Submitting a Runbook for Publishing.

Procedure

Click Marketplace Manager tab.
The Marketplace Manager page is displayed.
Click the Approval Pending tab to get the list of all unpublished blueprints and runbook requests.
A list of all the unpublished blueprint and runbook requests is displayed.
Figure. Marketplace Manager Approval Pending Click to enlarge
Select the blueprint or runbook that you want to approve and publish.
The inspector panel appears.
Click the check mark button to approve.
Click the Approved tab to get the list of all approved blueprints and runbooks.
A list of all the approved blueprints and runbooks is displayed.
Select the approved blueprint or runbook that you want to publish.

Note: You can also select a ready-to-use marketplace application blueprint on the Approved tab for publishing.
In the Inspector Panel, select the category from the Category list.
You can also add a new application category value and select the value for publishing. To add a new category value for applications, you need to add the value to the AppFamily category. To know how to add a value to a category, see the Category Management section in the Virtual Infrastructure (Cluster) Administration chapter of the Prism Central Guide .
Select one or more projects from the Projects Shared With list.
Click Apply .
Click Publish .
The blueprint or runbook will be published in the marketplace.

What to do next

Launch the published blueprint from the Marketplace tab. For more information, see Launching a Blueprint from the Marketplace.
Execute the published runbook from the Marketplace tab. For more information, see Executing a Runbook from the Marketplace.

Unpublishing a Blueprint or Runbook

You can unpublish a blueprint or runbook if you do not want to list it in the Marketplace. You can publish the blueprint or runbook again if required.

Procedure

Click the Marketplace Manager tab.
The Approved tab lists all the published blueprints and runbooks.
Select the blueprint or runbook that you want to unpublish.
The inspector panel is displayed.
Click Unpublish .
The blueprint or runbook is unpublished and does not appear in the marketplace.

Deleting an Unpublished Blueprint or Runbook

You can delete a blueprint or runbook that is not published in the marketplace. If you want to delete a published blueprint or runbook, you first have to unpublish it and then delete it.

Procedure

Click the Marketplace Manager tab.
Do one of the following:
- To delete a blueprint or runbook that is not yet approved, click the Approval Pending tab.
- To delete a blueprint or runbook that is approved and unpublished, click the Approved tab.
Select the blueprint or runbook that you want to delete.
The inspector panel appears.
Click the Delete icon.
The blueprint or runbook is deleted from the marketplace manager.

Calm Applications

Applications Overview

You create applications in Calm by creating and launching blueprints.

The Applications page displays the list of all published applications under the Applications tab and the list of brownfield applications under the Brownfield Applications tab.

The Applications page provides the following details about an application.

Name of the application.
Source blueprint of the application.
State of an application whether the application is in a running or in an error state.
Application creation time.
Name of the application owner.
Time duration when the application was created.
Date of the last update of the application.
The cost of an application for last 30 days.

Application-Level Actions

You have the following application-level actions.

Create
Start
Restart
Stop
Delete
Soft delete
Install NGT applications
Manage NGT applications
Uninstall NGT applications
Create, restore, and delete snapshots
Clone applications

You cannot perform the Create action after the blueprint is launched and the application is created. You can perform all other application-level actions according to the application state.

Application State

The applications page displays the state of the application based on the actions you perform on the Manage tab.

Table 1. Application State
Application State	Description
Provisioning	When you start an application.
Running	When the application is deployed and running after the provisioning state.
Stopping	When you have initiated an operation to stop the application.
Stopped	When the application is stopped.
Restarting	When you have initiated an operation to restart the application after the application is stopped.
Deleting	When you have initiated an operation to delete the application.
Deleted	When the application is deleted.
Busy	When you have installed the NGT services on the VMs of an application.
Updating	When you are editing an application.
Error	When the application goes to error state due to any action you have performed in the Manage tab.
Failover-in-progress	When you have initiated a failover operation on Prism Central for the protected VMs of an application.
Failover-failed	When the failover operation for the VMs has failed. The failure state mainly occurs in the following conditions. If there is any error from the Prism Central side. If there is no NIC attached to the VM when you configure the recovery plan for the protected VM.

Note: The Failover-in-progress and Failover-failed states are only applicable for the applications that are running on the Nutanix platform.

Application Details

You can click an application name to get details about the application as shown in the following figure.

The application page consists of the following tabs.

Overview Tab

The Overview tab consists of the following panels.

Application Description
Variables
Cost Summary
App Summary
App Status
VM Info

Table 1. Overview Tab
Panel	Description
Application Description	Displays the application description.
Variables	Displays the variable list used to create the blueprint. You can click the copy icon next to the variable to copy the variable.
Cost Summary	Displays the total cost, current cost for each hour, and the cost incurred in a month for the resources that are running in the blueprint. The cost summary panel also displays a graphical representation of the incurred cost. Note: The Cost Summary panel is applicable for Nutanix and VMware providers.
App Summary	Displays the following application details. Application UUID : Displays a unique identification code for the application. UUID is automatically generated after the application is created and in running state. Blueprint : Displays the blueprint from which the application is created. Cloud : Displays the cloud provider icon that hosts the application. Project : Displays the project that is added to the application. Owner : Displays the role of the user. Created On : Displays the date and time when the application was created. Last Updated On : Displays the date and time when the application was last updated.
App Status	Displays the summary of virtual machines (VMs). The panel displays the number of VMs that are in the following state. On Busy Error Off
VM info	Displays the following VM details of the application. Name : Displays the VM name. IP Address : Displays the IP address of the VM. Image : Displays the image from which the VM is created. vCPUs : Displays the number of vCPU allocated to the VM. Cores : Displays the number of cores allocated to the VM. Memory : Displays the total memory allocated to the VM. Network Adapters : Displays the network adapters used in the VM. You can use the down arrow key to view the details of the network adapter. VPC : Displays the associated VPC and the connection status. Categories : Displays the categories added to the VMs. You can use the down arrow key to view the details of the network adapter.

Manage Tab

The Manage tab lists the system-generated and user-created actions that you can perform on the application. When you click any of the listed actions, the editor displays the action dependencies.

You can perform the following system-generated actions on an application.

Create : Creates an application. You cannot perform this action once the blueprint is launched and application is created.
Start : Starts an application.
Restart : Restarts an application.
Stop : Stops an application.
Delete : Deletes an application including the underlying VMs on the provider side.
Soft Delete : Deletes the application from the Calm environment but does not delete the VMs on the provider side.
Install NGT : Installs NGT service on your VM. To install NGT on your VM, see Installing NGT Apps.
Manage NGT : Manages NGT services for your application. You can enable or disable SSR or VSS services. The self-service restore (SSR) allows virtual machine administrators to do a self-service recovery from the Nutanix data protection snapshots with minimal administrator intervention. For more information, see Self-Service Restore section in the Prism Web Console Guide. Volume Shadow Copy Service (VSS; also known as Shadow Copy or Volume Snapshot Service) creates an application-consistent snapshot for a VM and is limited to consistency groups consisting of a single VM.
Uninstall NGT : Uninstalls NGT services from the VM. For more information, see Uninstalling NGT Apps.

Note:

NGT services applies only to single VM applications running with Nutanix as the provider.
For Kubernetes, the start, stop, and restart actions are disabled.

The inspector panel also displays the action you perform on an application. To view the detailed course of the action, click Action .

Metrics Tab

The Metrics tab allows you to view performance metrics of the VM. The Metrics tab displays a section on the left with a list of metrics.

Note:

The Metrics tab applies only to single VM blueprint running with Nutanix as the provider.
The identified anomalies are based on VM behavioral machine-learning capabilities.

Clicking a metric displays a graph on the right. (Some metrics have multiple graphs.) The graph is a rolling time interval performance or usage monitor. The baseline range (based on the machine-learning algorithm) appears as a blue band in the graph. Placing the cursor anywhere on the horizontal axis displays the current value. To set the time interval (last 24 hours, last week, last 21 days), select the duration from the pull-down list on the right.
Note: The machine-learning algorithm uses 21 days of data to monitor performance. A graph does not appear for less than 21 days of data.
To create an alert for this VM based on either behavioral anomalies or status thresholds, click the Set Alerts link above the graph.

The following table describes the available metrics.

Table 1. Metrics Tab Fields
Metric	Description
CPU usage	Displays the percentage of CPU capacity currently the VM is using (0–100%).
CPU ready Time	Displays the current, high, and low percentage of CPU ready time (0–100%).
Memory usage	Displays the percentage of memory capacity currently the VM is using (0–100%).
I/O Bandwidth	Displays separate graphs for total, write (only), and read (only) I/O bandwidth used per second (Mbps or KBps) for physical disk requests by the VM.
I/O Latency	Displays separate graphs for total, write, and read average I/O latency (in milliseconds) for physical disk requests by the VM.
IOPS	Displays separate graphs for total, write, and read I/O operations per second (IOPS) for the VM.
Usage	Displays separate graphs for current, snapshot, and shared storage usage (in GiBs) by the VM.
Working set size	Displays separate graphs for total, write, and read storage usage (in GiBs) for the VM working set size.
Network packets dropped	Displays separate graphs for the number of transmitted and received packets dropped.
Network bytes	Displays separate graphs for the amount of transmitted and received bytes (in GiBs).

Recovery Points Tab

The Recovery Points tab allows you to view the captured snapshots, restore applications from snapshots, and delete the snapshots for an application.

Note:

The Recovery Points tab applies only to single VM blueprints running with Nutanix as the provider.

To create snapshots of the single-VM or multi-VM applications that are running on Nutanix platform, use the snapshot action on the Manage tab of the application.

Table 1. Recovery Points Tab Fields
Fields	Description
Name	Displays the name of the snapshots.
Creation Time	Displays the date and time of the snapshot creation.
Location	Displays the location where the snapshot was taken.
Expiration Time	Displays the expiration time of the snapshot.
Recovery Point Type	Displays whether the snapshot type is application-consistent or crash-consistent.

Snapshots Tab

Table 1. Snapshots Tab Fields
Fields	Description
ID	Displays the ID of the snapshots. Snapshot IDs are unique and automatically generated when you take a snapshot.
Name	Displays the name of the snapshot.
Description	Displays the description of the snapshot.
Parent	Displays the parent blueprint application from which the snapshot is taken.
Creation Time	Displays the date and time when the snapshot is taken.

AMIs Tab

The AMIs tab allows you to view the captured snapshots, restore applications from snapshots, and delete the snapshots for an application.

Note: This tab is only applicable for single VM blueprints running with AWS accounts.

Table 1. AMI Tab Fields
Fields	Description
ID	Displays the ID of the snapshots. Snapshot IDs are unique and automatically generated when you take a snapshot.
Name	Displays the name of the snapshot.
Description	Displays the description of the snapshot.
Creation Time	Displays the date and time when the snapshot is taken.

Services Tab

The Services tab lists the included services in the application as displayed in the following figure. You can select the service to view the configuration details in the service inspector panel.

Note: Service tab is only applicable for multi-VM applications.

Accessing Web SSH Console

Perform the following procedure to run shell commands on a web SSH console for a service.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application.
The Overview tab is displayed.
Under the Service tab, click the service.
Click Open Terminal .

Figure. Web SSH Console Click to enlarge

The web SSH console is displayed.

Audit Tab

The Audit tab lists the action or actions that are performed on an application as displayed in the following figure. To view the detailed course of the action, click action.

You can retry a failed application action from the last failed task in case the action does not fail due to system error.

Note: The retry of failed action works only for the new applications that you deployed in the latest version of Calm. The Retry option, despite being available for all failed applications, does not work for the applications that went into the error state before upgrading to the latest version.

Brownfield Applications Overview

Brownfield Applications - Key Points

The following are the key points you must consider before you create a brownfield application.

You need administrator privileges to create a brownfield application.
For the quota utilization check and VM update configuration to work accurately, you must either select a single VM per service or the VMs that have the same configuration.
In Calm, the update configuration is stored as a single element per service and applicable from the first VM instance. When you select multiple VMs with different configurations in a service and update the configuration, the update configuration applies to the first VM instance. The same configuration is then followed for all the remaining VM instances.

Let’s say you selected VM1 and VM2 for the service with a RAM of 4 GB and 8 GB respectively. If you define the update configuration to increase the RAM by 1 GB and run the action, the update applies to VM1 to increase the RAM to 5 GB. The same configuration is then followed for VM2 to change the RAM from 8 GB to 5 GB causing undesirable results in both the update configuration and quota utilization checks.
When you add credentials for the VMs, ensure that the credentials are same for all the VMs.
After a VM is created, the VM takes some time to be listed for brownfield import.
Brownfield applications do not support snapshot and restore.

For information on how to create a brownfield application, see Creating Brownfield Application.

Creating Brownfield Application

Brownfield applications are created to manage existing VMs that are currently not managed by Calm. Perform the following procedure to create brownfield application.

About this task

Video: Creating Brownfield Application

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the Brownfield Applications tab.
The Brownfield Application page is displayed.
Click + Create Brownfield Application .
The Brownfield Import window is displayed.
Enter the blueprint application name in the Name field.
Optionally, enter a description about the application in the Description field.
Select a project from the Project list.
Click Proceed .
The brownfield application editor page is displayed.
To add a service, click + next to the service.
Enter the service name in the Service Name field.
Select one of the following type of deployment.
- Select Greenfield if all the existing VMs are manged by Calm.
- Select Brownfield if the existing VMs are currently not managed by Calm.
If you have selected Brownfield , then do the following.
1. Select the VMs from the Select Machines list.
  
  Note: For the quota utilization check and VM update configuration to work accurately, ensure that you either select a single VM or the VMs that have the same configuration.
2. Configure the connection. For more information, see Configuring Check Log-In.
3. Add credentials. For more information, see Adding Credentials.
If you have selected Greenfield , then configure the VM, package, and service. To configure VM, package, and service refer to Configure Multi-VM, Package, and Service.
Click Save .
The brownfield application is created and listed under the Brownfield Application list.

What to do next

Launch the brownfield application from the Applications tab. For more information, see Launching Brownfield Application.

Launching Brownfield Application

You must launch the configured brownfield applications to be managed by Calm.

About this task

Video: Launching Brownfield Applications

Before you begin

Ensure that you have created the brownfield applications. For more information, see Creating Brownfield Application.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the Brownfield Applications tab.
The Brownfield Application page is displayed.
Click the brownfield application that you want to launch.
The blueprint details page is displayed.
Click Launch .
The brownfield application page is displayed and the application is listed under the Applications tab.

Advanced Calm Application Actions

Installing NGT Apps

About this task

Before you begin

Ensure that NGT requirements and limitations are met. For more information, see the Prism Central Guide .
Ensure that you have configured the cluster virtual IP address.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application that you want to install NGT on.
The Overview tab is displayed.
Under Manage tab, click the Install NGT Apps play button.

Figure. Install NGT Click to enlarge

The Install NGT Apps screen appears.
To restore desired files from the VM, click the Enable Self Service Restore (SSR) check box. This step is optional.
The self-service restore (SSR) allows virtual machine administrators to do a self-service recovery from the Nutanix data protection snapshots with minimal administrator intervention. For more information, see the Prism Central Guide.

The Self-Service Restore feature is enabled for the VM.
To enable VSS, click the Enable Volume Snapshot Service (VSS) check box. This step is optional.
Volume Shadow Copy Service (VSS; also known as Shadow Copy or Volume Snapshot Service) creates an application-consistent snapshot for a VM and is limited to consistency groups consisting of a single VM. Enabling VSS allows you to take application-consistent snapshots.
Do one of the following:
1. To restart the VM after NGT installation, click Restart as soon as the install is completed .
2. To skip the restart of the VM after VM installation, click Skip restart .
Click Enter Credentials and do the following.
1. In the User name field, enter user name.
2. In the Password field, enter the password.
Do one of the following.
- To install NGT, click Done .
- To mount the NGT on the VM and install it later, click Skip and Mount .
- If NGT is already mounted on a VM, to unmount the NGT from the VM, click Unmount .
- To cancel NGT installation, click Cancel .

Managing NGT Apps

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application on which you want to manage NGT services.
The Overview tab is displayed.
Under Manage tab, click the Manage NGT Apps play button.
The Manage NGT Apps screen appears.
Under the Manage NGT Apps scree, click the Enable or Disable button to enable or disable self-service restore or volume snapshot service respectively.
Click Confirm .
The changes are saved and you can use the NGT services based on your selection.

Uninstalling NGT Apps

If you do not want to recover application details after the host VM becomes unavailable, uninstall the NGT application. Perform the following procedure to uninstall NGT services for your application.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application that you want to install NGT on.
The Overview tab is displayed.
Under Uninstalling NGT tab, click the Uninstall NGT Apps play button.
A confirmation message appears to uninstall NGT.
Click Uninstall .
NGT Apps is uninstalled from the VM.

Snapshot and Restore

Snapshot and Restore for Nutanix Platform

Snapshot and restore of an application VM that runs on a Nutanix platform involves the following configurations and actions:

Policy Definition for Snapshots
Blueprint Configuration for Snapshots
Application Launch with Snapshot Policy
Snapshot Creation
Snapshot Restore

Policy Definition for Snapshots

Local Snapshots: When you select local snapshots in the policy and use the policy for snapshots, the snapshots of the VMs reside on the same cluster as that of the VMs.
Figure. Local Snapshots Click to enlarge
Remote Snapshots: When you select remote snapshot in the policy and use the policy for snapshots, the snapshots of the VMs running on the primary cluster are stored on a remote cluster. The primary cluster and the remote cluster must be associated with the same Prism Central. When you restore the VMs, the snapshots are restored to the primary cluster to bring up the VMs.
Figure. Remote Snapshots Click to enlarge

Remote snapshots are particularly useful when your Prism Central has a computer-intensive cluster managing workloads and a storage-intensive cluster managing your data, snapshots, and so on.

For more information about creating a snapshot policy, see Creating a Snapshot Policy.

Blueprint Configuration for Snapshots

Note: The snapshot and restore configurations in a service are integrated to each other and cannot be managed individually.

For more information on snapshot and restore configuration, see Blueprint Configuration for Snapshots and Restore.

Application Launch with Snapshot Policy

For more information, see Launching a Blueprint.

Snapshot Creation

Snapshot Restore

Creating Snapshots on a Nutanix Platform

About this task

Note: Only crash-consistent snapshots are supported for multi-VM applications on a Nutanix platform.

Before you begin

Ensure that you have installed NGT Apps to take application-consistent snapshots. For more information, see Installing NGT Apps.

Procedure

Click the Applications icon in the left pane.
On the Applications page, click the application for which you want to create snapshots.
On the Manage tab, click the snapshot action you created for the application VM.
The Run Action: Snapshot window appears.
In the Snapshot Name field, enter a name for the snapshot.
You can use Calm macros to provide a unique name to the snapshot. For example, snapshot-@@{calm_array_index}@@-@@{calm_time}@@ .
For single-VM applications, select App consistent for application-consistent snapshots or Crash consistent for crash-consistent snapshots.
Note:
- You can create application-consistent snapshots after you have installed NGT Apps with VSS service enabled. For more information about snapshots, see the Nutanix Guest Tools section in the Prism Web Console Guide .
- For multi-VM application, the default snapshot type is Crash consistent .
Click Run .
The saved snapshots are available under Recovery Points tab.

What to do next

You can recover the VM details for an application from the created snapshots. For more information, see Restoring VM Details from Snapshots on a Nutanix Platform.

Restoring VM Details from Snapshots on a Nutanix Platform

You can restore the VM details of an application after the host VM becomes unavailable. Perform the following procedure to restore an application from the snapshots.

Before you begin

Ensure that you have captured the snapshots for an application. For more details, see Creating Snapshots on a Nutanix Platform.

Note:

A restored VM or a cloned VM does not have NGT service installed even if the snapshot or the source VM has NGT service installed.
Restore operation for a VM fails if the snapshot is configured with static IP address and IP pool is not configured.
When you perform a restore operation with a snapshot having static IP address configured, the restored VM comes up with a new IP address from the IP pool specified in IPAM. To ensure that the restored VM has the same static IP address as the old VM,remove the NIC that has this static IP address configured from the old VM, and attach the configuration to the new restored VM. If there is a failure during restore operation, perform an update operation on the VM to ensure that the VM is in valid state.

Procedure

Click the Applications icon in the left pane.
On the Applications page, click the application for which you want to restore the VM details from the snapshots.
On the Manage tab, click the restore action you created for the application.
The Run Action: Restore window appears.
Select a recovery point from the Select Recovery Point list.
The Select Recovery Point list shows all the snapshots taken for the application VM.
Click Run .
The application is restored from the snapshot in a new VM and the existing VM moves to power off state. If you selected the click the Delete older VM after restore check box while configuring the application blueprint, the existing VM is deleted after restoring the application VM.

Creating Snapshots on a VMware Platform

Before you begin

Ensure that the VMware Tool is installed and the VM is in powered on state to create the quiesce snapshots.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application for which you want to create snapshots.
The Overview tab is displayed.
Click Snapshot .

Figure. Snapshot VMware Click to enlarge

The Snapshot screen appears.
In the Snapshot Name field, enter a name for the snapshot.
Optionally, in the Snapshot Description field, enter a brief description about the snapshot.
Optionally, click one of the following options.
- Snapshot VM's Memory : Use this option to capture the memory of the virtual machine and the power settings. Memory snapshots take longer to create, but allow reversion to a running virtual machine state as it was when the snapshot was created.
- Enable Snapshot Quiesce : Use this option to pause or alter the state of running processes on the virtual machine and take consistent and usable backup. When you quiesce a virtual machine, VMware Tools quiesce the file system in the virtual machine. The quiesce operation pauses or alters the state of running processes on the virtual machine, especially processes that might modify information stored on the disk during a restore operation.
By default, Snapshot VM's Memory is selected. If you do not select any option, a crash-consistent snapshot is created, which you can use to reboot the virtual machine. For more information, see the VMware Documentation .
Click Save .
The saved snapshots are available under Snapshots tab.

What to do next

Restoring VM Details from Snapshots on a VMware Platform

You can restore the VM details of an application after the host VM becomes unavailable. Perform the following procedure to restore an application VM details from a snapshot.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application for which you want to restore the VM details from the snapshot you created.
The Overview tab is displayed.
Click the Snapshots tab.
The Snapshots tab lists all the snapshots created for the application.
Click Restore next to a snapshot from which you want to restore the VM details.
A confirmation message appears to restore the VM details.
Click Confirm .
The application is restored from the snapshot in the same VM.

Creating Snapshots on an AWS Platform

About this task

Before you begin

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application for which you want to create snapshots.
The Overview tab is displayed.
Click Snapshot .

Figure. Snapshot AWS Click to enlarge

The Save Snapshot screen appears.
In the AMI Name field, enter a name for the snapshot.
In the AMI Description field, enter a brief description about the snapshot. This step is optional.
Click the No Reboot check box to avoid shutting down the Amazon EC2 instance before creating the image. This step is optional.
Click Save .
The saved snapshots are available under the AMI tab.

Restoring VM Details from Snapshots on an AWS Platform

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application for which you want to restore the VM details.
The Overview tab is displayed.
Click the AMIs tab.
The AMIs tab lists all the snapshots created for the application.
Click Restore next to a snapshot from which you want to restore the VM.
A confirmation message appears to restore the VM details.
Click Confirm Restore .
The restore action creates a new VM from the snapshot that has the same configuration as the source application with a different IP address.

Creating Snapshots on an Azure Platform

Before you begin

Ensure that you have an Azure account with the required privileges to create a snapshot. For more information, see Configuring Azure User Account with Minimum Privilege.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application for which you want to create snapshots.
The Overview tab is displayed.
Click Snapshot .

Figure. Snapshot Azure Click to enlarge

The Save Snapshot screen appears.
In the Snapshot Name field, enter a name for the snapshot.
Optionally, in the Snapshot Description field, enter a brief description about the snapshot.
From the Snapshot Type list, select the storage type to store your snapshot. Your options are:
- Standard HDD
- Premium SSD
- Zone-redundant
For more information about the storage type, refer to the Azure documentation.
Click Save .
You can track the progress of the snapshot creation process on the Audit tab. The snapshots are stored on the Snapshots tab.

Restoring VM Details from Snapshots on an Azure Platform

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application for which you want to restore the VM details.
The Overview tab is displayed.
Click the Snapshots tab.
The Snapshots tab lists all the snapshots created for the applications.
Click Restore next to the snapshot from which you want to restore the VM.
The Restore VM dialog box appears.
Enter the restore name for the application VM.
Optionally, select the Delete Previous VM to delete the original VM from which the snapshot was created.
Click Confirm Restore .
The restore action creates a new VM from the snapshot that has the same configuration as the source application.

Deleting Snapshots

Perform the following procedure to delete the snapshots created for the VM under an application.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application for which you want to delete snapshots.
The Overview tab is displayed.
Do one of the following.
- If your application is deployed on a Nutanix cluster, click the Recovery Points tab.
- If your application is deployed on a VMware platform, click the Snapshots tab.
- If your application is deployed on an AWS platform, click the AMI tab.
Click the Delete button next to the snapshot you want to delete.
Click Confirm .
The snapshot is deleted.

Update VM Configurations of Running Applications

The process to update VM configuration of a running application on Nutanix is different from other providers.

Note: Updating VM configuration of a running multi-VM application is supported only on a Nutanix platform.

Update VM Configuration of an Application on Nutanix

To update configurations of a running single-VM or multi-VM applications on Nutanix, you need to perform the following steps:

Add an update configuration to the application blueprint.
For more information, see Update Configuration for VM.
Run the corresponding action to update VM specifications.
You can update VM specifications from the Manage tab of the application. While launching the update, you can define the variables, verify the updates defined for the service by looking at the original value and updated value. You can also modify the values if the component is editable. You can also check the cost difference at the top of the page before applying the changes. For more information, see Updating the VM Configuration of an Application on Nutanix.

Update VM Configuration of an Application on Other Providers

For more information about updating VM configuration on a VMware platform, see Updating the VM Configuration of an Application on a VMware Platform.
For more information about updating VM configuration on a AWS platform, see Updating the VM Configuration of an Application on an AWS Platform.
For more information about updating VM configuration on a Azure platform, see Update the VM Configuration of an Application on an Azure Platform.

Updating the VM Configuration of an Application on Nutanix

You can run the update configuration to modify the VM specifications, such as the vCPU, memory, disks, networking, or categories of a single-VM or multi-VM application.

About this task

Note:

If you update configuration of an application after cloning from a source application, the update fails if the source application has static IP address configured.
When you update configuration of an application, the CD-ROM attached to mount NGT services is removed.

Before you begin

Ensure that your blueprint developer has added the update configuration before launching the application blueprint. For more informations, see Update Configuration for VM.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application that you want to edit.
On the Manage tab, click the action corresponding to the update configuration.
The Run Action window appears.
Under the VM Configuration section, enter the change factor value in the Updated field for the vCPUs , Core per vCPU , and Memory (GiB) .
The ability to edit a VM configuration attribute and the maximum or minimum value to which the attribute can be updated depend on the application blueprint configuration. You can update only those VM configuration attributes that your blueprint developer has enabled for editing. The Updated field does not allow you to enter a value that is beyond the minimum or maximum value configured for the attribute.
Under the Disks section, edit the following.
- Enter the value in the Updated field to increase the size of the existing disk.
  Note: You cannot decrease the size of an existing disk.
  
  You can click the delete icon to remove the existing disk.
- Enter the value in the Updated field to increase or decrease the size of any new disk. The updated value must be within the maximum or minimum value your blueprint developer has configured in the application blueprint.
  You can click the delete icon to remove any new disk if your blueprint developer has enabled it in the application blueprint.
Under the Categories section, delete any existing categories from the application if your blueprint developer has enabled it in the application blueprint configuration.
Under the Network Adapters section, delete any existing NICs from the application if your blueprint developer has enabled it in the application blueprint configuration.
To launch the update configuration, click Run .

Updating the VM Configuration of an Application on a VMware Platform

You can run the update configuration to modify parameters, such as VM configurations, controllers, disks, and network adapters of a single-VM application running on a VMware platform.

About this task

Note:

If there is a mismatch of the NICs or Network setting count after updating an application VM and you try to clone the application, the cloned application fails.
You cannot add or delete the application properties simultaneously.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application that you want to edit.
On the Manage tab, click Update VM Configuration .
The Update screen for the application VM is displayed.
In the VM Location field, specify the location of the folder in which the VM must reside when you update. Ensure that you specify a valid folder name already created in your VMware account.
To create a subfolder in the location you specified, select the Create a folder/directory structure here check box and specify a folder name in the Folder/Directory Name field.

Select the Delete empty folder check box to delete the subfolder created within the specified location, in case the folder does not contain any VM resources. This option helps you to keep a clean folder structure.
Select the CPU Hot Add check box if you want to increase the VCPU count of a running VM.
Support for CPU Hot Add depends on the Guest OS of the VM.

Note: With CPU Hot Add , you can only increase the vCPU count. If you decrease the vCPU count or update the Cores per vCPU, the VM will require a restart.
Update the vCPUs and Core per vCPU count.
Select the Memory Hot Plug check box if you want to increase the memory of a running VM.
Support for Memory Hot Plug depends on the Guest OS of the VM.

Note: With Memory Hot Plug , you can only increase the memory. If you decrease the memory, the VM will require a restart.
Update the memory in the Memory field.
Under the Controllers section, you can add or update the SCSI or SATA controllers.

Note: You cannot delete a controller if it is attached to a disk.
Under the Disks section, click the + icon to add vDisks and do the following:
1. Select the device type from the Device Type list.
  You can either select CD-ROM or DISK .
2. Select the adapter type from the Adapter Type list.
  You can select IDE for CD-ROM or SCSI , IDE , or SATA for DISK.
3. Enter the size of the disk in GiB.
4. In the Location field, select the disk location.
5. If you want to add a controller to the vDisk, select the type of controller in the Controller list to attach to the disk.
  
  Note: You can add either SCSI or SATA controllers. The available options depend on the adapter type.
6. In the Disk mode list, select the type of the disk mode. Your options are:
  - Dependent : Dependent disk mode is the default disk mode for the vDisk.
  - Independent - Persistent : Disks in persistent mode behave like conventional disks on your physical computer. All data written to a disk in persistent mode are written permanently to the disk.
  - Independent - Nonpersistent : Changes to disks in nonpersistent mode are discarded when you shut down or reset the virtual machine. With nonpersistent mode, you can restart the virtual machine with a virtual disk in the same state every time. Changes to the disk are written to and read from a redo log file that is deleted when you shut down or reset.
Note:
- You can also edit the disk size and disk mode. However, decreasing the disk size of a saved configuration is not allowed.
- You can delete a saved disk. However, you cannot add and delete the disks simultaneously.
Under the Network Adapter section, click the + icon to add an NIC and cofigure the Adapter Type and Networks fields.

Note: You can only update the Networks field of an existing NIC.
Under the Tags section, select tags from the Category: Tag pairs field.
You can assign tags to your VMs so you can view the objects associated with your VMs in your VMware account. For example, you can create a tag for a specific environment and assign the tag to multiple VMs. You can then view all the VMs that are associated with the tag.
Click Update to run the update configuration.
The application with updated VM configuration is saved on the Application tab.

Updating the VM Configuration of an Application on an AWS Platform

You can run the update configuration to modify parameters, such as instance type, IAM role, security groups, tags, and storage of a single-VM application running on an AWS platform.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application that you want to edit.
On the Manage tab, click Update VM Configuration .
The Update screen for the application VM is displayed.
Under the VM Configuration section, update the instance type from the Instance Type list.
The Region , Availability Zone , Machine Image , Key Pairs , and VPC fields are automatically selected. You cannot update these fields.
To update te IAM role, select the role from the IAM Role list.
An IAM role is an AWS Identity and Access Management entity with permissions to make AWS service requests.
To enable the security group rule, select the Include Classic Security Group check box.
From the Security Groups list, select security groups.
To add tags to the application, add the key and value pair in the Key and Value fields respectively.
To update the storage of the application, do the following under the Storage section:
1. For the existing storage, update the memory in GB in the Size(GiB) field and volume type of the storage device from the Volume Type list for the root storage.
2. Click the + icon to add a storage and specify the device, size, and volume type.
Click Update to run the update configuration.
The application with updated VM configuration is saved on the Application tab.

Update the VM Configuration of an Application on an Azure Platform

You can run the update configuration to modify parameters, such as VM configurations, controllers, disks, or network adapters of a single-VM application running on an AWS platform.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application that you want to edit.
On the Manage tab, click Update VM Configuration .
The Update screen for the application VM is displayed.
Under the VM Configuration section, update the hardware profile from the Hardware Profile list.
The number of data disks and NICs depends upon the selected hardware profile. For information about the sizes of Windows and Linux VMs, see Windows and Linux Documentation.

The Instance Name , Resource Group , Location , and Availability Option fields are automatically selected. You cannot update these fields.
Under the Storage Profile section, do the following:
1. Select the Storage Type and Disk Caching Type and specify the Size and Disk LUN for the existing data disk.
2. Click the + icon to add a data disk. Select the Storage Type and Disk Caching Type and specify the Size and Disk LUN for the new data disk.
Under the Network Profile section, click the + icon to add NICs as per your requirement and do the following for each NIC:
1. Select a security group from the Security Group list.
2. Select a virtual network from the Virtual Network list.
3. Under Public IP Config , enter a name, and select an allocation method.
4. Under Private IP Config , select an allocation method.
  If you selected Static as the allocation method, then enter the private IP address in the IP Address field.
You can also update the Security Group , Subnet , and public or private IP config Allocation Method of the existing NIC.
To add tags to the application, add the key and value pair in the Key and Value fields respectively.
Click Update to run the update configuration.
The application with updated VM configuration is saved on the Application tab.

Updating Actions and Credentials of an Application

You can add or update the credential, custom actions, post delete tasks, or package uninstall tasks from the Overview tab of a single-VM application.

About this task

Note:

For this release, support for credential or action update is not available for the applications running on Xi cloud.
Dynamic variables are runtime editable by default, but you cannot mark variable as runtime editable if you add the variables while updating an application.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the single-VM application for which you want to update the credential or actions.
From the Update list, select Update Actions and Credentials .
The Update screen is displayed.
In the Credentials and Connection area, click Edit .
The Credentials and Connection page is displayed.
To add a credential, click Add Credential and do the following.
1. In the Add Credential window, enter name of the credential in the Credential Name .
2. Enter user name in the Username field.
3. Select the secret type from the Secret Type list.
  You can either select password or SSH private key.
4. Do one of the following.
  - If you have selected password, enter the password in the Password field.
  - If you have selected SSH Private Key, enter or upload the SSH private key in the SSH Private Key field.
  Optionally, if the private key is password protected, click +Add Passphrase to provide the password.
To delete an existing credential, click Delete against the credential.

Note: You can also update the user name or password of an existing credential. However, if you have logged on as an operator, you can only update the password.
Under Connection , to update the credential and check the logon status after creating the application, select the credential from the Credentials list.
You can update the credential to check the logon status only if you have enabled the Check log-in upon create field while configuring the blueprint.
Optionally, to add a post delete task for the application, in the Post Delete area, click Edit . For more information see Adding a Pre-create or Post-delete Task.
Optionally, to create a task to uninstall a package, click Edit next to the Package area and do the following.
1. Click + Task .
2. Enter the task name in the Task Name field.
3. To create the type of task, select the type from the Type list.
  The available options are:
  - Execute : To create the Execute task type, see Creating an Execute Task.
  - Set Variable : To create the Set Variable task type, see Creating a Set Variable Task.
  - HTTP Task : To create the HTTP Task type, see Creating an HTTP Task.
  - Delay : To create the Delay task type, see Creating a Delay Task.
4. To add variables to the post delete task, click the Package Uninstall Variables tab.
5. In the Variables pane, click the + icon to add variable types
6. In the Name field, enter a name for the variable.
7. From the Data Types list, select one of the base type variable or import a custom library variable type.
8. If you have selected a base type variable, configure all the variable parameters. For more information about configuring variable parameters, see Creating Variable Types.
9. If you have imported a custom variable type, all the variable parameters are automatically filled.
10. Select the Secret check-box if you want to hide the value of the variable.
11. To save the package uninstall task, click Done .
12. To establish a connection between tasks, click Add Connector and use the arrow to create connection between tasks.
13. To delete a task, click the Delete button next to the task.
  You can delete a task only while adding a new task. If you are updating the existing task, you cannot delete the task.
Optionally, to add another action to the application, click + Add Action next to the Actions area and do the following.
1. Click + Add Task .
  The task inspector panel is displayed.
2. In the task inspector panel, click the Task button.
3. Enter the task name in the Task Name field.
4. Select the type of tasks from the Type list.
  The available options are:
  - Execute : Use this task type to run eScripts on the VM. To create the Execute task type, see .Creating an Execute Task
  - Set Variable : Use this task to change variables in a blueprint. To create the Set Variable task type, see Creating a Set Variable Task.
  - HTTP Task : Use this task type to query REST calls from a URL. An HTTP task supports GET, PUT, POST, and DELETE methods. To create the HTTP Task type, see Creating an HTTP Task.
  - Delay : Use this task type to set a time interval between two tasks or actions. To create the Delay task type, see Creating a Delay Task.
  The task is created.
5. To add another task, click Add Task in the task editor area.
6. To establish a connection between tasks, click Add Connector and use the arrow to create connection between tasks.
7. To delete a task, click the Delete button next to the task.
8. To add variables to the task, click the Variables tab.
9. In the Variables pane, click the + icon to add variable types in your blueprint.
10. In the Name field, enter a name for the variable.
11. From the Data Types list, select one of the base type variable or import a custom library variable type.
12. If you have selected a base type variable, configure all the variable parameters. For more information about configuring variable parameters, see Creating Variable Types.
13. If you have imported a custom variable type, all the variable parameters are auto filled.
14. Select the Secret check-box if you want to hide the value of the variable.
15. To save the task, click Done .
To save the updated credentials and tasks for the application, click Update .

Creating an Image on a Nutanix Platform

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application from which you want to create an image.
To create an image on a single-VM application, click Create Image on the Applications page.

Figure. Create Image - Single VM Application Click to enlarge
To create an image on a multi-VM application, select the service on the Services tab, and then click Create Image in the Inspector Panel.

Figure. Create Image - Single VM Application Click to enlarge
Click the check-box next to the disk from which you want to create an image.
If the application has multiple disk images available, you can also select multiple disks.
Under the Image Details section, type a name and a description for the new image in the Name and Description fields respectively.
If you have selected multiple disk images, repeat the steps for all the Image Details sections.
Click Save .
The new image is created and available in the Image list under the VM Configuration section. You can use the image while creating a single-VM or multi-VM application.

Cloning an Application

Perform the following procedure to clone an application. The cloned application has the same VM configuration as the source application from which it is cloned.

About this task

Note: You can clone an application if you are using Nutanix, VMware, or AWS as your provider.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application on which you want to make a clone.
The Overview tab is displayed.
Click Clone .
The Clone screen appears.
In the Cloned Application Name field, enter a name for the cloned application.
In the Description field, enter a brief description about the cloned application.
Click Save .
After you successfully cloned an application, you can view the link to the cloned application in the audit log of the source application.
Note: In a Nutanix cluster, a restored VM or a cloned VM has NGT service installed if the snapshot or the source VM has NGT service installed.

What to do next

You can click the link of the cloned application to view the Overview tab of the cloned application. To view the source application, click the Clone From field on the Overview tab.

Deleting an Application

You can delete the unwanted applications from the Applications tab.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Select the check box against the application that you want to delete.
The Action list is displayed at the top of the Application page.
Select Delete from the Action list.
Delete Application window is displayed.
Click Confirm .
The application is deleted from the Application tab.

Executing User Level Actions

You can define and create custom or user-level actions while configuring a blueprint. Perform the following procedure to run the user-level actions.

Before you begin

Ensure that you have created a custom action during configuring a blueprint.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application that you want to run a user-level action.
The Overview tab is displayed.
Under the Manage tab, click the action that is created by the user.

Figure. User Level Action Click to enlarge

The custom action starts running for the application.

Executing System Level Actions

System-level actions are pre-defined actions that you can run on an application. Perform the following procedure to execute the system-level actions.

Procedure

Click the Applications icon in the left pane.
The Applications page is displayed.
Click the application that you want to execute a system generated action.
The Overview tab is displayed.
Under the Manage tab, click one of the following type of action.

Figure. System Level Action Click to enlarge
- Create : Creates an application but cannot be performed once the blueprint is created.
- Start : Starts an application.
- Restart : Restarts an application.
- Stop : Stops an application.
- Delete : Deletes an application including the underlying VMs on the provider side.
- Soft Delete : Deletes the application from the Calm environment but does not delete the VMs on the provider side.
- Install NGT Apps : Installs NGT services for your application. To install NGT, see Installing NGT Apps.
- Manage NGT Apps : Manages NGT services for your application . You can enable or disable app-consistent and crash-consistent snapshots. For more information, see Managing NGT Apps.
- Uninstall NGT Apps : Uninstalls NGT services from the VM. For more information, see Uninstalling NGT Apps.

Policies in Calm

Scheduler Overview

Scheduler allows you to schedule application action and runbook executions. You can schedule recurring jobs and one-time jobs for critical operations throughout the application life cycle.

Scheduler supports two types of entities.

Application action. You can use scheduler to schedule application actions, such as Start and Stop, to run at a particular date and time. You can also schedule any custom-defined actions and snapshot create and restore action for AHV.
Runbook execution. You can schedule runbooks to run on a particular date and time.

Creating a Scheduler Job

Create a scheduler job to perform an application action or runbook execution.

Before you begin

Ensure that you have enabled the policy engine on the Settings page. For details about enabling the policy engine, see Enabling policy Engine.

Procedure

Click the Policies icon in the left pane.
On the Scheduler tab, click the +Create Job button to create a job.
The Create Job page appears.
Figure. Create Scheduler Job Click to enlarge
In the Job Name field, type a name for the job.
Enter a description for the job. This step is optional.
From the Select Action list, select an entity type that you want the scheduler job to run on. Your options are:
- Select Application Action to schedule application actions such as start and stop, schedule any user-defined actions, or snapshot create and restore action for AHV.
- Select Execute Runbook to schedule the execution of a runbook.
From the Project list, select the project associated with your application or runbook.
Click Action Details .
If you have selected Application Action as the action type, then do the following:

Figure. Application Action Click to enlarge
1. From the Select Application list, select the application for which you want to schedule an action.
  The Select Application list displays only those applications that are associated with the project you selected on the Job Details tab.
2. From the Select Application Action list, select an application-level action or a user-defined action.
3. If you select any user-defined action, then review or edit the variables for the selected action.
If you have selected Execute Runbook as the action type, then do the following:

Figure. Execute Runbook Click to enlarge
1. From the Runbook list, select the runbook for which you want to schedule an action.
  The Runbook list displays only those runbooks that are associated with the project you selected on the Job Details tab.
2. From the Default Endpoint list, select a default endpoint for the runbook execution.
3. Verify the variables and endpoint data (such as base URLs, IP addresses, and VMs) defined for the runbook.
Click Set Schedule .
Under Schedule Type , select Recurring Job to run the job at regular intervals or One-Time Job to run the job only once.
If you have selected Recurring Job , then do the following:

Figure. Recurring Job Click to enlarge
1. Under Starts , define the start date and time in the Start on and Start at fields if you want to start the job at a particular date and time. This step is optional.
2. Under Ends , select Never to run the job indefinitely or On to define the ending date and time for the job.
3. In the Select Timezone field, select a location to define the time zone for the schedule.
4. Under How often does the job occur section, select an option in the Every field to define the frequency of the job schedule.
  You can also enter a cron expression to define the frequency of the job schedule.
  
  Depending on the option you select, you have to define specific criteria for the job frequency. For example, when you select Year , you also have to define the months, days, day of the week, hours, and minutes.
If you have selected One-Time Job , then do the following:

Figure. One-Time Job Click to enlarge
1. In the Executes on field, specify the execution date.
2. In the Executes at field, specify the execution time.
3. In the Select Timezone field, select a location to define the time zone.
Click Save .

Viewing and Updating Scheduler Jobs

You can view or update a scheduler job on the Scheduler tab of the Policies page.

About this task

Scheduler jobs have a role ownership. You can update a job that a different user has created only when you have access to the entity and collaboration is allowed in the associated project.

Procedure

Click the Policies icon in the left pane.
On the Scheduler tab, click the job that you want to view or update.

Figure. Scheduler Job Click to enlarge
On the job details page, do the following:
- On the Job Info tab, view the action type, runbook or application name, the next scheduled date, execution time or recurrence, and the state of the job. A job can show one of the following states.
  - Active: When the job is created or updated without any errors and the job has not completed the last execution and has not crossed the last execution date.
  - Inactive: When the job is created or updated with errors.
  - Expired: When the last execution of the job is complete or the job has already crossed the last execution date.
  Figure. Job Info Click to enlarge
- On the Action Details tab, view the following action details:
  - For an application action job, view the associated application and application action.
  - For a runbook job, view the associated runbook, default endpoint, variable details, and endpoint date.
- On the Execution History tab, view the scheduled time, execution status, and execution time. A job can have one of the following execution statuses.
  - Executed: When the job is already executed as scheduled.
  - Running: When the job is running as scheduled.
  - Success: When a job run is completed successfully.
  - Aborted: When you manually cancel a running or scheduled job.
  - Failed: When the job failed to execute because of some errors.
  You can also click View Logs for any executed job to go to the Audit tab and view the logs.
  
  Figure. Execution History Click to enlarge
To edit the job, click Update and edit the details of the job. For more information about the fields, see Creating a Scheduler Job.

Deleting a Scheduler Job

You can delete a scheduler job on the Scheduler tab of the Policies page.

Procedure

Click the Policies icon in the left pane.
On the Scheduler tab, click the job that you want to delete.

Figure. Scheduler Job Click to enlarge
From the Action list, click Delete .
In the Confirm Delete window, click Delete .

Approval Policy Overview

Caution: This feature is currently in technical preview. Do not use any technical preview features in a production environment.

You can also use approval policies to enable a project administrator to review all the changes that are done as part of orchestration to a critical application instance.

Approval Policy Creation and Management

The Approvals feature is disabled by default. You must enable the feature from the Settings page before creating your approval policies. See Enabling Approvals.
You must enable the policy engine to create and manage approval policies.
Each approval policy is a defined set of conditions that you configure for specific entities in Calm. See Conditions in Approval Policies.
A policy can have multiple conditions. An approval request is generated when an event meets all the conditions defined in the policy.
As a Prism Central Admin or Project Admin, you can create approval policies for runbook execution, application launch, and application day-2 operations (system-defined or user-defined actions).
A policy can have more than one set of approvers, and the approvals are done sequentially during the policy enforcement. For example, if the policy has Set 1 and Set 2 approvers, then during the policy enforcement, Set 1 approvers have to approve the request before Set 2.
The approver must be an existing user of Prism Central.
You can enable a policy to enforce the policy on an event that matches the entity, action, and conditions of the policy or disable the policy to skip policy enforcement.
You can enable or disable approvals from the Settings page to enforce all enabled approval policies in Calm or disable all approval policy enforcement.
When the policy engine VM does not respond, the runbook execution, application launch, or application day 2 operations that match the approval policy conditions fail to process completely. To process those events, you must disable policy enforcement. See Disabling Policy Enforcement.
You can clone an existing policy and edit its information to quickly create a new policy.
You can delete an approval policy.
The approval feature is currently not supported for VMware update config, Azure update config, or AWS update config.

Approval Process

An approver receives an email notification when an approval action is required for a request.
- For email notifications, the SMTP server must be configured in Prism Central. To know how to configure the SMTP server, see the Prism Central Guide .
- Notifications are sent based on the value of the E-mail field in your Active Directory. To receive approval notifications, ensure that the value is specified in the E-mail field of the Active Directory.
  Figure. Active Directory Configuration Click to enlarge
As an approver, you can view a list of all pending approval policies and can approve or reject the request with a reason. When you approve a request, the event moves to the next task. When you reject a request, the requester is notified about the rejection of the request.
As an approver, you cannot make any updates to the original approval request.
If an Active Directory group is added as an approver, any user from the group can approve the request to move the event to the next task.
A Prism Central admin cannot override and approve pending requests. All pending requests have to be approved by the approvers assigned in the enforced policy.
The Audit tab of an application displays the confirmation of the enforced policy. The Policy Execute - Approval task is added on the Audit tab, and the task remains in the POLICY_EXEC status until the request is approved or rejected.
Figure. Policy Execute - Approval Click to enlarge

Note: Limitation: Restarting the Epsilon or Policy-Epsilon container or a Calm upgrade deletes the workflows and affects the entities that are in the approval pending status.

Approvals Page

The Policy Configurations tab provides the option to create an approval policy and lists all the approval policies you created as an admin for management.
The Approval Requests tab displays all requests that you need to approve on the Pending on me tab and all requests generated on the All requests tab.
The My Requests tab displays all the requests that you created. The Pending tab displays all pending requests, and the Reviewed tab displays all requests that the approvers reviewed. When you click a request on the Pending tab, you can view the approvers who are required to approve your request. If you are an admin, you can also view the details of the enforced policy.

Creating an Approval Policy

As a Prism Central Admin or Project Admin, you can create approval policies for runbook executions, application launch, and application day-2 operations (system-defined or user-defined actions).

About this task

Before you begin

Ensure that you have enabled the policy engine on the Settings page. For details about enabling the policy engine, see Enabling policy Engine.

Procedure

Click the Policies icon in the left pane.
On the Approvals tab, click the + Create Approval Policy button to create a policy.
On the Basic Information tab , provide the basic information such as the name, project, and the entity with its associated action. To do that:

Figure. Basic Information Click to enlarge
1. In the Name field, provide a name for the approval policy.
2. In the Description field, provide a description for the policy. This step is optional.
3. From the Select the project this policy is applicable to list, select a project with which you want to associate the approval policy.
4. From the Entity Type list, select the entity to which you want to apply the approval policy.
  You can select Runbook or Application .
5. From the Action list, select the action during which the approval policy must be enforced.
  The options in the Action list appear based on the entity you selected.
6. Click Next .
On the Set Conditions tab, specify the attribute, its associated operator, and the value for the approval policy. To do that:

Figure. Policy Condition Click to enlarge
1. From the Attribute list, search the attribute for the policy enforcement.
  The options in the Attribute list change based on the entity and the associated action you selected on the Basic Information tab.
  
  To search for a provider-specific attribute, type the provider name in the Attribute field.
2. From the Operator list, select the operator for the policy attribute.
  The options in the Operator list change based on the attribute you selected as the condition.
3. In the Value field, specify the value for the attribute-operator condition.
  With some attribute-operator combinations, an information icon appears that displays the supported units or values for the Value field. You can use the information to specify the appropriate values in the field.
  
  For system actions, you must specify the name in the action_<system action> format. For example, for the Restart action, you must specify the value as action_restart . For the list of supported system action names for approval policies, see Conditions in Approval Policies.
  
  For Azure locations, you must specify the Azure location name instead of the Azure location displayName. For example, instead of using Central US (the Azure location displayName) in the Value field, use centralus (the Azure location name).
4. Click Done next to the condition name.
5. To add another condition to the policy, click + Add Condition and then specify the attribute, operator, and value.
  You can also click the Copy icon next to the condition name of an existing condition to quickly create a new condition and edit its details.
  
  You can add multiple conditions in the policy. An approval request is generated when an event meets all the conditions defined in a policy. To view the list of conditions, see Conditions in Approval Policies.
Click Next .
On the Select Approvers tab, specify the set name, approver rule, and approvers for the policy. To do that:

Figure. Select Approvers Click to enlarge
1. In the Set Name field, specify the name of the policy set.
2. Under approval rule, select one of the following:
  - Any one can approve : Select this option if you want any approvers selected for the set to approve the action.
  - All need to approve : Select this option if you want all approvers in the set to approve the action.
3. From the Approvers list, select the approvers you want to include in the set.
  You can select and add multiple approvers in a set.
4. Click Done next to the set name.
5. To create another set, click + Add Approver Set and specify the set name, approver rule, and approvers.
  You can also click the Copy icon next to the set name of an existing set to quickly create a new set and edit its details.
  
  You can add multiple sets of approvers in the policy. The approver sets are applied sequentially during the policy enforcement. For example, if you have configured Set 1 and Set 2 approvers in your policy, then during policy enforcement, Set 1 approvers have to approve the request before Set 2.
Click Save .
In the Policy Saved confirmation window, select the Yes, enable this policy button to enable the policy.
You can click the No, keep it disabled button if you want to create the policy in the disabled state.

Conditions in Approval Policies

You can configure approval policies for specific events with different set of conditions. For example, to configure an approval policy for a marketplace item, you can use the following values:

Entity Type : Application
Action : Launch
Attribute : Blueprint Name
Operator : Contains
Value : <Name of the Marketplace Item for which you want to create an approval policy>

Table 1. Conditions in Approval Policies
Entity Type and Action	Provider	Attribute	Operator
Entity Type: Runbook Action: Execute	All	Runbook Name	Equals, Contains, Like
		Task Name	Equals, Contains, Like
		Endpoint Name	Equals, Contains, Like
Entity Type: Application Action: Launch	All	Substrate Type	Equals, Contains, Like
		Blueprint Name	Equals, Contains, Like
		Application Name	Equals, Contains, Like
		Application Profile Name	Equals, Contains, Like
		Estimated Application Profile Cost	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		Account Name	Equals, Contains, Like
		VM Name	Equals, Contains, Like
		Service Name	Equals, Contains, Like
		App Replicas Count	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		OS Type	Equals, Contains, Like
	Azure Specific Attributes	Azure Tag	Equals, Contains, Like
		Azure Location	Equals, Contains, Like
		Azure Instance Name	Equals, Contains, Like
		Azure Resource Group	Equals, Contains, Like
		Azure Availability Zone	Equals, Contains, Like
		Azure Availability Set	Equals, Contains, Like
		Azure Hardware Profile	Equals, Contains, Like
		Azure Data Disk Name	Equals, Contains, Like
		Azure Data Disk Type	Equals, Contains, Like
		Azure Data Disk Size	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		Azure Network Profile Subnet	Equals, Contains, Like
		Azure Network Profile NIC Name	Equals, Contains, Like
		Azure Network Profile Virtual Network	Equals, Contains, Like
		Azure Network Profile Network Security Group	Equals, Contains, Like
	VMware Specific Attributes	VMware Instance Name	Equals, Contains, Like
		VMware Datastore Cluster	Equals, Contains, Like
		VMware Datastore	Equals, Contains, Like
		VMware Cluster	Equals, Contains, Like
		VMware Host	Equals, Contains, Like
		VMware Sockets	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		VMware Cores Per Socket	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		VMware Memory	Equals, Contains, Like
		VMware Adapter Type	Equals, Contains, Like
		VMware Network	Equals, Contains, Like
		VMware Disk Type	Equals, Contains, Like
		VMware Tag	Equals, Contains, Like
		VMware Disk Size	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		VMware Template Name	Equals, Contains, Like
	AHV Specific Attributes	AHV vCPU	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		AHV Cores Per vCPU	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		AHV Memory	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		AHV Category	Equals, Contains, Like
		AHV VPC Name	Equals, Contains, Like
		AHV vLAN Name	Equals, Contains, Like
		AHV Disk Type	Equals, Contains, Like
		AHV Disk Image Name	Equals, Contains, Like
		AHV Disk Size	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		AHV Boot Configuration Type	Equals, Contains, Like
	AWS Specific Attributes	AWS Instance Type	Equals, Contains, Like
		AWS Region	Equals, Contains, Like
		AWS Tag	Equals, Contains, Like
		AWS Root Volume Type	Equals, Contains, Like
		AWS Data Volume Type	Equals, Contains, Like
		AWS Root Disk Size	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		AWS Data Disk Size	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		AWS IAM Role	Equals, Contains, Like
		AWS VPC ID	Equals, Contains, Like
		AWS Security Group ID	Equals, Contains, Like
		AWS Subnet ID	Equals, Contains, Like
		AWS Machine Image ID	Equals, Contains, Like
	GCP Specific Attributes	GCP Instance Name	Equals, Contains, Like
		GCP Machine Type	Equals, Contains, Like
		GCP Zone	Equals, Contains, Like
		GCP Boot Disk Storage Type	Equals, Contains, Like
GCP Boot Disk Source Image		Equals, Contains, Like
GCP Labels		Equals, Contains, Like
Entity Type: Application Action: Day 2 Operation	All	Application Name	Equals, Contains, Like
		Application Profile Cost	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		App Replicas Count	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		Action Name	Equals, Contains, Like
	AHV Specific Attributes (for Update Config Only)	AHV vCPU	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		AHV Cores Per vCPU	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		AHV Memory	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
		AHV Category	Equals, Contains, Like
		AHV vLAN Name	Equals, Contains, Like
		AHV VPC Name	Equals, Contains, Like
		AHV Device Type	Equals, Contains, Like
		AHV Disk Size	Equals, Less than, Greater than, Greater than or Equals, Less than or Equals
	AHV (for Snapshots)	AHV Snapshot Location	Equals, Contains, Like
		AHV Snapshot Replica	Equals, Contains, Like
		AHV Snapshot Name	Equals, Contains, Like

The following table provides the day 2 operation with the supported attributes.

Table 2. List of Supported Attributes for Day 2 Operations
Day 2 Operation	Supported Attributes
AHV Update Config	Estimated Application Profile Cost, AHV vCPU, AHV Cores Per vCPU, AHV Memory, AHV Category, AHV VPC Name, AHV vLAN Name, AHV Disk Size, and AHV Device Type
Scale-in or Scale-out task	App Replicas Count and Application Profile Cost
AHV Snapshot Config	AHV Snapshot Name, AHV Snapshot Replica, and AHV Snapshot Location
Supported Attributes for All Day 2 Operations	Application Name and Action Name

For system actions, you must specify the name in the action_<system action> format. The following table lists the system action names supported for approval policies.

Table 3. Supported System Action Names
System Action	Names
Start	`action_start`
Restart	`action_restart`
Stop	`action_stop`
Delete	`action_delete`
Soft Delete	`action_soft_delete`
Snapshot Create	`action_snapshot_create`
Restore	`action_restore`
Update	`action_update`

Cloning an Approval Policy

To quickly create a new policy, you can clone an existing policy and edit its basic information, conditions, and approvers.

About this task

You cannot clone an approval policy that is in the Draft state.

Procedure

Click the Policies icon in the left pane.
On the Approvals tab, click the vertical ellipsis next to the policy that you want to clone and then click Clone .

Figure. Clone Approval Policy Click to enlarge
In the Clone Approval Policy window, provide a name for your new policy in the Approval policy name field, and then click the Clone button.
On the Basic Information , Set Conditions , and Select Approvers tab, edit the fields that you need to change in your new policy. For information about the fields, see Creating an Approval Policy.
Click Save to save the approval policy.
You can also clone a policy from the policy details page.

Enabling or Disabling an Approval Policy

You can enable a policy to enforce the policy on an event that matches the entity, action, and conditions of the policy or disable the policy to skip policy enforcement.

Procedure

Click the Policies icon in the left pane.
To enable or disable a policy, do one of the following on the Approvals tab:

Figure. Enable Approval Policy Click to enlarge
- To enable a disabled policy, click the vertical ellipsis next to the policy that you want to enable and then click Enable .
- To disable an enabled policy, click the vertical ellipsis next to the policy that you want to disable and then click Disable .
You can also enable or disable a policy from the policy details page.

Deleting an Approval Policy

As a Prism Central Administrator or Project Administrator, you can delete an approval policy if the policy is no longer required for the event.

Procedure

Click the Policies icon in the left pane.
On the Approvals tab, click the vertical ellipsis next to the policy that you want to delete and then click Delete .

Figure. Delete Approval Policy Click to enlarge
In the Confirm Delete window, click the Delete button.

Viewing an Approval Policy Details

After you have created a policy, you can view the details of the policy on the policy details page.

Procedure

Click the Policies icon in the left pane.
On the Approvals tab, click the policy that you want to view.

Figure. Policy Details Click to enlarge
The policy details page has the following tabs:
- Basic Information : Use this tab to view the associated project, event, and the details related to the policy creation and updates. You can also use the Enable Policy or Disable Policy option on this tab to enable or disable the policy.
- Conditions : Use this tab to view all the conditions that are associated with the policy.
- Approvers : Use this tab to view the approvers sets that are associated with the policy.
- Execution History : Use this tab to view the execution history of policies.
To clone the policy, click the Clone Policy button. See Cloning an Approval Policy.
To edit the policy, click the Edit button and update the required fields on the Basic Information , Set Conditions , and Select Approvers tab. For information about the fields, see Creating an Approval Policy.
To delete the policy, click the Delete Policy button.

Approving or Rejecting an Approval Request

An an approver, you can view a list of all pending approval policies on the Approval Requests tab and can either approve or reject the request with a reason.

About this task

Procedure

Click the Policies icon in the left pane.
On the Approvals tab, click the Approval Requests tab in the left pane.
On the Pending on me tab, do the following:
1. Click the request that is pending for approval.
2. View the Basic Information and Condition Details of the applicable policy.
  
  Figure. Pending Request for Approval Click to enlarge
  
  If you are an admin, you can click Go to Application to go to the Overview tab of the application and view the details. You can also click the View Policy tab to view the enforced policy.
3. In the Add Comment field, provide a reason for the approval or rejection of the request. This step is optional.
4. To approve the request, click the Approve button.
5. To reject the request, click the Reject button.
6. Click Yes to confirm approval or rejection.
You can also view the details of the request such as the requester, date of initiation, conditions, and so on the Pending on me tab and click the approve or reject

Library in Calm

Library Overview

You can also share tasks and variables listed as part of library across different projects. You can also customise an existing task or variable.

The Library tab lists all the published user-defined tasks and the created variable types to be used across multiple blueprints.

Note:

To list a task in the Library, you must publish the task by using Publish to Library functionality under service package while configuring your blueprints.
To view the list of variables, you must create and save the variables in the Library. For more information, see Variable Types Overview.

Variable Types Overview

While creating a custom variable type, you associate a project to the variable type. You can also share the variable type with multiple other projects using the "Share" option on the same page.

Creating Variable Types

Create variable types so that you can use the variables during blueprint creation. You can also share the created variable types across multiple projects.

Procedure

Click the Library icon in the left pane.
Click the Variable Types tab.

Figure. Variable Type Click to enlarge
Click Create Variable Type if you are creating the first variable or + Add Variable Types if you are adding a new variable to the list of variables.
The Create Variable Type window appears.
From the Projects list, select the project and click Done .

Note: You associate a project when you create a custom variable type. You can also share the variable type with other projects using the Share option. Members of the same project can use the variable types while creating a blueprint.
In the Name field, type a name for the variable type.

Figure. Variable Type Click to enlarge
In the Description field, type a brief description about the variable type.
From the Data Type list, select the base type for the variables.
The base type defines the type of variable you use while configuring a blueprint. You can select one of the following data types.
- String
- Integer
- Multi-line string
- Date
- Time
- Date Time
Select one of the following input type.
- Use Simple to add a default value.
- Use Predefined to assign static values.
- Use eScript to attach a script that is run to retrieve values dynamically at runtime. Script can return single or multiple values depending on the selected base data type.
- Use HTTP to retrieve values dynamically from the defined HTTP end point. Result is processed and assigned to the variable based on the selected base data type.
If you have selected Simple , then type the value for the variable in the Value field.
If you have selected Predefined , then type the value for the variable in the Option field. To add multiple values for the variable, do the following.
1. Click + Add Option .
2. In the Option field, type the value.
3. To make any value as default, select the Default radio button next to the value.
If you have selected eScript , then add the eScript in the field.
You can click Publish to publish the script to the library.
Note:
- You cannot add macros to eScripts.
- If you have selected Multiple Input (Array) checkbox with input type as eScript, then ensure that the script returns a list of values separated by comma. For example, CentOS, Ubuntu, Windows.
If you have selected HTTP , then configure the following fields.
1. In the Request URL field, specify the URL of the server that you want to run the methods on.
2. In the Request Method list, select a request method. The available options are GET, PUT, POST, and DELETE.
3. In the Request Body field, enter or upload the request.
4. In the Content Type list, select a type of the output format. The available options are XML , JSON, and HTML.
5. In the Connection Timeout (sec) field, type the timeout interval in seconds.
6. Select the authentication type.
  - If you select Basic , then specify the User name and Password .
  - If you select Basic (With Credentials) , then you can set the credentials in the blueprint after copying the task.
  By default, Authentication is set to None . This step is optional.
7. To verify the URL of the HTTP endpoint with a TLS certificate, select the Verify TLS Certificate check box. This step is optional.
8. To use a proxy server that you configured in Prism Central, select the Use PC Proxy configuration check box. This step is optional.
9. In the Retry Count field, type the number of attempts the system must perform to create a task after each failure. By default, the retry count is one, which indicates that the task creation procedure stops after the first attempt.
10. In the Retry Interval field, type the time interval in seconds for each retry if the task fails. By default, the Retry Interval value is set to one second.
11. Under Headers , enter the HTTP header key and value in the Key and Value fields.
12. To publish the HTTP header key and value pair as secret, select the Secrets check box.
13. Under Expected Response Options , type the Response Code for the Response Status you select. You can select Success or Failure as the response status for the task.
To check the Regex, do the following.
1. Select the Validate with Regular Expression check box.
2. Click Test Regex .
3. Provide the value for the Regex in the Value field.
  
  Note: You can enter Regex values in PCRE format. For more details, see from http://pcre.org/.
4. To test the expression, click Test Regex .
Click Save .
The Variable is saved to the Library.
To share the variable type with other projects, do the following.
1. Click Share .
  The Share Variable Type screen appears.
2. From the Select projects to share with list, add the projects with which you want to share the saved variable.
3. Click Done .

What to do next

Use this variable type while define variables in a blueprint. For more details, see Calm Blueprints Overview.

Task Library Overview

You can create tasks while configuring a blueprint and publish these tasks to the library. Calm allows you to import these published tasks while configuring other blueprints across multiple projects.

To refer to the video about task library, click here.

Adding Projects to a Task

Add tasks to a project so that you can use the tasks while configuring blueprints for the selected project.

Procedure

Click the Library icon in the left pane.
The Tasks tab displays the list of all published tasks.
Select the task that you want to assign to a project.
The task inspector panel appears.
Select project from the Project Shared With list.
Click Save .
The task is added to the project.

Deleting a Task from the Task Library

Delete unwanted tasks from the Library. The deleted tasks can no longer be used in any project while configuring a blueprint.

About this task

Video: Deleting a Task from the Task Library

Procedure

Click the Library icon in the left pane.
The Tasks tab displays the list of all published tasks.
Select the task that you want to delete.
The task inspector panel appears.
Click Delete .
In the confirmation window, click Delete .
The task is deleted from the Library.

Runbooks in Calm

Runbooks Overview

A runbook is a framework to automate routine tasks and procedures that pan across multiple applications without the involvement of a blueprint or an application.

A runbook is a collection of tasks that you can define to run sequentially at different endpoints. For more information about endpoints, see Endpoints Overview.

You can define the following types of tasks in a runbook.

Table 1. Tasks in a Runbook
Task	Description
Execute	To run Shell, PowerShell, and eScript (custom python) scripts.
Set Variable	To run a script and create variables.
Delay	To set a delay interval between two tasks or actions.
HTTP	To perform REST calls to an HTTP endpoint.
While Loop	To iterate over multiple tasks until the defined condition is met.
Decision	To define different flows or paths based on the exit condition.
VM Power On	To power on the VMs that are present in the VM endpoint type.
VM Power Off	To power off the VMs present in the VM endpoint type.
VM Restart	To restart the VMs present in the VM endpoint type.

For more information about creating a runbook, see Creating a Runbook.

Runbook Sharing across Projects

You cannot modify the runbook after it is published. You can either execute the runbook or clone the runbook within your project from the marketplace.

Creating a Runbook

A runbook is a collection of tasks that you can define to run sequentially at different endpoints.

Procedure

Click the Runbooks icon in the left pane.
Click Create Runbook .
Configure the following on the Create Runbook page.

Figure. Create Runbook Click to enlarge
- In the Name field, type a name for the runbook.
- In the Description field, type a brief description about the runbook.
- From the Project list, select a project to which you want to add the runbook.
- From the Default Endpoint list, select a default endpoint. This step is optional.
  Calm uses the default endpoint only when you do not configure any endpoint at the task level.
Click Proceed .
On the Editor tab, click +Add Task and do the following.

Figure. Runbook Editor Click to enlarge
1. In the Task Name field, type a name for the task.
2. From the Type list, select the task type.
  - Select the Execute task to run Shell, PowerShell, and eScript (custom python) scripts or Set Variable task to run a script and create variables. For more information on how to configure the Execute or Set Variable task type, see Creating a Runbook with an Execute or Set Variable Task.
  - Select the Delay task to set a delay interval between two tasks or actions. For more information on how to configure the Delay task type, see Creating a Runbook with a Delay Task.
  - Select the HTTP task to perform REST calls to an HTTP endpoint. For more information on how to configure an HTTP task type, see Creating a Runbook with an HTTP Task.
  - Select the While Loop task to iterate over multiple tasks until the defined condition is met. For more information on how to configure the While Loop task type, see Creating a Runbook with a While Loop Task.
  - Select the Decision task to define different flows or paths based on the exit conditions.
    The task is further subdivided into True and False condition. You must repeat the steps to add the tasks and configure the task type.
  - Select the VM Power Off , VM Power On , or VM Restart task to power off, power on, or restart the VMs that are present in the VM endpoint type. You must select the target VM endpoint for these task types.
To add a credential, do the following on the Configuration tab.
1. Click Add/Edit Credentials .
2. Click + Add Credential .
3. In the Name field, type a name for the credential.
4. Under the Type section, select the type of credential that you want to add.
  - Static : Credentials store keys and passwords in the credential objects that are contained in the blueprints.
  - Dynamic : Credentials fetch keys and passwords from an external credential store that you integrate with Calm as the credential provider.
5. In the Username field, type the user name.
  For dynamic credentials, specify the @@(username)@@ that you defined while configuring the credential provider.
  
  Note: A dynamic credential provider definition requires username and secret. The secret variable is defined by default when you configure your credential provider. However, you must configure a runbook in the dynamic credential provider definition for the username variable before you use the variable in different entities.
6. Select either Password or SSH Private Key as the secret type.
7. Do one of the following to configure the secret type.
  - If you have selected Static as the credential type and Password as the secret type, then type the password in the Password field.
  - If you have selected Static as the credential type and SSH Private Key as the secret type, then enter or upload the key in the SSH Private Key field.
  - If you have selected Dynamic as the credential type and Password or SSH Private Key as the secret type, then select a credential provider in the Provider field. After you select the provider, verify or edit the attributes defined for the credential provider.
  If the private key is password protected, click +Add Passphrase to provide the passphrase. For dynamic credentials, you must configure a runbook in the dynamic credential provider definition for the passphrase variable and then use the @@{passphrase}@@ variable.
  
  The type of SSH key supported is RSA. For information on how to generate a private key, see Generating SSH Key on a Linux VM or Generating SSH Key on a Windows VM.
8. Click Done .
Note: The credential that you add on the Configuration tab overrides the credential you added in the endpoint.
To add a variable, do the following on the Configuration tab. This step is optional.
1. Click Add/Edit Variable .
2. If you want to use an existing variable, select the variable that you want to use for the runbook.
3. If you want to create a new variable, click Add Variable . For more information on how to create variables, see Creating Variable Types.
To add a default endpoint, select the endpoint from the Default Endpoint list. This step is optional.

Note: The endpoint you select on the Configuration tab supersedes the endpoint you add on the Editor tab.
To add endpoint information, select the endpoint from the Endpoint list and enter a description for the endpoint in the Description field. This step is optional.
Click Save

What to do next

You can execute the runbook. For more information, see Executing a Runbook.
You can submit the runbook for approval and publishing. For more information, see Submitting a Runbook for Publishing.

Creating a Runbook with an Execute or Set Variable Task

Create a runbook with the Execute task to run Shell, PowerShell, and eScript (custom python) scripts. Create a runbook with the Set Variable task to run a script and create variables.

Before you begin

Ensure that you have created a runbook and have added a task for the runbook. For more information, see Creating a Runbook.

Procedure

On the runbook Editor tab, click +Add Task .
In the Task Name field, type a name for the task.
From the Type list, select the Execute or Set Variable task.
In the Script Type list, select Shell , Powershell , or eScript .
For Shell, PowerShell, and eScript scripts, you can access the available list of macros by using @@{ .
From the Endpoint list, select an endpoint on which you want to run the task. This step is optional.
You can also select Add New Endpoint from the list and create an endpoint. For more information about creating an endpoint, see Creating an Endpoint.

If you do not select an endpoint, then Calm uses the default endpoint that you defined while creating the runbook.
For the EScript task, select the tunnel that you can use to get access to the endpoint within the VPC in the Select tunnel to connect with list. This step is optional.
The Select tunnel to connect with list shows only those tunnels that are allowed in the project you selected for the endpoint.
For the Shell or PowerShell script type, select an existing credential from the Credential list or add a new credential to override the credential for the task. This step is optional. To add a new credential, do the following:
1. In the Credential list, select Add New Credential .
2. In the Name field, type a name for the credential.
3. Under the Type section, select the type of credential that you want to add.
  - Static : Credentials store keys and passwords in the credential objects that are contained in the blueprints.
  - Dynamic : Credentials fetch keys and passwords from an external credential store that you integrate with Calm as the credential provider.
4. In the Username field, type the user name.
  For dynamic credentials, specify the @@(username)@@ that you defined while configuring the credential provider.
  
  Note: A dynamic credential provider definition requires username and secret. The secret variable is defined by default when you configure your credential provider. However, you must configure a runbook in the dynamic credential provider definition for the username variable before you use the variable in different entities.
5. Select either Password or SSH Private Key as the secret type.
6. Do one of the following to configure the secret type.
  - If you have selected Static as the credential type and Password as the secret type, then enter the password in the Password field.
  - If you have selected Static as the credential type and SSH Private Key as the secret type, then enter or upload the key in the SSH Private Key field.
  - If you have selected Dynamic as the credential type and Password or SSH Private Key as the secret type, then select a credential provider in the Provider field. After you select the provider, verify or edit the attributes defined for the credential provider.
  If the private key is password protected, click +Add Passphrase to provide the passphrase. For dynamic credentials, you must configure a runbook in the dynamic credential provider definition for the passphrase variable and then use the @@{passphrase}@@ variable.
  
  The type of SSH key supported is RSA. For information on how to generate a private key, see Generating SSH Key on a Linux VM or Generating SSH Key on a Windows VM.
7. Click Done to add the credential.
In the Script panel, enter or upload the script that you want to run.
To test the script in the Calm playground, click Test script and do the following.
You can use the Calm playground to run the script, review the output, and make any required changes.
1. On the Authorization tab, specify the IP Address and Port .
2. In the Select tunnel to connect with list, select the tunnel that you can use to get access to the VM within the VPC. This step is optional.
  The Select tunnel to connect with list shows only those tunnels that are allowed in the project you selected for the endpoint.
3. Specify the Credential for the test machine.
  You can also specify the Username and Password for the test machine instead of the credential.
4. Click Login and Test .
5. On the Test Script tab, view or edit your script in the Script field.
6. For macros in your script, provide the values in the macro inspector panel.
7. Click Assign and Test .
  The Output field displays the test result.
8. To go back to the Runbook Editor page, click Done .
To publish this task to the task library, click Publish to Library and then click Publish .
Click Save to save the runbook.

Creating a Runbook with a Delay Task

Create a runbook with the Delay task to set a delay interval between two tasks or actions.

Before you begin

Ensure that you have created a runbook and have added a task for the runbook. For more information, see Creating a Runbook.

Procedure

On the runbook Editor tab, click +Add Task .
In the Task Name field, type a name for the task.
From the Type list, select the Delay task.
In the Sleep Interval field, type the sleep time interval in seconds for the task.
Click Save to save the runbook.

Creating a Runbook with an HTTP Task

Create a runbook with the HTTP task to perform REST calls to an HTTP endpoint.

Before you begin

Ensure that you have created a runbook and have added a task for the runbook. For more information, see Creating a Runbook.

Procedure

On the runbook Editor tab, click +Add Task .
In the Task Name field, type a name for the task.
From the Type list, select the HTTP task.
From the Endpoint list, select the endpoint where you want to execute the HTTP task. This step is optional.
In the Request Method list, select one of the following request methods.
- Select GET to retrieve data from a specified resource.
- Select POST to send data to a server to create a resource, and enter or upload the POST request in the Request Body field.
- Select DELETE to send data to a server to delete a resource, and enter or upload the DELETE request in the Request Body field.
- Select PUT to send data to a server to update a resource, and enter or upload the PUT request in the Request Body field.
In the Relative URL field, enter the URL of the server on which you want to run the methods.
In the Content Type list, select the type of the output format.
The available options are HTML , JSON , and XML .
In the Headers section, type the HTTP header key and value in the Key and Value fields respectively.
If you want to publish the HTTP header key and value pair as secrets, select the Secret check box.
In the Expected Response Options area, do the following configurations.
1. Select Success or Failure as the Response Status , and type the Response Code for the status.
  
  Note: If the response code is not defined, then by default all the 2xx response codes are marked as success, and any other response codes are marked as failure.
2. Under Set Variables from response , type the variables for the specified response path. The example of json format is $.x.y and xml format is //x/y . For more information about json path syntax, see http://jsonpath.com.
  
  Note: To retrieve the output format in HTML format, add a * in the syntax.
If you want to test the script in the Calm playground, click Test Request .
The test result appears in the Output field .
Click Save to save the runbook.

Creating a Runbook with a While Loop Task

Create a runbook with the While Loop task to iterate over multiple tasks until the defined condition is met.

Before you begin

Ensure that you have created a runbook and have added a task for the runbook. For more information, see Creating a Runbook.

Procedure

On the runbook Editor tab, click +Add Task .
In the Task Name field, type a name for the task.
From the Type list, select the While Loop task.
In the Iterations field, type the number of times you want to iterate the task till the task meet a condition. The default value is 1.
From the Exit Condition list, select a condition after which the task iteration must stop. The available options are as follows.
- - Select Success if you want to stop the task iteration after the status of the task is success.
  - Select Failure if you want stop the task iteration after the status of the task is failure.
  - Select Don't care if you want to continue the task iteration irrespective of the status of the task.
Click Save to save the runbook.

Submitting a Runbook for Publishing

About this task

Video: Submitting a Runbook for Publishing

Procedure

Click the Runbooks icon in the left pane.
Do one of the following:
- To publish an existing runbook, click to open a runbook from the list.
- To publish a new runbook, click Create Runbook and create a new runbook. For information on how to create a runbook, see Creating a Runbook.
On the Runbook Editor page, click the Publish button.
The Publish Runbook dialog box appears.
Figure. Publish Runbook Click to enlarge
To publish a new runbook, do the following.
1. Select New Marketplace Runbook .
2. Provide a name for the runbook to be used at the marketplace.
3. Enable the Publish with secrets toggle button to encrypt secret values such as the credential passwords, keys, and secret variables.
  By default, the secret values from the runbook are not preserved when you publish them. Enable this option if you do not want to fill the secret values or to be patched from the environment when you execute the runbook.
4. Enable the Publish with endpoints toggle button to preserve the endpoint values.
  By default, the endpoints from the runbook are not preserved when you publish them. Enable this option if you do not want to fill the endpoint values when you execute the runbook.
5. In the Initial Version field, type a new version number.
6. Provide a description for the runbook. This step is optional.
To publish a newer version of an already published runbook, do the following:
1. Select New version of an existing Marketplace Runbook .
2. From the Marketplace Item list, select the existing runbook.
3. Enable the Publish with secrets and Publish with endpoints toggle buttons.
4. Specify the version for the runbook for the existing runbook.
5. Provide a description for the runbook. This step is optional.
Click Submit for Approval .
Calm submits the runbook to the Marketplace Manager for your admin to approve and publish the runbook to the Marketplace.

What to do next

Executing a Runbook

You can execute a runbook to run the tasks sequentially on an endpoint.

About this task

Video: Executing a Runbook

Procedure

Click the Runbooks icon in the left pane.
Select the runbook that you want to execute.

Figure. Execute Runbook Click to enlarge
From the Action list, select Execute .
The Execute Runbook page appears.
To change the default endpoint for the execution, select an endpoint from the Endpoints list. This step is optional.
To update the added variable to the Runbook, click the respective variable field and edit the variable. This step is optional.

Note: You can update the variable only if you mark the variable as runtime editable while adding it in the Runbook.
Click Execute .
The runbook execution starts and you are directed to the Runbook execution page.

What to do next

You can view all the executions in the Execution History tab.

Deleting a Runbook

Perform the following procedure to delete a runbook.

About this task

Video: Deleting a Runbook

You must have the role of an administrator or a developer to delete a runbook.

Procedure

Click the Runbooks icon in the left pane.
Select the runbook that you want to delete.
From the Action list, select Delete .
In the Confirm Delete window, click Delete .

Endpoints in Calm

Endpoints Overview

Endpoints are the target resources where the tasks defined in a runbook or blueprint are run.

The endpoints are collection of IP addresses or VMs. The collection of VMs can be a static selection or can be dynamic with filter rules applied.

You have the following types of endpoints.

A Windows machine
A Linux machine
An HTTP service endpoint

To know how to create an endpoint, see Creating an Endpoint.

Endpoints with Virtual Machines

Creating an Endpoint

Create an endpoint to run the tasks that you define in a runbook or blueprint.

About this task

You must have the role of an administrator or a developer to create an endpoint.

Procedure

Click the Endpoints icon in the left pane.
Click Create Endpoint .
In the Create Endpoint window, type a name and description for the endpoint.
From the Project list, select the project to which you want to assign the endpoint.
Select the type of the endpoint. You can select Windows , Linux , or HTTP as the endpoint type.
If you have selected HTTP as the endpoint type, do the following.

Figure. HTTP Endpoint Type Click to enlarge
1. In the Select tunnel to connect with list, select the tunnel that you can use to get access to the endpoint within the VPC. This step is optional.
  The Select tunnel to connect with list shows only those VPC tunnels that are allowed in the project that you selected for the endpoint.
2. In the Base URL field, enter the base URL of the HTTP endpoint. A base URL is the consistent part of the endpoint URL.
3. To verify the URL of the HTTP endpoint with a TLS certificate, click the Verify TLS Certificate check box. Use this option to securely access the endpoint. This step is optional.
4. To use a proxy server that you configured in Prism Central, select the Use PC Proxy configuration check box.
  
  Note: Ensure that Prism Central has the appropriate HTTP proxy configuration.
5. In the Retry Count field, type the number of attempts the system must perform to create a task after each failure.
  The default value is 1, which implies that the task creation process stops after the first attempt.
6. In the Retry Interval field, type the time interval in seconds for each retry if the task fails. The default value is 10 seconds.
7. In the Connection Timeout field, type the time interval in seconds after which the connection attempt to the endpoint stops. The default value is 120 seconds.
8. To add an authentication method to connect to an HTTP endpoint, click Authentication and select Basic from the Type field. Type a username and password to authenticate the endpoint. This step is optional.
  By default, the authentication type is set to None .
If you have selected Windows or Linux as the endpoint type, then select a target type. The target type can be IP Addresses or VMs .

Figure. Endpoint Target Type Click to enlarge
If you have selected IP Addresses as the target type, then do the following:
1. In the Select tunnel to connect with list, select the tunnel that you can use to get access to the endpoint within the VPC. This step is optional.
  The Select tunnel to connect with list shows only those VPC tunnels that are allowed in the project that you selected for the endpoint.
2. In the IP Addresses field, type the IP address to access the endpoint device.
If you have selected VMs as the target type, do the following:
1. In the Account list, select an account.
  The Account list displays all the provider accounts that you configured in the project. After you select the provider account, the window displays the VMs associated with the provider account.
2. To filter VMs, use the Filter By options.
  You can use different attribute, operator, and value criteria to get accurate results.
3. Select the VMs that you want to add to your endpoint.
  You can also use the Auto Select VMs toggle button to automatically add the filtered VMs to your endpoint.
  
  Note: The resolution of the VMs from the filters happens at the runbook execution.
In the Connection Protocol field, select the connection protocol to access the endpoint. You can select either HTTP or HTTPS . This field appears only for the Windows endpoint type.
In the Port field, type the port number to access the endpoint.
Add a credential for Windows or Linux endpoint type to access the endpoint.
1. Click Credential .
2. Select the type of credential that you want to add under the Type section.
  - Static : Credentials store keys and passwords in the credential objects that are contained in the blueprints.
  - Dynamic : Credentials fetch keys and passwords from an external credential store that you integrate with Calm as the credential provider.
3. In the Username field, type a username for the endpoint credential.
  For dynamic credentials, specify the @@(username)@@ that you defined while configuring the credential provider.
  
  Note: A dynamic credential provider definition requires username and secret. The secret variable is defined by default when you configure your credential provider. However, you must configure a runbook in the dynamic credential provider definition for the username variable before you use the variable in different entities.
4. Select either Password or SSH Private Key as the secret type.
5. Do one of the following to configure the secret type.
  - If you have selected Static as the credential type and Password as the secret type, then type the password in the Password field.
  - If you have selected Static as the credential type and SSH Private Key as the secret type, then enter or upload the key in the SSH Private Key field.
  - If you have selected Dynamic as the credential type and Password or SSH Private Key as the secret type, then select a credential provider in the Provider field. After you select the provider, verify or edit the attributes defined for the credential provider.
  If the private key is password protected, click +Add Passphrase to provide the passphrase. For dynamic credentials, you must configure a runbook in the dynamic credential provider definition for the passphrase variable and then use the @@{passphrase}@@ variable.
  
  The type of SSH key supported is RSA. For information on how to generate a private key, see Generating SSH Key on a Linux VM or Generating SSH Key on a Windows VM.
Click Save .

What to do next

You can add the endpoint to a runbook. For more details, see Creating a Runbook.

Deleting an Endpoint

Perform the following procedure to delete a endpoint.

About this task

You must have the role of an administrator or a developer to delete an endpoint.

Procedure

Click the Endpoints icon in the left pane.
Select the endpoint that you want to delete.
From the Action list, select Delete .
In the Confirm Delete window, click Delete .

Calm Backup and Restore

Calm Data Backup and Restore

You can take a backup of the Calm data to a specified location on your machine and restore the data to a new Prism Central. You back up the following data:

Zookeeper Data
- Calm instance data
Elastic Search Data
- Task Run Logs
- App Icons
- Marketplace branding Logos
IDF PC Tables
- project
- Entity Capabilities
IDF Calm Tables
- "management_server_account"
- "marketplace_item"
- "nucalm_action"
- "nucalm_action_run"
- "nucalm_app_beam_status"
- "nucalm_app_blueprint"
- "nucalm_app_failover_status"
- "nucalm_application"
- "nucalm_application_cfg"
- "nucalm_app_protection_status"
- "nucalm_budget"
- "nucalm_consumption"
- "nucalm_cost"
- "nucalm_credential"
- "nucalm_deployment"
- "nucalm_deployment_cfg"
- "nucalm_deployment_element"
- "nucalm_environment"
- "nucalm_library_task"
- "nucalm_library_variable"
- "nucalm_lifecycle"
- "nucalm_loadbalancer"
- "nucalm_loadbalancer_cfg"
- "nucalm_package"
- "nucalm_package_cfg"
- "nucalm_package_element"
- "nucalm_platform_instance_element"
- "nucalm_policy_rule"
- "nucalm_price_item"
- "nucalm_price_item_status"
- "nucalm_published_service"
- "nucalm_published_service_cfg"
- "nucalm_recovery_plan_job_sync_status"
- "nucalm_runbook"
- "nucalm_run_log"
- "nucalm_secret"
- "nucalm_service"
- "nucalm_service_cfg"
- "nucalm_service_element"
- "nucalm_service_upgrade_history"
- "nucalm_service_version"
- "nucalm_substrate"
- "nucalm_substrate_cfg"
- "nucalm_substrate_element"
- "nucalm_sync_status"
- "nucalm_task"
- "nucalm_user_file"
- "nucalm_variable"
- "nucalm_worker_state"

Backing up Calm Data

You can take a backup of the entire Calm data to a specified location on your machine.

About this task

To know how to back up Calm data on an IAMV2-enabled setup, see Backing up Calm Data in an IAMV2-Enabled Setup.

Procedure

Log on to the Calm container by using the SSH session and run the following command.
docker exec -it nucalm bash

The calmdata binary is available in the /home/calm/bin folder.
In the SSH terminal, change the directory to the Calm container by running the following command.
# cd /home/calm/bin
Create a folder to store the backup data. The backup folder must be empty.
To take a backup of the Calm data, run the following command.
```
 # ./calmdata backup --dump-folder <folder>
```
The default folder is located in /tmp/default path. Replace folder with the new folder.

Note: Ensure that the the backup folder has only the calmdata tar file dump.
To get the backup dump from the container, run the following command.
```
docker cp <nucalm_container_id>:<backup_tar_file_path> <PC_path_to_copy>
```
For example,
```
docker cp f4af4798e47d:/backup/3.5.2_backup.tar /home/nutanix/local_backup/
```
The command copies the calmdata backup tar file from the nucalm container to the Prism Central file system.
Use the scp command to copy the calmdata backup tar file from the Prism Central file system to the new Prism Central.
Login to the new Prism Central.
To copy the calmdata backup tar file into the nucalm container of the new Prism Central, run the following command.
```
docker cp <back_up_tar_file_path> <nucalm_container_id>:<restore_path_dump_folder>
```

What to do next

To know how to restore Calm data, see Restoring Calm Data.

Backing up Calm Data in an IAMV2-Enabled Setup

You can take a backup of the entire Calm data to a specified location on your machine.

Procedure

Log on to the Calm container by using the SSH session and run the following command.
docker exec -it nucalm bash

The calmdata binary is available in the /home/calm/bin folder.
In the SSH terminal, change the directory to the Calm container by running the following command.
# cd /home/calm/bin
Create a folder to store the backup data. The backup folder must be empty.
To take a backup of the Calm data, run the following command.
```
 # ./calmdata backup --dump-folder <folder>
```
The default folder is located in /tmp/default path. Replace folder with the new folder.

Note: Ensure that the the backup folder has only the calmdata tar file dump.
Run the IAM backup script to take a backup of the ACPs.
1. SSH to the leader node of the Prism Central.
2. Run the following command to find the leader node in a scale-out setup:
```
sudo kubectl -s 0.0.0.0:8070 -n ntnx-base get pods
```
  The command must return all point of deliveries without any error.
3. Run the following commands on the leader node.
```
cd ~/cluster/bin/
```
```
vi backup_iam.sh
```
4. Copy the script from the Nutanix Downloads page and paste the script in the backup_iam.sh file.
5. Run the following script.
```
sh backup_iam.sh
```
  The backup zipped file will be saved on this PC at /usr/local/nutanix/iam-backup .
To get the backup dump from the container, run the following command.
```
docker cp <nucalm_container_id>:<backup_tar_file_path> <PC_path_to_copy>
```
For example,
```
docker cp f4af4798e47d:/backup/3.5.2_backup.tar /home/nutanix/local_backup/
```
The command copies the calmdata backup tar file from the nucalm container to the Prism Central file system.
Use the scp command to copy the calmdata backup tar file from the Prism Central file system to the new Prism Central.
Use the scp command to copy the IAM backup zipped file from the Prism Central file system to the following location on the new Prism Central.
/usr/local/nutanix/iam-backup
Login to the new Prism Central.
To copy the calmdata backup tar file into the nucalm container of the new Prism Central, run the following command.
```
docker cp <back_up_tar_file_path> <nucalm_container_id>:<restore_path_dump_folder>
```

What to do next

To know how to restore Calm data, see Restoring Calm Data.

Restoring Calm Data

You can restore the Calm data to a new Prism Central using a backup you took earlier.

About this task

For more information about backing up the Calm data, see Backing up Calm Data.

Note: Before you restore your Calm data, ensure that:

You do not have any running applications or blueprints on the Prism Central on which you restore the Calm data. Any applications or blueprints available on your Prism Central might not work properly after you restore the data.
The Prism Central on which you restore the data has the same Prism Elements as that of the backed-up Prism Central. In case of any variations, the accounts or projects associated with your local Prism Element through the Prism Central might not work properly.
The restored version of the Calm must be the same as that of the backed-up version. For example, if you have taken a backup of version 3.0, you must restore using version 3.0. You cannot use version 3.1 or 3.2 to restore the Calm data.
You have enabled Calm on the destination Prism Central, and the Calm instance is new.

Procedure

To restore the backed up Calm data, do the following:

With the session, run the following command on the new Prism Central.
```
# ./calmdata restore --dump-folder <folder> 
```
The default folder is located in the /tmp/default path. Replace the folder with the new folder.

Run the following command.

docker exec -ti nucalm bash
activate; 
code ; 
python scripts/update_policy_vm_host_data.pyc

Log on to the Policy Engine VM and run the following commands:

sudo systemctl stop policy-container
sudo systemctl stop policy-epsilon-container
sudo systemctl stop chronos-container
docker rm -f policy
docker rm -f policy-epsilon
docker rm -f chronos
sudo systemctl start policy-container
sudo systemctl start policy-epsilon-container
sudo systemctl start chronos-container

Additonally, run the IAM restore script if you have an IAMv2-enabled setup.
1. SSH to the Prism Central leader node to restore.
2. Run the following commands on the leader node.
```
cd ~/cluster/bin/
```
```
vi restore_iam_from_file.sh
```
3. Copy the script from the Nutanix Downloads page and paste the script in the restore_iam_from_file.sh file.
4. Run the following script.
```
sh restore_iam_from_file.sh
```

Flag Options for Backup

Use the following flag options for your Calm data backup:

Table 1. Flag Options
Options	Description
dump-folder	The folder where you want to place the backup data. The default folder is located at /tmp/default . Note: Create this folder before taking the backup. When you restore, the restore binary must be present at this location. Example: `# ./calmdata backup --dump-folder="/tmp/new"`
max-threads	The maximum number of threads to use to take the backup. The default value is 5. Example: `# ./calmdata backup --max-thread=5`
fetch-limit	The maximum number of entries to fetch in batches of 100 per call. The default and the maximum value is 100. Decreasing the value of fetch-limit increases the time taken to back up Calm data. Example: `# ./calmdata backup --fetch-limit=100`
idf-timeout	The timeout for IDF (database). Increase the value of IDF timeout if you encounter backup failure due to timeout. The default value is 60. Example: `# ./calmdata backup --idf-timeout=120`
backup-deleted-entities	The flag to include deleted entities in the backup. The backup does not include deleted entities when the value is False. The default value is True. Example: `# ./calmdata backup --backup-deleted-entities=false`

Backing Up and Restoring Policy Engine Database

About this task

You must run the backup and restore commands from your Prism Central instance.

Procedure

To create a backup of your policy engine, run the following command:
ssh nutanix@<policy_vm_ip> /home/nutanix/scripts/backup.sh

Where <policy_vm_ip> is the IP address of the policy engine VM.

This command creates a local backup on the policy engine VM at /home/nutanix/data/backups/ .

To restore the policy engine to a new policy engine VM, copy the backup to Prism Central using the scp command and then to the new policy engine VM.

Note: When you run the command to create the backup, the policy engine remains unavailable until the backup is created.
To view all the backups that are available on your policy engine VM, use the following command:
ssh nutanix@<policy_vm_ip> /home/nutanix/scripts/restore.sh –-list
To restore policy engine to its earlier state, run the following command:
ssh nutanix@<policy_vm_ip> /home/nutanix/scripts/restore.sh -f=<backup_name>

Where <policy_vm_ip> is the IP address of the policy engine VM and <backup_name> is the local backup file available on the policy engine VM.

Note: When you run the command to restore your policy engine on the existing policy engine VM, the policy engine remains unavailable until it is restored.

Calm Scripts

Sample Scripts for Installing and Uninstalling Services

Calm task library public repository contains scripts for installing and uninstalling different services. To access the repository, click here.

Sample Scripts to Configure Non-Managed AHV Network

The following sections provide the sample scripts of Cloud-init and SysPrep to configure the static IP address range for non-managed AHV network.

Cloud-init Script for Linux

#cloud-config
cloud_config_modules: 
  - resolv_conf
  - runcmd
write_files:
  - path: /etc/sysconfig/network-scripts/ifcfg-eth0
    content: |
      IPADDR=10.136.103.226
      NETMASK=255.255.255.0
      GATEWAY=10.136.103.1
      BOOTPROTO=none
      ONBOOT=yes
      DEVICE=eth0

runcmd:
  - [ifdown, eth0]
  - [ifup, eth0]
  
manage_resolv_conf: true
resolv_conf:
  nameservers: ['8.8.4.4', '8.8.8.8']
  searchdomains:
    - foo.example.com
    - bar.example.com
  domain: example.com
  options:
    rotate: true
    timeout: 1

SysPrep Script for Windows

<?xml version="1.0" encoding="UTF-8"?>
<unattend xmlns="urn:schemas-microsoft-com:unattend">
   <settings pass="specialize">
      <component xmlns:wcm="http://schemas.microsoft.com/WMIConfig/2002/State" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="Microsoft-Windows-Shell-Setup" processorArchitecture="amd64" publicKeyToken="31bf3856ad364e35" language="neutral" versionScope="nonSxS">
         <ComputerName>Windows2016</ComputerName>
         <RegisteredOrganization>Nutanix</RegisteredOrganization>
         <RegisteredOwner>Acropolis</RegisteredOwner>
         <TimeZone>UTC</TimeZone>
      </component>
      <component xmlns:wcm="http://schemas.microsoft.com/WMIConfig/2002/State" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="Microsoft-Windows-UnattendedJoin" processorArchitecture="amd64" publicKeyToken="31bf3856ad364e35" language="neutral" versionScope="nonSxS">
         <Identification>
            <Credentials>
               <Domain>contoso.com</Domain>
               <Password>secret</Password>
               <Username>Administrator</Username>
            </Credentials>
            <JoinDomain>contoso.com</JoinDomain>
            <UnsecureJoin>false</UnsecureJoin>
         </Identification>
      </component>
      <component xmlns:wcm="http://schemas.microsoft.com/WMIConfig/2002/State" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="Microsoft-Windows-TCPIP" processorArchitecture="amd64" publicKeyToken="31bf3856ad364e35" language="neutral" versionScope="nonSxS">
         <Interfaces>
            <Interface wcm:action="add">
               <Identifier>Ethernet</Identifier>
               <Ipv4Settings>
                  <DhcpEnabled>false</DhcpEnabled>
                  <RouterDiscoveryEnabled>true</RouterDiscoveryEnabled>
                  <Metric>30</Metric>
               </Ipv4Settings>
               <UnicastIpAddresses>
                  <IpAddress wcm:action="add" wcm:keyValue="1">10.0.0.2/24</IpAddress>
               </UnicastIpAddresses>
               <Routes>
                  <Route wcm:action="add">
                     <Identifier>10</Identifier>
                     <Metric>20</Metric>
                     <NextHopAddress>10.0.0.1</NextHopAddress>
                     <Prefix>0.0.0.0/0</Prefix>
                  </Route>
               </Routes>
            </Interface>
         </Interfaces>
      </component>
      <component xmlns:wcm="http://schemas.microsoft.com/WMIConfig/2002/State" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="Microsoft-Windows-DNS-Client" processorArchitecture="amd64" publicKeyToken="31bf3856ad364e35" language="neutral" versionScope="nonSxS">
         <UseDomainNameDevolution>true</UseDomainNameDevolution>
         <DNSDomain>contoso.com</DNSDomain>
         <Interfaces>
            <Interface wcm:action="add">
               <Identifier>Ethernet</Identifier>
               <DNSDomain>contoso.com</DNSDomain>
               <DNSServerSearchOrder>
                  <IpAddress wcm:action="add" wcm:keyValue="1">10.0.0.254</IpAddress>
               </DNSServerSearchOrder>
               <EnableAdapterDomainNameRegistration>true</EnableAdapterDomainNameRegistration>
               <DisableDynamicUpdate>true</DisableDynamicUpdate>
            </Interface>
         </Interfaces>
      </component>
      <component xmlns="" name="Microsoft-Windows-TerminalServices-LocalSessionManager" publicKeyToken="31bf3856ad364e35" language="neutral" versionScope="nonSxS" processorArchitecture="amd64">
         <fDenyTSConnections>false</fDenyTSConnections>
      </component>
      <component xmlns="" name="Microsoft-Windows-TerminalServices-RDP-WinStationExtensions" publicKeyToken="31bf3856ad364e35" language="neutral" versionScope="nonSxS" processorArchitecture="amd64">
         <UserAuthentication>0</UserAuthentication>
      </component>
      <component xmlns:wcm="http://schemas.microsoft.com/WMIConfig/2002/State" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="Networking-MPSSVC-Svc" processorArchitecture="amd64" publicKeyToken="31bf3856ad364e35" language="neutral" versionScope="nonSxS">
         <FirewallGroups>
            <FirewallGroup wcm:action="add" wcm:keyValue="RemoteDesktop">
               <Active>true</Active>
               <Profile>all</Profile>
               <Group>@FirewallAPI.dll,-28752</Group>
            </FirewallGroup>
         </FirewallGroups>
      </component>
   </settings>
   <settings pass="oobeSystem">
      <component xmlns:wcm="http://schemas.microsoft.com/WMIConfig/2002/State" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="Microsoft-Windows-Shell-Setup" processorArchitecture="amd64" publicKeyToken="31bf3856ad364e35" language="neutral" versionScope="nonSxS">
         <UserAccounts>
            <AdministratorPassword>
               <Value>secret</Value>
               <PlainText>true</PlainText>
            </AdministratorPassword>
         </UserAccounts>
         <AutoLogon>
            <Password>
               <Value>secret</Value>
               <PlainText>true</PlainText>
            </Password>
            <Enabled>true</Enabled>
            <Username>Administrator</Username>
         </AutoLogon>
         <FirstLogonCommands>
            <SynchronousCommand wcm:action="add">
               <CommandLine>cmd.exe /c netsh firewall add portopening TCP 5985 "Port 5985"</CommandLine>
               <Description>Win RM port open</Description>
               <Order>1</Order>
               <RequiresUserInput>true</RequiresUserInput>
            </SynchronousCommand>
         </FirstLogonCommands>
         <OOBE>
            <HideEULAPage>true</HideEULAPage>
            <SkipMachineOOBE>true</SkipMachineOOBE>
         </OOBE>
      </component>
      <component xmlns:wcm="http://schemas.microsoft.com/WMIConfig/2002/State" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="Microsoft-Windows-International-Core" processorArchitecture="amd64" publicKeyToken="31bf3856ad364e35" language="neutral" versionScope="nonSxS">
         <InputLocale>en-US</InputLocale>
         <SystemLocale>en-US</SystemLocale>
         <UILanguageFallback>en-us</UILanguageFallback>
         <UILanguage>en-US</UILanguage>
         <UserLocale>en-US</UserLocale>
      </component>
   </settings>
</unattend>

Supported eScript Modules and Functions

Calm supports the following eScript modules.

Table 1. Supported eScript Modules
Module	Module supported as
datetime	_datetime
re	re
difflib	difflib
base64	base64
pprint	pprint
pformat	pformat
simplejson	json
ujson	ujson
yaml	yaml
Uuid	uuid
requests	requests
boto3	boto3
azure	azure
googleapiclient	google
kubernetes	kubernetes

The following example displays the usage of the boto3 module.

import boto3
ec2 = boto3.client('ec2', aws_access_key_id='{}', aws_secret_access_key='{}', region_name='us-east-1')
print ec2.describe_regions()

The following example displays the usage of the Azure module.

# subscription_id macro contains your Azure Subscription ID
# client_id macro contains your Client ID
# tenant macro contains you Tenant ID
from azure.common.credentials import ServicePrincipalCredentials
from azure.mgmt.resource import ResourceManagementClient
credentials = ServicePrincipalCredentials(
    client_id=@@{client_id}@@,
    secret='secret',
    tenant=@@{tenant}@@
)
client = ResourceManagementClient(credentials, @@{subscription_id}@@)
for item in client.resource_groups.list():
    print(item)

The following example displays the usage of the GCP module.

from google.oauth2 import service_account
gcp_project = '@@{cred_gcp.username}@@'
gcp_secret = @@{cred_gcp.secret}@@ # JSON keyfile - Use SSH Key credential to paste JSON keyfile
gcp_zone = '@@{gcp_zone_id}@@' # Not required for every service
# Authentication
credentials = service_account.Credentials.from_service_account_info(gcp_secret)
# Create client - compute API https://cloud.google.com/compute/docs/reference/rest/v1
from googleapiclient import discovery
client = discovery.build('compute', 'v1', credentials=credentials)

The following example displays the usage of the Kubernetes module.

from kubernetes import client as k8client
aToken="eyJhbGciOiJSUzI1NiIsImtpZCI6IiJ9.eyJpc3MiOiJrdWJl
cm5ldGVzL3NlcnZpY2VhY2NvdW50Iiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWN
jb3VudC9uYW1lc3BhY2UiOiJkZWZhdWx0Iiwia3ViZXJuZXRlcy5pby9zZXJ2aWNl
YWNjb3VudC9zZWNyZXQubmFtZSI6InNhcmF0aC10b2tlbi1ubWo1cSIsImt1YmVybm
V0ZXMuaW8vc2VydmljZWFjY291bnQvc2VydmljZS1hY2NvdW50Lm5hbWUiOiJzYXJhdG
giLCJrdWJlcm5ldGVzLmlvL3NlcnZpY2VhY2NvdW50L3NlcnZpY2UtYWNjb3VudC51aWQ
iOiIzODM1Zjk5MC0zZGJhLTExZWEtODgwNy01MDZiOGQzYjFhYjIiLCJzdWIiOiJzeXN0ZW06c2Vyd
mljZWFjY291bnQ6ZGVmYXVsdDpzYXJhdGgifQ.dLJCdlOGktRsXfxDItBdbYxDYJtnFS9pptQaKr
JS1QfWAiT93l_iPExZZ_7JGQ2t7glpe-DNEwfjKiqUkDKmuHZSxN9fV6PHjTc8CGOn1q4LV7
tFFkh4HNi-JjhLPkRRQUM6_y5qQSrx9asDEGVLGsoHjuMLhELi4Ghq1EOgcRxPCTQD6lq_C203Dap
PESdqPl7JsmIVBCkFUT4A8A4sseiOqq9ogX-QKvAwoI7yq97BMJLX7q868cNBRsbFzct1tS-CEx-RCPM95
qAzdLNUOrIszVVgSd7jLxIg_tqUH_yEj4T0cePsbLhrCBPRt6bHFCyg3RkIKRoIN2YBq0wPWw"
configuration=k8client.Configuration()
configuration.host="https://10.46.4.213:6443"
configuration.verify_ssl=False
configuration.debug=True
configuration.api_key={"authorization":"Bearer "+ aToken}
k8client.Configuration.set_default(configuration)
v1=k8client.CoreV1Api()
nodes=v1.list_node(watch=False)
print nodes.items[0].metadata.name

Calm supports the following eScript functions.

urlreq

The API exposes REST interface as a set of objects. This action is implemented using python requests module.

urlreq(url, verb='GET', auth=None, c=None, user=None, passwd=None, params=None,
headers=None, timeout=None, send_form_encoded_data=True, allow_redirects=True,
cookies=None, verify=True, proxies=None)

requests.Response object is returned.

Table 2. Arguments
Arguments	Description
url	string, url to request
verb	string, verb is GET by default. POST, HEAD, PUT, PATCH, and DELETE are other valid entries.
auth	string (optional), BASIC and DIGEST are the valid entries. For authentication purposes, the order is as follows. username and password is authenticated by using user and passwd fields. username and password is authenticated by using name of credential supplied using c field. username and password is authenticated by using credential attached to the task.
user	string (optional), username used for authentication.
passwd	string (optional), password used for authentication.
params	dict (optional), if verb is GET, HEAD or DELETE, parameters are sent in the query string for the request otherwise they are sent in the body of the request.
headers	dict (optional), Dictionary of HTTP headers needs to be send along with the request.
timeout	integer (optional), you can configure requests to stop waiting for a response after a given number of seconds with the timeout parameter. timeout only elects the connection process itself, not the downloading of the response body.
send_form_encoded_data	boolean (optional), = True by default. If False, parameters dict is first dumped using simplejson.dumps() and then passed as a string.
allow_redirects	boolean (optional), = True by default. Specifies whether redirects should be allowed or not.
cookies	dict (optional), cookies dict to be sent along with the request.
verify	boolean (optional), = True by default. Specifies whether SSL certificates should be verified or not.
proxies	dict (optional), Dictionary mapping protocol to the URL of the proxy

Rules for authentication in the order of priority.

If they are not None , use user and passwd fields.
If c is not None , authenticate username and password from the credential name supplied.
If the above two criteria does not match, username and password are authenticated by using the credential attached to the task.

For example

params = {'limit': 1}
headers = {'content-type': 'application/octet-stream'}
r = urlreq(url, verb="GET", auth="BASIC", c='somecred', params=params, headers=headers)
r = urlreq(url, verb="POST", auth="BASIC", user="user", passwd="pass", params=params)

exit

The exit function is an alias for sys.exit of python standard library.

exit(exitcode)

For example

exit(0)

sleep

The sleep function is an alias for time.sleep.

sleep(num_of_secs)

For example

sleep(10)

_construct_random_password

The _construct_random_password API generates a random password and returns it.

_construct_random_password(lower, upper=None, numCaps=0, numLetters=0,
numDigits=0, numPuncs=0, startwith=None, caps=None, letters=None,
digits=None, puncs=None)

Returns: String

Table 3. Arguments
Argument	Description
lower	integer, minimum number of characters in the password.
upper	integer (optional), maximum number of characters in the password. If upper is not defined, then the password returned will always be as per lower, else the length can vary between lower and upper (both included).
numCaps	integer (optional), minimum number of capital letters that must be there in password.
numLetters	integer (optional), minimum number of letters that must be there in password.
numDigits	integer (optional), minimum number of digits that must be there in password.
numPuncs	integer (optional), minimum number of punctuation alphabets that must be there in password.
startwith	string (optional), password returned starts with one of the characters provided in startwith string.
caps	string (optional), default = 'A-Z'. This can be overridden.
letters	string (optional), default = 'a-zA-Z'. This can be overridden.
digits	string (optional), default = '0-9'. This can be overridden.
puncs	string (optional), default = '!@#$%^&'. This can be overridden.

Note: numCaps + numLetters + numDigits + numPuncs + 1 (if startwith is defined) must not be greater than upper.

_is_bad_password

The _is_bad_password function checks whether the password is correct or not.

_is_bad_password(password, reserved, dictionary=True, numCaps=0, numPuncs=0, \

numDigits=0, minLen=5)

For example

_is_bad_password("Abcd@123")

_randomchoose

The _randomchoose function is used to get a random character from a string.

_randomchoose(string)

For example

_randomchoose("adsadrer")

_shuffle

The _shuffle function is used to shuffle the sequence.

_shuffle(sequence)

For example

_shuffle(a)

get_sql_handle

The get_sql_handle function enables you to remotely connect and manage SQL Servers. It is implemented by using python pymssql module.

get_sql_handle(server, username, password, database='', timeout=0, login_timeout=60, charset='UTF-8', as_dict=False, host='', appname=None, port='1433', conn_properties=None, autocommit=False, tds_version=None)

Returns pymssql.Connection object

Table 4. Arguments
Argument	Description
server (str)	database host
user (str)	database user to connect as
password (str)	user’s password
database (str)	The database to initialize the connection with. By default SQL Server selects the database which is set as default for specific user
timeout (int)	query timeout in seconds, default 0 (no timeout)
login_timeout (int)	timeout for connection and login in seconds, default is 60 seconds
charset (str)	character set with which to connect to the database

For example

username="dbuser"
  password="myP@ssworD"
  server="10.10.10.10"
  port="1433"
  
  cnxn = get_sql_handle(server, username, password, port=port, autocommit=True)
  cursor = cnxn.cursor()
  
  # List all databases
  cursor.execute("""
    SELECT Name from sys.Databases;
  """)
  for row in cursor:
    print row[0]

    cnxn.close()

To refer to the video about supported eScripts, click here.

EScript Sample Script

The following script is an EScript sample script.

Note: Ensure that your script starts with #script .


#script

account_name = "@@{ACCOUNT_NAME}@@"
aviatrix_ip = "@@{address}@@"
new_test_password = "@@{NEW_TEST_PASSWORD}@@"
vpc_name = "Test"

api_url = 'https://{0}/v1/api'.format(aviatrix_ip)
#print api_url


def setconfig(api_url, payload):
  r = urlreq(api_url, verb='POST', auth="BASIC", user='admin', passwd='passwd', params=payload, verify=False)
  resp = json.loads(r.content)
  if resp['return']:
    return resp
  else:
    print "Post request failed", r.content
    exit(1)

print "Get the session ID for making API operations"
payload = {'action': 'login', 'username': 'admin', 'password': new_test_password}
api_url1 = api_url + "?action=login&username=admin&password="+ new_aviatrix_password
cid = setconfig(api_url=api_url1, payload=payload)
cid = cid['CID']
print cid

print "Delete the gateway"
payload = {'CID': cid,
  'action': 'delete_container',
  'account_name': account_name,
  'cloud_type': 1,
  'gw_name': vpc_name
  }
api_url1 = api_url + "?CID="+cid+"&action=delete_container&account_name="+account_name+"&cloud_type=1&gw_name="+vpc_name
print setconfig(api_url=api_url1,payload=payload)

print "Delete the aws account"

payload = {'CID': cid,
  'action': 'delete_account_profile',
  'account_name': account_name
  }
api_url1 = api_url + "?CID="+cid+"&action=delete_account_profile&account_name="+account_name
print setconfig(api_url=api_url1,payload=payload)

JWT Usage Sample Script

The following script is a jwt usage sample script.

Note: Ensure that your script starts with #script .


#script
jwt = '@@{calm_jwt}@@'

payload = {}
api_url = 'https://localhost:9440/api/nutanix/v3/apps/list'
headers = {'Content-Type': 'application/json',  'Accept':'application/json', 'Authorization': 'Bearer {}'.format(jwt)}
r = urlreq(api_url, verb='POST', params=json.dumps(payload), headers=headers, verify=False)
if r.ok:
    resp = json.loads(r.content)
    print resp
    exit(0)
else:
    print "Post request failed", r.content
    exit(1)

Sample Powershell Script

The following script is a powershell sample script.

Install-PackageProvider -Name NuGet -Force
Install-Module DockerMsftProvider -Force
Install-Package Docker -ProviderName DockerMsftProvider -Force

Sample Auto Logon and First Logon Scripts

Sample Auto Logon Script

The following script is a guest customization sample script for the Azure service.

<AutoLogon>
  <Password>
    <Value>@@{user.secret}@@</Value>
    <PlainText>true</PlainText>
  </Password>
  <Enabled>true</Enabled>
  <Username>@@{user.username}@@</Username>
</AutoLogon>

Sample First Logon Script

The following script is a guest customization sample script for the Azure service.

<FirstLogonCommands>
    <SynchronousCommand>
    <CommandLine>cmd.exe /c powershell -Command get-host</CommandLine>
    <Order>1</Order>
    </SynchronousCommand>
</FirstLogonCommands>

Sample Guest Customization Scripts for VMware and GCP Services

The following script is a guest customization sample script for the VMware service.

cmd.exe /c winrm quickconfig -q
cmd.exe /c winrm set winrm/config/service/auth @{Basic="true"}
powershell -Command "enable-psremoting -Force"
powershell -Command "Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Force"

The following script is a guest customization sample script for the GCP service.

#! /bin/bash\napt-get update\napt-get install -y apache2\ncat <<EOF > /var/www/html/index.html\n<html><body><h1>Hello World</h1>\n<p>This page was created from a simple startup script!</p>\n</body></html>\nEOF

Calm Blueprints Public Repository

Seeding Scripts to the Calm Task Library

The blueprints repository of Calm contains script that can be seeded into task library and published to projects. You can use these tasks for blueprint configuration.

Procedure

Clone the blueprint repository from github. To access the repository, click here.
Change the directory to calm-integrations/generate_task_library_items .
To execute the script to seed, run the following command in bash.
bash generate_task_library_items.sh
Enter the following information.
- Prism Central IP : Enter the Prism Central IP address to which the task library items are to be seeded.
- Prism Central User : Enter the user name with the access to create task library scripts.
- Prism Central Password : Enter the password of the Prism Central user.
- Prism Central Project : Enter the Project name to which the task library items can be published.
To avoid giving inputs multiple times, run the following command to export environment variables before running the script. This step is optional.
```
export PC_IP=<prism central IP>    
export PC_USER=<prism central user>
export PC_PASSWORD=<prism central password>
export PC_PROJECT=<prism central project>
```

Run the following command to seed individual files into Calm.

python generate_task_library.py --pc $PC_IP--user $PC_USER --password $PC_PASSWORD --project $PC_PROJECT --script <path of script>

Calm Licensing and Upgrades

Calm Licensing

Calm license for Prism Central enables you to manage VMs that are provisioned or managed by Calm. Nutanix provides a free trial period of 60 days to try out Calm.

Calm Upgrades

Upgrade Calm or Epsilon using the Life Cycle Manager (LCM) from Prism Central. Epsilon is the orchestration engine for Calm. For more information , see Life Cycle Manager.

Life Cycle Manager

The Life Cycle Manager (LCM) allows you to track and upgrade the Calm and Epsilon versions in Prism Central.

Note: LCM 2.1 and above support Calm and Epsilon upgrades.

Performing Inventory with the Life Cycle Manager

Use LCM to display the software and firmware versions of the entities in the cluster.

Procedure

In Prism Central, click the gear icon to open the Settings page.
Select Life Cycle Management in the sidebar.

Figure. Life Cycle Management Click to enlarge
Click Options > Perform Inventory .
The LCM shows a warning message if you have not enabled the auto-update, and a new version of the LCM framework is available.
Figure. Perform Inventory Click to enlarge
Click OK .
The LCM displays all discovered entities.
To view the current Calm and Epsilon versions, click View All .

Figure. All Updates Click to enlarge

The Epsilon and Calm entities show the current version and the date and time of the most recent update.

Upgrading Calm with the Life Cycle Manager

Use LCM to upgrade Calm and Epsilon to the latest available versions.

Before you begin

Configure rules in your external firewall to allow LCM updates. For more details, see the Firewall Requirements section in the Prism Web Console Guide .
Run a successful inventory operation before upgrading Calm or Epsilon.

Procedure

In Prism Central, click the gear icon to open the Settings page.
Select Life Cycle Management in the sidebar.

Figure. Life Cycle Management Click to enlarge
Click Edit and select Nutanix Calm .
By default, Epsilon is selected.

Note: Do not select only Epsilon to update.
Click Change .
Select the check box next to the version that you want to upgrade.
Click Save .
You can also update the services from the Options list.
- To perform all available updates, select Update All .
- To perform only required updates, select Update Required .
- To perform only updates you have selected, select Update Selected .
  If you do not select any specific updates, the LCM performs all available updates.

Upgrading Calm at a Dark Site

About this task

Perform the following procedure to upgrade Calm and Epsilon at a dark site.

Note: When you upgrade Calm to the latest version as part of the Prism Central upgrade and if Policy Engine is enabled, then ensure to upgrade your policy engine as well.

Before you begin

Ensure that LCM version is 2.3 or above.

Procedure

Set up a local web server that is reachable by all your Nutanix clusters.
For more information about setting up a local web server, click here.
Note:
- You must use this server to host the LCM repository.
- From Calm 3.0.0.2 release onwards, when you set up a Windows local web server for LCM dark site upgrade, create an MIME type called '.xz' with the type set as text/plain.
From a device that has public Internet access, go to the Nutanix portal.
Click Downloads > Calm .
Select the required version and download Nucalm-X.X.X.X.ZIP , Epsilon-X.X.X.X.Zip , and Policy-X.X.X.X.ZIP tar files.
X.X.X.X represents the Calm, Epsilon, or Policy engine versions.
Transfer Nucalm-X.X.X.X.ZIP , Epsilon-X.X.X.X.Zip , and Policy-X.X.X.X.ZIP tar files to your local web server.
Extract the files into the local release directory.
You get the following files in the release directory.
- Nucalm-X.X.X.X.Zip
  - release/builds/calm-builds/x.x.x.x/metadata.json
  - release/builds/calm-builds/x.x.x.x/metadata.sign
  - release/builds/calm-builds/x.x.x.x/nucalm.tar.xz
- Epsilon-X.X.X.X.Zip
  - release/builds/epsilon-builds/x.x.x.x/metadata.json
  - release/builds/epsilon-builds/x.x.x.x/metadata.sign
  - release/builds/epsilon-builds/x.x.x.x/epsilon.tar.xz
- Policy-X.X.X.X.ZIP
  - release/builds/policy_engine-builds/x.x.x.x/metadata.json
  - release/builds/policy_engine-builds/x.x.x.x/metadata.sign
  - release/builds/policy_engine-builds/x.x.x.x/policy-engine.tar.gz
From a device that has public Internet access, go to the Nutanix portal.
Select Downloads > Calm .
Download nutanix_compatibility.tgz and nutanix_compatibility.tgz.sign tar files.
Transfer the compatibility tar files to your local web server and replace the files in the /release directory.
Log on to Prism Central.
On the LCM page, click Settings .
In the Source field, select Local web server .
In the URL field, enter the path to the directory where you extracted the tar file on your local server . Use the format http://webserver_IP_address/release .
Click Save .
In the LCM sidebar, select Inventory and click Perform Inventory .
Update the LCM framework before trying to update any other component.

The LCM sidebar now shows the LCM framework with the updated version.

Calm VM Upgrades

Refer to this section to upgrade Calm to the latest available version after you deploy the Calm VM.

Following are the available methods:

Prism Central (PC) / Calm VM upgrade - Upgrading the Prism Central (Calm VM) also upgrades the Calm version.
Life Cycle Manager (LCM) upgrade - You can upgrade to newer versions of Calm without performing a VM upgrade. Upgrades to most minor releases and few major releases are done using this method.

Upgrading Calm and Epsilon from Calm VM 3.5.2 to 3.6

Use the following procedure to upgrade Calm and Epsilon from Calm VM 3.5.2 to 3.6.

Procedure

Perform a Prism Central upgrade to version 2022.6.
For more information, see Upgrading Calm VM with Prism Central.

Note: If you are on Calm VM 3.5.2, then your Prism Central version must be version 2022.6.
SSH to Calm VM.
Run the following command to stop Calm and Epsilon containers.
genesis stop nucalm epsilon
Navigate to the Calm directory ( /usr/local/nutanix/nucalm/ ) and remove the tar file.
Wget nucalm.tar.xz from the Downloads location.
Navigate to the Epsilon directory ( /usr/local/nutanix/epsilon/ ) and remove the tar file.
Wget epsilon.tar.xz from the Downloads location.
Run the following command to start Calm and Epsilon services and wait for the services to get healthy.
cluster start
Verify that the Calm and Epsilon containers are healthy.

Upgrading Calm VM with Prism Central

About this task

To upgrade Calm VM using the PC method, do the following:

Procedure

Login into the Calm VM GUI using the IP address.
Click Prism Central Settings > Upgrade Prism Central .

Figure. Prism Central Settings Click to enlarge

Check if the compatible PC version is available. If not, go to the Name Servers page and enter the global DNS server as the Name server.

Figure. Upgrade Prism Central Click to enlarge
In the Upgrade Prism Central page, click Download against the compatible version.

A confirmation window appears.

Click Yes to start the download process. After the download gets completed, you can view the Upgrade list.

Note: If the PC version you want to upgrade does not appear in the list, typically because you do not have Internet access (such as at a dark site), you can click the upload the Prism Central binary link to upload an image from your local media.
In the Upgrade list, click Upgrade Now .
A confirmation window appears.
Click Continue to start the upgrade process.

During the upgrade process, the Calm VM gets restarted.

Also, you can log in to the Calm VM GUI to view the upgraded version. In the top-left corner, click User Menu > About Nutanix .

Upgrading Calm VM with Life Cycle Manager

You can upgrade to newer versions of Calm without performing a VM upgrade. Upgrades to most minor releases and few major releases are done using the LCM method.

Before you begin

About this task

To upgrade Calm VM using the LCM method, do the following:

Procedure

Click Administration > LCM to open the LCM page.
Click Perform Inventory .

A confirmation window appears.

Figure. LCM - Perform Inventory Click to enlarge
Click Proceed .
The Perform Inventory process can take several minutes depending on your cluster size. Once completed, you can view the available updates in the Software page.
Select the check-box next to the Calm VM version that you want to upgrade. Then, click Update .

Note that the Epsilon check-box also gets selected. Epsilon is the orchestration engine used by Calm.

Figure. LCM - Upgrading Calm VM Click to enlarge

A confirmation window appears.

Note: Once the update process begins, it cannot be stopped or paused.
Click Apply Updates to complete.
If you do not have internet access, use the dark-site method to upgrade Calm. For more information, see Upgrading Calm VM with Life Cycle Manager at a Dark Site.

Upgrading Calm VM with Life Cycle Manager at a Dark Site

About this task

Note:

Use the following procedure only for Calm VM deployments. Do not use this procedure to perform LCM upgrades in the Nutanix Prism Central VMs that are attached to Prism Elements.
If you have both Nutanix infrastructure (Nutanix Prism Central VMs attached to Prism Elements) and Calm VM, ensure to set up and manage two different LCM URLs or web servers to perform dark site upgrades for each type of deployments. For more information on using LCM for Prism Central VMs, see the Life Cycle Manager Dark Site Guide .
The following procedure handles the upgrades of Calm family only and does not handle upgrades of any other modules.

Before you begin

Ensure that LCM version is 2.3 or above.

Procedure

Set up a local web server that is reachable to your Calm VMs.
You will use this server to host the LCM repository.
Note:
- For more information about setting up a local web server, click here.
- From Calm 3.0.0.2 release, create a MIME type called '.xz' with the type set as text/plain when setting up a Windows local web server for LCM dark site upgrade.
Use the following steps to set up your LCM repository:
1. From a device that has public Internet access, go to the Nutanix portal and select Downloads > Calm .
2. Next to the Calm on ESX LCM Bundle entry, click Download to download the latest LCM framework tar file, lcm_dark_site_bundle_version.tgz .
3. Transfer the framework tar file to your local web server.
4. Extract the framework tar file into the release directory.
  The following files are extracted into the release directory.
  - master_manifest.tgz
  - master_manifest.tgz.sign
  - modules
  - nutanix_compatibility.tgz
  - nutanix_compatibility.tgz.sign
  - support.csv
  - support.md
From a device that has public Internet access, go to the Nutanix portal and select Downloads > Calm . Choose the required version and download Nucalm-X.X.X.X.ZIP and Epsilon-X.X.X.X.Zip tar files.
X.X.X.X represents the Calm and Epsilon versions.
Transfer Nucalm-X.X.X.X.ZIP and Epsilon-X.X.X.X.Zip tar files to your local web server and extract the files into local directory release .
After you extract and save the files in release folder, you can view the following files.
- Nucalm-X.X.X.X.Zip
  - release/builds/calm-builds/x.x.x.x/metadata.json
  - release/builds/calm-builds/x.x.x.x/metadata.sign
  - release/builds/calm-builds/x.x.x.x/nucalm.tar.xz
- Epsilon-X.X.X.X.Zip
  - release/builds/epsilon-builds/x.x.x.x/metadata.json
  - release/builds/epsilon-builds/x.x.x.x/metadata.sign
  - release/builds/epsilon-builds/x.x.x.x/epsilon.tar.xz
From a device that has public Internet access, go to the Nutanix portal and select Downloads > Calm . Download nutanix_compatibility.tgz and nutanix_compatibility.tgz.sign tar files.
Transfer the compatibility tar files to your local web server and replace the files in the /release folder.
Replace the existing compatibility files with the new files.
Log on to Prism Central.
On the LCM page, click Settings .
In the Source field, select Local web server .
In the URL field, enter the path to the directory where you extracted the tar file on your local server. Use the format http://webserver_IP_address/release .
Click Save .
You return to the Life Cycle Manager.
Select Inventory in the LCM sidebar and click Perform Inventory .
Update the LCM framework before trying to update any other component.

The LCM sidebar now shows the LCM framework with the same version as the LCM dark site bundle you downloaded.

Additional Information

Credential Security Support Provider

For more information, refer to the Microsoft Documentation .

Enabling CredSSP

Perform the following procedure to enable CredSSP.

Procedure

Run the following command to enable CredSSP on the target machine.

> Enable-WSManCredSSP -Role Server -Force

Generating SSH Key on a Linux VM

Perform the following procedure to generate an SSH key pair on a Linux VM.

About this task

Note: Avoid generating the RSA key pair on your Prism Central VM or CVM.

Procedure

Run the following shell command to generate an RSA key pair on your local machine.
```
$ ssh-keygen -t rsa
```
Accept the default file location as ~/.ssh/id_rsa .
You can find your public key at ~/.ssh/id_rsa.pub and the private key at ~/.ssh/id_rsa .

Note: Do not share your private key with anyone.

Generating SSH Key on a Windows VM

Perform the following procedure to generate an SSH key pair on Windows.

About this task

Note: Avoid generating the RSA key pair on your Prism Central VM or CVM.

Procedure

Launch PuTTygen.
Move the mouse cursor in the blank area and click Generate .
To convert the private key into an OpenSSH format, select Conversions > Export OpenSSH key .
PuTTygen warning message appears.
Click Yes to save the key without a passphrase.
Navigate to a location on your local system to save the key.
Type a name for the key.
Click Save .
Copy the public key (highlighted in the following image) into a plain text file and save the key at the same location as that of the private key.

Figure. Public Key Click to enlarge

Migrating to Integrated Linux Based PowerShell Gateway from Karan Service

About this task

Note: Calm version 2.10 or later do not support manual Karan service installation.

Before you begin

Ensure that you meet the following requirements.

Calm version is 2.5.0 and above.
If you use Windows ISO image, enable remoting and open the 5985 and 5986 ports in the Windows disk image or in Sysprep XML.
Define script type as PowerShell to execute the PowerShell scripts.
Select the connection type as Windows(PowerShell) from the Connection Type list while configuring a VM.

Procedure

If you want to run the PowerShell scripts in the default execution mode, integrated Linux based PowerShell gateway runs the script by creating a remote PowerShell session and runs the script with NTLM authentication mode.
The following example displays a sample PowerShell script that runs in the default execution mode.
```
> Install-windowsfeature -name AD-Domain-Services –IncludeManagementTools
```
If the PowerShell scripts need elevated privileges, run the following command to enable the CredSSP server role on the target machine.
```
> Enable-WSManCredSSP -Role Server -Force
```
The following example displays a sample PowerShell script that requires the elevated privileges.
```
> Install-windowsfeature -name AD-Domain-Services –IncludeManagementTools
```

Integrated Linux Based PowerShell Gateway Errors

You might encounter the following errors when you run the PowerShell scripts using the integrated Linux based PowerShell gateway.

Table 1. Integrated Linux Based PowerShell Gateway Errors
Error	Description
Access denied	If the VM and the WinRM services are started but the specified credential is wrong. You encounter the error in the following cases. When you use the local account credential of a domain member machine. You can resolve the issue by using the domain credentials. When the script requires elevated privileges and the CredSSP is not enabled on the target machine. You can resolve the issue by enabling the CredSSP on the target machine. For more information on enabling CredSSP, see Credential Security Support Provider.
Connection refused	You encounter the connection refusal error in the following cases. When a VM is not started but Calm tries to do a check-login or runs a PowerShell task. You can resolve the issue by adding a delay time task. For more details, see Creating a Delay Task. When Calm is not able to communicate with the target machine. You can resolve the issue by allowing the connection to the port that is used to contact the target machine. Ensure that all the firewalls between Prism Central and the target machine allow connections to the port.

Localization

Read article

Nutanix Collector Release Notes

Collector 3.0

Product Release Date: 2020-09-15

Last updated: 2020-11-02

What's New

Following are the new features in this release.

Support for Hyper-V data collection

Collector now supports Hyper-V configurational data collection from Hyper-V instances. Performance data is not being collected in the current version.
Collection can be done by providing the IP address of a single host in the cluster and Collector collects data from all the hosts which are accessible within the cluster.

VM Template column added

The column basically defines whether a VM is a template or not. The value for each VM is 'true' or 'false' . If a template is true, that means that the particular VM is a clone of another VM.
The column is present in vInfo , vCPU , vMemory and vPartition for vCenter.

Login page modifications

The login page now has a drop down menu to choose the flow that is vCenter, Prism, or Hyper-V and the default IP addresses are populated upon selection.

Updated Features

Following are the updated features in this release.

Added link to Nutanix Community in the tool: A link to Nutanix Community has been added in the tool to reach out for queries and discussions.
Empty vNICs in Prism: Handle Prism instances where a host having empty nics the collection was being interrupted with an exception.

Read article

Nutanix Collector Release Notes

Collector 3.1

Product Release Date: 2020-10-05

Last updated: 2020-11-02

What's New

Following is the new feature in this release.

Power State Added to Excel Output: The Excel output now includes the Power state for vMemory , vCPU , vPartition , and vInfo .

Updated Features

Following is the updated feature in this release.

Template Attribute Included in Collection Zip: Collection zip now includes the template attribute when uploading to the portal.

Read article

Nutanix Collector Release Notes

Collector 3.2

Product Release Date: 2020-11-24

Last updated: 2021-02-24

What's New

Following is the new feature in this release.

Support for Hyper-V Local Data Collection

Collector now supports Hyper-V configurational data collection directly from hyper-v hosts.
Collection can be done by downloading the collector tool in any of the hosts which are part of the cluster we wish to collect data from and choosing Hyper-V local in the drop down menu.

Precheck Script Added to Debug Remote Connectivity Issues in Hyper-V

A powershell script is bundled within the tool which can run a few checks to see if the expected services are available and if other prerequisites are satisfied.
Upon running into the error screen in hyper-v collection, the tool will redirect to the ntnxcollector_precheck.ps1 script which can be run on the host to get the relevant data.

Login Page Modifications: The login page now has a drop down to choose the flow that is, vCenter, Prism, and Hyper-V (remote) and Hyper-V (local), and the default ports are populated upon selection.

Updated Features

Following is the updated feature in this release.

Improved Error Messages: Error messages are better handled to give more clarity and remove ambiguities.

Support for Hostname in Hyper-V Collection: Host name can be used to connect to the hyper-v host instance, this should however be just the host name and not the FQDN, and the host should be accessible through the same network.

UI Enhancements in VM Summary: Both the total storage and consumed storage values are displayed in the VM Summary panel.

Read article

Nutanix Collector Release Notes

Collector 3.3

Product Release Date: 2021-03-01

Last updated: 2021-03-01

What's New

Following are the new features in this release:

Support for Performance Data Collection in Hyper-V

Hyper-V clusters now support Performance Data Collection.
Performance data can be collected for a minimum of 1 day and can go up to 7 days.

Support for Single Node Hyper-V Cluster

Collector now supports single node Hyper-V clusters.
Single Node Hyper-V clusters supports collection of both configuration & performance data.

Updated Features

Following is the updated feature in this release.

Resolved Hyper-V (Remote) connection issues: Prerequisite of Domain Admin check is now handled in case the systems are running non English languages.

Option to connect to Hyper-V (Remote) cluster using port 5986 or 5985: Hyper-V (Remote) connection can now be established using HTTPS port 5986 or HTTP port 5985. The default port for Hyper-V (Remote) connection is HTTPS port 5986.

Note: If a self signed certificate is required, Collector would fail to connect over port 5986.

Read article

Welcome to Knowledge Base!

KB at your finger tips

Calm 3.5.2

Introduction

Introduction to Calm

Calm Key Benefits

Calm Prerequisites

Pre-configuration for Using Calm

Prerequisites to Enable Calm

Calm Benchmarks

Calm Single-Node Profile

Calm Three-Node (Scale-Out) Profile

Benchmark Considerations

Calm Throughput

Port Information in Calm

Calm Enablement

Enabling and Accessing Calm

Before you begin

Procedure

What to do next

Checking Calm Version

Procedure

Calm VM Deployment

Deploying Calm VM on AHV

Before you begin

Procedure

What to do next

Deploying Calm VM using the vSphere Web Client

Before you begin

Procedure

What to do next

Deploying Calm VM using the vSphere CLI

Before you begin

Procedure

What to do next

Setting up Scale-Out Calm VM

Before you begin

Procedure

What to do next

Enabling Policy Engine for Calm VM

Before you begin

Procedure

Launching Calm VM with a Static IP Address

Procedure

What to do next

Getting Started with Calm

Calm Overview

Exploring Calm

Procedure

Accessing Calm REST API Explorer

Procedure

Role-Based Access Control in Calm

Calm: Quick Start

Launching a Blueprint Instantaneously

About this task

Procedure

What to do next

Provisioning a Linux or Windows Infrastructure as a Service (IaaS)

Before you begin

About this task

Procedure

What to do next

General Settings in Calm

Enabling Nutanix Marketplace Applications

Procedure

What to do next

Showback

Enabling Showback

About this task

Procedure

Disabling Showback

Procedure

Policy Engine Overview

Enabling policy Engine

About this task

Procedure

What to do next

Enabling Policy Engine at a Dark Site

Before you begin

Procedure