VM Deployment with USER IP INPUT and Second Disk

hherring · ‎07-21-2016

Workflow Name	Single VM Multi Disk 2
Description
Prerequisites	Tested on 5.4.0.0
Category	Workflow
Components	vSphere 5.x
User Inputs

Instructions for Regular Workflow Use:

Download the attached .ZIP file below to your computer. *Remember the location of the saved file on your computer.
Unzip the file on your computer. Should end up with a .WFD file.
Log in to UCS Director as a user that has "system-admin" privileges.
Navigate to "Policies-->Orchestration" and click on "Import".
Click "Browse" and navigate to the location on your computer where the .WFD file resides. Choose the .WFD file and click "Open".
Click "Upload" and then "OK" once the file upload is completed. Then click "Next".
Click the "Select" button next to "Import Workflows". Click the "Check All" button to check all checkboxes and then the "Select" button.
Click "Submit".
A new folder should appear in "Policies-->Orchestration" that contains the imported workflow. You will now need to update the included tasks with information about the specific environment.

Request:

===========

1) Improve VM Deployment with USER IP INPUT by attaching an optional second disk during VM deployment.

2) Second disk should live on the same datastore as the original VM files.

3) Don't add the second disk if datastore free space will drop below 400 GB.

Caveats:

=======

1) For the second disk addtion to work, the Site name that contains the virtual data center (VDC) in UCSD must be similar to the Datacenter name in vCenter. The code compares the first four characters (upper case) to make the match.

For example, if the UCSD site name is "Blacksburg 2" and vCenter Datacenter name is "Blacksburg" then they are similar enough:

2) The datastore free space requirement for the second disk is hard coded to 400 GB. It does not refer to the Storage Policy at this time.

3) For details on how to get the VM deployment itself to work, refer to the Communities page for the original Workflow VM Deployment with USER IP INPUT as well as the PDF attached to UCS Director 5.4 – Windows/Linux CSV Workflow Deployment.

Workflow Customization

==================

The Workflow needs to be set for the environment. Customers with multiple Datacenters or Sites may decide to clone the Workflow and customize each clone for a specific site.

1) Edit the "key" so that API calls will work:

Select Admin

Copy the key:

The current User Input fields are:

2) Create an Admin Input Value for any Workflow input you don't want to give an answer for each time:

The fields in the red circles need to be adjusted for the new UCSD environment!

Manual Execution:

==============

Addition of the second disk will be done in the main workflow AFTER the child SR provisions the VM.

Version 2 Code included in attached Workflow:

===================================

//

// Version 2 helper functions

//

// XML parser from Russ Whitear (as-ucsd)

//

function getXmlObjectsAsArray(inputString, tagName) {

var array = [];

var factory = DocumentBuilderFactory.newInstance();

var builder = factory.newDocumentBuilder();

var xmlStringBuilder = new StringBuilder();

xmlStringBuilder.append(inputString);

var input = new ByteArrayInputStream(xmlStringBuilder.toString().getBytes('UTF-8'));

var doc = builder.parse(input);

doc.getDocumentElement().normalize();

logger.addInfo("Tag name is " + tagName);

var nList = doc.getElementsByTagName(tagName);

logger.addDebug("Root element: " + doc.getDocumentElement().getNodeName());

logger.addDebug("nList length: " + nList.getLength());

for (var i = 0; i < nList.getLength(); i++) {

var nNode = nList.item(i);

// logger.addInfo("\nCurrent Element: " + nNode.getNodeName());

// logger.addDebug("\nNodeType: " + nNode.getNodeType());

// logger.addDebug("typeof nNode: " + typeof nNode);

var value = nNode.getTextContent();

// logger.addDebug("Object: " + value);

array.push(value);

}

return array;

}

//

// Disk GB to Bytes

function diskGBtoBytes(diskGB) {

return ( diskGB * 1024 * 1024 * 1024 );

}

//

// Disk Bytes to GB

function diskBytestoGB(bytes) {

return ( bytes / 1024 / 1024 / 1024 );

}

