Installing and Configuring Cisco Packaged Contact Center Enterprise 9.0(x)
Run Golden Template Automation
Downloads: This chapterpdf (PDF - 1.81MB) The complete bookPDF (PDF - 4.59MB) | The complete bookePub (ePub - 1.13MB) | Feedback

Run Golden Template Automation

Run Golden Template Automation


Note


If you chose to create virtual machines directly on the destination servers, skip this chapter and go to Direct Installation.


CCE PAC M1 automation is the process of deploying virtual machines on the destination system using the golden templates on the source system.

Before you run the automation, download and install vSphere PowerCLI on the computer from which the automation is to be run. See Automation Software. VSphere PowerCLI is a command-line tool built on Windows PowerShell. It provides cmdlets (commands) for managing and automating vSphere.

Download Automation Tool

The automation tool is contained in the GoldenTemplateTool zip file, downloadable from Cisco.com at http:/​/​cisco.com/​en/​US/​products/​ps12586/​tsd_​products_​support_​series_​home.html.

Extract the file and copy the CCEPACM1_VMAutomation folder to the root of your C: drive.

This folder contains five subfolders and the CCEPAKM1_VMDataSheet_90x file. All folders except the scripts folder are empty until you run the automation script.

  • The Archive subfolder will hold any prior versions of the automation spreadsheet, saved with a date and time stamp.
  • The Log subfolder holds all log files saved with a date and time stamp.
  • The PlatformConfigRepository subfolder has three subfolders.
    • The CUCM folder has three XML files—one for the publisher and one for each subscriber.
    • The CUIC folder has two XML files—one for the publisher and one for the subscriber.
    • The FINESSE folder has two XML files—one for the primary node and one for the secondary node.
  • The Report subfolder holds all automation reports, saved with a date and time stamp. (This subfolder is empty until you run the automation script.)
  • The scripts subfolder holds four scripts. The file named deployVM.PS1 is the primary script and calls the other scripts during the automation.
  • CCEPAKM1_VMDataSheet_90x is the spreadsheet to complete for the automation process.

Complete Automation Spreadsheet

The CCEPAKM1_VMDataSheet_901 automation spreadsheet contains a row for each virtual machine that will be created from the source system.

The automation script reads this spreadsheet row-by-row. For each golden template, the script clones, creates the customization file for the operating system, and deploys all virtual machines to the destination Sides A and B.



Automation Spreadsheet Values

This table explains the value required in each cell of the CCEPACM1_VMDatasheet_901 spreadsheet. Enter values for the Source server. Obtain and enter values for the Destination servers.


Note


The Description column below identifies any guidelines that apply to the data. For example, GOLDEN_TEMPLATE_NAME cannot contain spaces. Both the automation spreadsheet and VMWare accept names that do not comply with these guidelines. However, the automation script will fail if the template names are not in conformance with them.

Column

Description

Example

VM_TYPE

The type of the VM, based on the Contact Center software installed. Default contents are not editable.

UCCE_CallServer_SideA

OS_TYPE

The type of Operating System installed on the VM. Default contents are not editable.

Windows2008

CREATEVM

Required. Retain the default YES to create a VM using automation. Change to NO to skip VM creation during automation.

YES

SOURCE_HOST_IP

Required. The IP address of the ESXi host for this Golden Template.

xx.xx.xxx.xxx

SOURCE_DATASTORE_NAME

Required The name of the Datastore where this Golden Template resides.

datastore1(3)

GOLDEN_TEMPLATE_NAME

Required. The name of the Golden Template from which the new VM it to be deployed. Cannot contain spaces.

My_CallServer

NEW_VM_NAME

Required. The name for the new VM. Cannot contain spaces or special characters. Maximum of 32 characters.

CallServerSideA

DEST_HOST_IP

Required. The IP address of the ESXi Host for the new VM.

xx.xx.xxx.xxx

DEST_DATASTORE_NAME

Required. The name of the Datastore for the new VM.

datastore2(1)

PRODUCT_VERSION

Currently this field is applicable only for Cisco Unified Communications Manager.

9.0.x

COMPUTER_NAME

Required. The NET BIOS name for the new computer. 15-character maximum. Do not use special characters /, \, ?,:,*,",<,>,.,.

Demo-CallSrvA

WORK_GROUP

Dropdown:

YES adds the VM to a WorkGroup and enables WORK_GROUP_NAME.

NO adds the VM to a domain and enables DOMAIN_NAME, DOMAIN_USER, and DOMAIN_PASSWORD.

NO

WORK_GROUP_NAME

Required. Enter the Workgroup name. Used only if WORK_GROUP is set to YES.

NA

DOMAIN_NAME

Required. Enter the Domain name. Used only if WORK_GROUP is set to NO.

mydomain.com

TIME_ZONE_LINUX_AREA