//

// end Version 2 helpers

//

// Version 2

// Add (optional) second disk to same datastore

//

logger.addInfo("-------------------Code to add optional Second Disk---------------------------------");

if (disksize2 > 0) {

// Get info about child VM for datastore API call below.

// Need: datacenterId, accountId, vmwareDCId, vmwareHostId

// VM Provisioning gives us:

// [Output: VM_Datacenter_Name = Rocklin] is vmwareDCId

// [Output: VM_vCenter_Name = Rocklin CA] is accountId

// [Output: VM_Server_Address = carovcntrp10v.nss.vzwnet.com]

// [Output: Datastore_Name_Disk1 = caroesxp30-scsi-VSP:14]

var vmAccount = ctxt.getOutput("VMProvisionEngineConfig_235.VM_vCenter_Name", childSrId); // { accountId (name of vCenter account) }

var vmDatacenter = ctxt.getOutput("VMProvisionEngineConfig_235.VM_Datacenter_Name", childSrId); // { vmwareDCId (name of vCenter datacenter) }

var vmHost = ctxt.getOutput("VMProvisionEngineConfig_235.VM_Host", childSrId); // { vmwareHostId ('<ip of ESXi host>') }

var vmDatastoreName = ctxt.getOutput("VMProvisionEngineConfig_235.Datastore_Name_Disk1", childSrId); // datastore name needed later

var thinDisk = false; // Vz requested thick provisioning

logger.addDebug("URL accountId = " + vmAccount);

logger.addDebug("URL vmwareDCId = " + vmDatacenter);

logger.addDebug("URL vmwareHostId = " + vmHost);

logger.addInfo("VM ID = " + vmID); // set much earlier above

logger.addInfo("VM disk1 installed on [" + vmDatastoreName + "]");

logger.addInfo("Second disk size = " + disksize2 + " GB"); // Workflow input variable

logger.addInfo("Thin provision is " + thinDisk);

logger.addInfo("vmAccount (vdcCloudName) = " + vmAccount);

//

// Get Site Name for datastore API URL

var vmUcsdDatacenter = ""; // { datacenterId (name of UCSD Site) }

var siteurl = "/app/api/rest?formatType=json&opName=cluster:userAPIGetAllSites";

logger.addInfo("Get UCSD site names with siteurl = " + siteurl);

var client = new CuicAPIClient("127.0.0.1",443, key, "https");

var response1 = client.getURI(siteurl);

logger.addInfo("userAPIGetAllSites response = " + response1);

// Response will be JSON, for example:

// { "serviceResult":[{"clusterSiteId":1,"siteName":"Blacksburg 2","description":"test","contactName":"hherring@cisco.com"},{"clusterSiteId":2,"siteName":"Extra Site","description":"empty","contactName":"someone@aol.com"}], "serviceError":null, "serviceName":"InfraMgr", "opName":"cluster:userAPIGetAllSites" }

var jsonData = response1;

var siteArray = [];

siteArray = JSON.getJsonElement(jsonData, "serviceResult");

logger.addInfo("siteArray = " + String(siteArray));

logger.addInfo("Number of sites = " + siteArray.size());

// Look for Site name similar to VMware Datacenter name

logger.addInfo("Search for UCSD Site name that matches our target vCenter Datacenter name...")

var i, siteName;

for (i=0; i < siteArray.size(); i++) {

siteName = siteArray.get(i).get("siteName").getAsString();

logger.addInfo("Site " + i + " name = " + siteName);

// compare first 5 letters UPPERCASE

var siteCompare = siteName.slice(0,4).toUpperCase();

var vmDatacenter_up = vmDatacenter.toUpperCase();

if ( vmDatacenter_up.search(siteCompare) >= 0 ) {

logger.addInfo("Site name snippet " + siteCompare + " matches vCenter Datacenter " + vmDatacenter_up );

vmUcsdDatacenter = siteName;

} else {

logger.addInfo("No match for Site name snippet " + siteCompare + " in vCenter datacenter " + vmDatacenter_up );

}

// Error if at end of list and no Site name matched vCenter datacenter

if ( i == (siteArray.size() - 1) ) {

if ( vmUcsdDatacenter == "" ) {

logger.addInfo("FAULT: Can't match UCSD Site names to vCenter datacenter " + vmDatacenter);

} else {

logger.addInfo("Will use Site name " + vmUcsdDatacenter + "for datastore API call");

}

//

// Now get Datastore info and check free disk space

logger.addInfo("Build URL to get " + vmDatacenter + " datstore statistics...");

// Build the CUIC API Client request input...

// Format: /cloupia/api-v2/datacenter/{datacenterId}/account/{accountId}/vmwareDC/{vmwareDCId}/vmwareHost/{vmwareHostId}/vmwareDatastore

logger.addInfo("Format: /cloupia/api-v2/datacenter/{datacenterId}/account/{accountId}/vmwareDC/{vmwareDCId}/vmwareHost/{vmwareHostId}/vmwareDatastore");

logger.addInfo("{datacenterId} = " + vmUcsdDatacenter);

logger.addInfo("{accountId} = " + vmAccount);

logger.addInfo("{vmwareDCId} = " + vmDatacenter);

logger.addInfo("{vmwareHostId} = " + vmHost);

// Fix URL components: %20 for spaces, hostnames/IPs wrapped in single quotes

// Example: "/cloupia/api-v2/datacenter/Blacksburg%202/account/bbg-vc-cloud/vmwareDC/Blacksburg/vmwareHost/'192.168.10.52'/vmwareDatastore";

logger.addInfo("Correcting spaces and wrapping hostnames and IPs inside URL");

var url = "/cloupia/api-v2";

var vmUcsdDatacenter_a = vmUcsdDatacenter.replace(" ", "%20");

var vmAccount_a = vmAccount.replace(" ", "%20");

var vmDatacenter_a = vmDatacenter.replace(" ", "%20");

var vmHost_a = "'" + vmHost + "'";

url = url.concat("/datacenter/", vmUcsdDatacenter_a);

url = url.concat("/account/", vmAccount_a);

url = url.concat("/vmwareDC/", vmDatacenter_a);

url = url.concat("/vmwareHost/", vmHost_a);

url = url.concat("/vmwareDatastore");

logger.addInfo("URL = " + url);

// Call API with new URL

// var client = new CuicAPIClient("127.0.0.1",443, key, "https"); // already set above

var response2 = client.getURI(url);

logger.addInfo("CUIC API Client Response is: " + response2);

// Response should be XML of cloud datastore details

// Example XML response:

// <vmwareDatastore>

// <accessible>true</accessible>

// <accountName>bbg-vc</accountName>

// <capacityBytes>536870912000</capacityBytes>

// <freeBytes>316841918464</freeBytes>

// <hostName>192.168.10.52</hostName>

// <mountAccessMode>readWrite</mountAccessMode>

// <mountPath>/vmfs/volumes/52e1d877-a58079d3-35e4-0025b5ff0011</mountPath>

// <multiHost>true</multiHost>

// <name>mgmt data store</name>

// <numHosts>3</numHosts>

// <type>VMFS</type>

// <uncomitted>504113839384</uncomitted>

// <url>ds:///vmfs/volumes/52e1d877-a58079d3-35e4-0025b5ff0011/</url>

// <vmCount>14</vmCount><vmfsBlockSizeMB>1</vmfsBlockSizeMB>

// <vmfsMaxBlocks>63963136</vmfsMaxBlocks>

// <vmfsVersion>5.58</vmfsVersion>

// <vmwareDatacenterName>Blacksburg</vmwareDatacenterName>

// Get info for all datastores in this cloud

logger.addInfo("Parsing XML response...")

var xmlResponse = response2;

var dsNames = getXmlObjectsAsArray(xmlResponse, "name");

var dsCapacities = getXmlObjectsAsArray(xmlResponse, "capacityBytes");

var dsFree = getXmlObjectsAsArray(xmlResponse, "freeBytes");

logger.addInfo("datastore names = " + dsNames.toString() );

logger.addInfo("datastore capacities = " + dsCapacities.toString() );

logger.addInfo("datastore free = " + dsFree.toString() );

// Check that our Datastore will have >400 GB free after adding new disk

var index = -1;

index = dsNames.indexOf(vmDatastoreName);

var freeBytes = dsFree[index];

var diskBytes = diskGBtoBytes(disksize2);

logger.addInfo("Checking space available on datastore[" + index + "] aka " + vmDatastoreName);

logger.addInfo("free space - disksize2 = " + (freeBytes - diskBytes) + " bytes");

// 200 GB = 214748364800 bytes, 400 GB = 429496729600 bytes

// var reserveBytes = 214748364800; // for lab testing use 200 GB

var reserveBytes = 429496729600; // for Production use 400 GB

if ( (freeBytes - diskBytes) >= reserveBytes ) {

// Enough space to add disk

logger.addInfo("Okay to add disk. " + vmDatastoreName + " will be left with " + Math.round(diskBytestoGB(freeBytes - diskBytes)) + " GB");

// cloupiascript for API Browser test

//var vmID = 41;

//var childSrId = 15;

//var disksize2 = 2;

//var vmDatastore = "mgmt data store";

// var vmDatastore = ctxt.getOutput("VMProvisionEngineConfig_235.Datastore_Name_Disk1", childSrId);

// Collect variables for CreateVMDisk API call

logger.addInfo("Adding Second Disk...");

logger.addInfo("vmID = " + vmID);

logger.addInfo("vmDatastoreName = " + vmDatastoreName);

logger.addInfo("disksize2 = " + disksize2);

logger.addInfo("thinDisk = " + thinDisk.toString());

var inputDisk = "<cuicOperationRequest><payload><![CDATA[<CreateVMDisk><vmId>" + vmID + "</vmId><diskSize>" + disksize2 + "</diskSize><diskType>0</diskType><datastoreName>" + vmDatastoreName + "</datastoreName><thinProvision>" + thinDisk.toString() + "</thinProvision></CreateVMDisk>]]></payload></cuicOperationRequest>";

logger.addInfo("inputDisk = " + inputDisk);

var retDisk = GenericHTTPFunction(inputDisk, "/cloupia/api-v2/vmwareVMDisk");

// logger.addInfo("retDisk = " + retDisk);

logger.addInfo("Done adding Second Disk.");

} else {

logger.addInfo("ERROR: Can't add disk! Free space on " + vmDatastoreName + " would fall below " + (diskBytestoGB(reserveBytes)) + " GB free if disk were added.");

}

} else {

logger.addInfo("Skipping disk 2 since DiskSize2 (" + disksize2 + ") was not greater than 0");

}

logger.addInfo("-------------------Done Adding Second Disk---------------------------------");

//

// end of Version 2 update

//

Sample Log File:

=============

Service Request ID: 135

Workflow Inputs:

- vdc

- VDC_Template

- ID

- Password

- Key

- UCSD_IP

- Catalog

- VM_IP

- VM_Mask

- VM_GW

- VM_Owner

- VM_Name

- VM_Comment

- VM_Memory

- VM_CPU

- PROVISION_QTY

- DiskSize1

- BackupNetwork

- VMB_IP

- BackupNetworkAdapterName

- NetWorkAdapterType

- VMB_Mask

- CSV_FILE_FLAG

- CSV_FILE_PATH

- CSV_FILE

- rpassword

- DiskSize2

Jul 21, 2016 20:04:01 UTC Request submitted

Jul 21, 2016 20:04:02 UTC Executing workflow item number 1

Jul 21, 2016 20:04:02 UTC Completed workflow item number 0, with status Completed

Jul 21, 2016 20:04:05 UTC Executing workflow item number 2

Jul 21, 2016 20:04:05 UTC Trigger context executeWorkFlowStep called

Jul 21, 2016 20:04:05 UTC Executing custom action Single VM Multi Disk v2 (custom_Change_User)

Jul 21, 2016 20:04:05 UTC Executing custom script for Change_User

Jul 21, 2016 20:04:05 UTC User ID successfully changed to admin

Jul 21, 2016 20:04:05 UTC Task #1 (Single VM Multi Disk v2 (custom_Change_User)) completed successfully in 0 seconds

Jul 21, 2016 20:04:05 UTC Input/Output values for Task #1 (Single VM Multi Disk v2 (custom_Change_User)):

Jul 21, 2016 20:04:05 UTC [Local Input: User ID = admin]

Jul 21, 2016 20:04:05 UTC Completed workflow item number 1, with status Completed

Jul 21, 2016 20:04:11 UTC Executing workflow item number 3

Jul 21, 2016 20:04:11 UTC Trigger context executeWorkFlowStep called

Jul 21, 2016 20:04:11 UTC Executing custom action Single VM Multi Disk v2 (ExecuteCloupiaScript)

Jul 21, 2016 20:04:11 UTC Executing cloupia script: VM Provision+Post Provision

Jul 21, 2016 20:04:11 UTC ------------------Call for single delpoy-------------------

Jul 21, 2016 20:04:11 UTC ----------------------------------------------------------

Jul 21, 2016 20:04:11 UTC --------------------Temp VDC info--------------------------------------

Jul 21, 2016 20:04:11 UTC VDC Template Number = 11

Jul 21, 2016 20:04:11 UTC VDC Template Name = nss-service-profile

Jul 21, 2016 20:04:11 UTC VDC Template vdcTempNetworkPolicyName Name = nss-network

Jul 21, 2016 20:04:11 UTC VDC Template vdcTempComputingPolicyName Name = nss-compute

Jul 21, 2016 20:04:11 UTC VDC Template vdcTempStoragePolicyName Name = bbg-vc-cloud - Default Storage Policy

Jul 21, 2016 20:04:11 UTC VDC Template vdcTempPrimaryDeployPolicyName Name = bbg-nss-system

Jul 21, 2016 20:04:11 UTC ----------------------------------------------------------

Jul 21, 2016 20:04:11 UTC My SR ID = 135

Jul 21, 2016 20:04:11 UTC VDC = 10

Jul 21, 2016 20:04:11 UTC VDC Name = nss-vdc

Jul 21, 2016 20:04:11 UTC Catalog = 4

Jul 21, 2016 20:04:11 UTC Catalog Name = NSS Windows

Jul 21, 2016 20:04:11 UTC vdc Network Policy Name = nss-network

Jul 21, 2016 20:04:11 UTC vdc groupId number = 1

Jul 21, 2016 20:04:11 UTC VM IP = 192.168.40.27

Jul 21, 2016 20:04:11 UTC NewVDCIDFromCLone = 0

Jul 21, 2016 20:04:12 UTC 4th octet = 1

Jul 21, 2016 20:04:12 UTC 4th octet forthoctetint = 1

Jul 21, 2016 20:04:12 UTC 4th octet forthoctetintminus1= 0

Jul 21, 2016 20:04:12 UTC VM IP Split 0 = 192

Jul 21, 2016 20:04:12 UTC VM IP Split 1 = 168

Jul 21, 2016 20:04:12 UTC VM IP Split 2 = 40

Jul 21, 2016 20:04:12 UTC VM IP Split 3 = 1

Jul 21, 2016 20:04:12 UTC VM IP Split Zero= 192.168.40.0

Jul 21, 2016 20:04:12 UTC VM Mask = 255.255.255.0

Jul 21, 2016 20:04:12 UTC VM GW = 192.168.40.1

Jul 21, 2016 20:04:12 UTC VM Owner = hherring

Jul 21, 2016 20:04:12 UTC VM NAME = nsstestwin27

Jul 21, 2016 20:04:12 UTC VM Comment = ok to delete

Jul 21, 2016 20:04:12 UTC VM Memory = 1024

Jul 21, 2016 20:04:12 UTC VM CPU = 1

Jul 21, 2016 20:04:12 UTC vdc Template : 11

Jul 21, 2016 20:04:12 UTC CSV PATH and File = /tmp/vmDetails.txt

Jul 21, 2016 20:04:12 UTC Quantity = 1

Jul 21, 2016 20:04:12 UTC backupnetwork FLAG = 0

Jul 21, 2016 20:04:12 UTC ----------------------------------------------------------

Jul 21, 2016 20:04:12 UTC vdcCloudName generated from the VDC input = bbg-vc-cloud

Jul 21, 2016 20:04:12 UTC Content in Port Group Column = docker-pg-gw-app

Jul 21, 2016 20:04:12 UTC Looking for this in Port Group name = 192.168.40.0

Jul 21, 2016 20:04:12 UTC Content in Port Group Column = 1T_gw-pg-gw-app

Jul 21, 2016 20:04:12 UTC Looking for this in Port Group name = 192.168.40.0

Jul 21, 2016 20:04:12 UTC Content in Port Group Column = bbg-mgmt

Jul 21, 2016 20:04:12 UTC Looking for this in Port Group name = 192.168.40.0

Jul 21, 2016 20:04:12 UTC Content in Port Group Column = Management Network

Jul 21, 2016 20:04:12 UTC Looking for this in Port Group name = 192.168.40.0

Jul 21, 2016 20:04:12 UTC Content in Port Group Column = Production 192.168.40.0

Jul 21, 2016 20:04:12 UTC Looking for this in Port Group name = 192.168.40.0

Jul 21, 2016 20:04:12 UTC Found in Port Group for Main eth interface

Jul 21, 2016 20:04:12 UTC Found in Port Group Column = Production 192.168.40.0

Jul 21, 2016 20:04:12 UTC Found the Port Group name from given IP range = 192.168.40.0

Jul 21, 2016 20:04:12 UTC Cloud Selector = bbg-vc-cloud

Jul 21, 2016 20:04:12 UTC vSwitch Name = vSwitch1

Jul 21, 2016 20:04:12 UTC Port Group Type = Virtual Machine Portgroup

Jul 21, 2016 20:04:12 UTC PortGroupAssembly = bbg-vc-cloud@vSwitch1@Virtual Machine Portgroup@Production 192.168.40.0

Jul 21, 2016 20:04:12 UTC Count = 1

Jul 21, 2016 20:04:12 UTC Content in Port Group Column = bbg-data NSS 192.168.9.0

Jul 21, 2016 20:04:12 UTC Looking for this in Port Group name = 192.168.40.0

Jul 21, 2016 20:04:12 UTC Content in Port Group Column = PXE-Schemery

Jul 21, 2016 20:04:12 UTC Looking for this in Port Group name = 192.168.40.0

Jul 21, 2016 20:04:12 UTC Content in Port Group Column = PXE

Jul 21, 2016 20:04:12 UTC Looking for this in Port Group name = 192.168.40.0

Jul 21, 2016 20:04:12 UTC Content in Port Group Column = bbg-data

Jul 21, 2016 20:04:12 UTC Looking for this in Port Group name = 192.168.40.0

Jul 21, 2016 20:04:12 UTC Content in Port Group Column = vMotion

Jul 21, 2016 20:04:12 UTC Looking for this in Port Group name = 192.168.40.0

Jul 21, 2016 20:04:12 UTC Content in Port Group Column = bbg-nfs-net

Jul 21, 2016 20:04:12 UTC Looking for this in Port Group name = 192.168.40.0

Jul 21, 2016 20:04:12 UTC Content in Port Group Column = nfs

Jul 21, 2016 20:04:12 UTC Looking for this in Port Group name = 192.168.40.0

Jul 21, 2016 20:04:12 UTC Content in Port Group Column = VM Network