Required. Drop-down selection of the timezone area to be set Unified CM. For the United States of America, select America.

America

TIME_ZONE_LINUX_LOCATION

Required. Drop-down selection of the timezone location to be set for Unified CM, CUIC, or Finesse.

Eastern

TIME_ZONE_WINDOWS

Required. Drop-down selection of the timezone to be set for the Unified CVP and Unified CCE VMs.

(GMT-05:00) Eastern Time (US & Canada)

DOMAIN_USER

Required. The user name for a domain user with privileges to add the new computer to the domain. Enabled only if WORK_GROUP is set to NO.

HarryUser

DOMAIN_PASSWORD

Required. The password for the domain user. Enabled only if WORK_GROUP is set to NO.

package123

PRODUCT_KEY

Required. The valid Windows OS product key in the format xxxxx-xxxxx-xxxxx-xxxxx-xxxxx.

ZZZM2-Y330L-HH123-99Y1B-GJ20B

OWNER_NAME

Required. The full name of the owner.

Administrator and Guest are not allowable names.

This is a mandatory field for OS_TYPE Windows 2008.

LabAdmin

ORGANIZATION_NAME

Required. The Organization Name to be set for Unified CM, CUIC, or Finesse.

MyOrganization

ORGANIZATION_UNIT

Required. The Organization Unit to be set for Unified CM, CUIC, or Finesse.

MyUnit

ORGANIZATION_LOCATION

Required. The Organization Location to be set for Unified CM, CUIC, or Finesse.

MyCity

ORGANIZATION_STATE

Required. The Organization State to be set for Unified CM, CUIC, or Finesse.

MyState

ORGANIZATION_COUNTRY

Required. Drop-down selection of the Organization Country to be set for Unified CM, CUIC, or Finesse.

United States of America

NTP_SERVER

Required. The IP Address of the NTP server.

xx.xx.xxx.xxx

NIC_NUM

Values in the field are pre-populated based on VM_TYPE field and are protected. Values are "1" or "2".

This value indicates the number of NICs to be configured for the VMs.

2

IP_ADDRESS_NIC1

Required. A valid IPv4 address for NIC1.

xx.xx.xxx.xxx

SUB_NET_MASK_NIC1

Required. A valid subnet mask (IPv4 address) for NIC 1.

xx.xx.xxx.xxx

DEFAULT_GATEWAY_NIC1

Required. A valid Default gateway (IPv4 address) for NIC1.

xx.xx.xxx.xxx

DNS_IP_NIC1

Required. A valid IPv4 address for the primary DNS for NIC1.

xx.xx.xxx.xxx

IP_ADDRESS_NIC2

Required. A valid IPv4 address for NIC 2.

Valid only if the value in the NIC_NUM fields is 2.

xx.xx.xxx.xxx

SUB_NET_MASK_NIC2

Required. A valid subnet mask (IPv4 address) for NIC 2. For Unified CCE VMs only.

255.255.255.255

DNS_IP_NIC2

Required. A valid IPv4 address for the primary DNS for NIC2. For Unified CCE VMs only.

xx.xx.xxx.xxx

DNS_ALTERNATE_NIC2

Optional. A valid IPv4 address for the alternate DNS for NIC2. For Unified CCE VMs only. Must differ from the address of the primary DNS for NIC2.

xx.xx.xxx.xxx

Refer to the Appendix for an Automation Checklist for entry of information for your automation.

Run Automation Script

Launch VMware vSphere PowerCLI (32-Bit) to run the automation script.

The first time you run PowerCLI, you must enter the command get-executionpolicy to determine whether the Restricted Execution policy is in effect or is restricted

If the policy is restricted, enter set-executionpolicy. At the Supply Values prompt, enter "Unrestricted." Then enter 'Y". This changes the execution policy so that you can run unsigned scripts that you write on your local computer and signed scripts from other users.

What to Do Next

Enter a command using the following syntax: <Path to the script> <Path of the spread sheet> <vCenter IP / Hostname> <vCenter User> <Password to connect to vCenter> C:\GoldenTemplateTool_90x\scripts\DeployVM.PS1 C:\GoldenTemplate_90x\CCEPACM1_VMDataSheet_901.xls testvCenter testuser testpassword

This starts a script that parses the data, validates the data, creates a VM and a customization file for the VM.

Ongoing status messages, updated every 30 seconds, display as the script executes.

If you monitor the progress in the vSphere client, note that the vSphere Target is the golden template source.

If the script runs successfully, it will typically complete in several hours.

If the script encounters errors, it stops and displays those errors on the screen and also stores them in the log file. Refer to Troubleshooting for tips on resolving errors.

Completion of the script generates a status report in the Report folder. The status report has a link to the Log file. Consult this file to debug error conditions and to consult with Cisco Support.