Installing and Configuring Cisco HCS for Contact Center 9.2(1)
Clone and OS Customization
Downloads: This chapterpdf (PDF - 2.19MB) The complete bookPDF (PDF - 13.52MB) | The complete bookePub (ePub - 5.3MB) | Feedback

Clone and OS Customization

Clone and OS Customization

Clone and OS Customization Process

Figure 1. Clone and OS Customization Process for 500 and 1000 Agent Deployment

Figure 2. Clone and OS Customization Process for 4000 Agent Deployment

Automated Cloning and OS Customization

For automation software list and download information, See Automation Software

Download Automation Tool

The automation tool is contained in the GoldenTemplateTool_​921.zip file.

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

Figure 3. Golden Template Tool _921 folder

This folder contains six sub folders and two Golden Template VM Data sheets.

  • The Archive subfolder holds 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. All folders are empty until you run the automation script:
    • For 500 and 1000 Deployment, the Unified Communications Manager folder has three XML files-one for the publisher and one for each subscriber.

    • For 4000 Deployment, the Unified Communications Manager folder has nine XML files-one for the publisher and one for each subscriber.

    • For 500 and 1000 Deployment, the CUIC folder has two XML files-one for the publisher and one for the subscriber.

    • For 500 and 1000 Deployment, the FINESSE folder has two XML files-one for the primary node and one for the secondary node.

    • For 4000 Deployment, the FINESSE folder has four XML files-one for each primary node and one for each 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.
  • GoldenTemplate_VMDataSheet_921.xls is the spreadsheet to complete the automation process of 500 and 1000 agent deployments.
  • GoldenTemplate_VMDataSheet_921_4K.xls is the spreadsheet to complete the automation process of 4000 agent deployments.

  • The PARITY_TOOL subfolder is for future enhancements.

Complete Automation Spreadsheet

The GoldenTemplate_VMDataSheet_921.xls and GoldenTemplate_VMDataSheet_921_4K.xls automation spreadsheets 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.

Figure 4. GoldenTemplate_VMDataSheet_921.xls Automation Spreadsheet


Note


You will require only two Unified CVP Servers for 500 agent deployment model.


Automation Spreadsheet Values

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


Note


The following Description column identifies any guidelines that apply to the data. For example, GOLDEN_TEMPLATE_NAME cannot contain spaces. Both the automation spreadsheet and VMWare accept names comply with these guidelines. However, the automation script fails 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 NO to skip VM creation during automation. Change to YES to create a VM using automation. YES
CUSTOMIZATION Required. Default value is YES. If the value is NO, it skips OS customization of VM. Change value to YES to allow OS customization. NO
SOURCE_HOST_IP Required. The IP address of the ESXi host for this golden template. xxx.xxx.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 is to be deployed. Cannot contain spaces and special characters /, \, ?,:,* ,.,",<,>. MyCallServer
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. xxx.xxx.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, Unified Intelligence Center, and Cisco Finesse. 9.1(1)
COMPUTER_NAME Required. The NET BIOS name for the new computer. 15-character maximum. Do not use the special characters /, \, ?,:,* ,.,",<,> DemoCallSrvA
WORK_GROUP Drop-down list:

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, Unified Intelligence Center, or Cisco 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. password@123
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. MyOrganization
ORGANIZATION_UNIT Required. The Organization Unit to be set for Unified CM, Unified Intelligence Center, or Cisco Finesse. MyUnit
ORGANIZATION_LOCATION Required. The Organization Location to be set for Unified CM, Unified Intelligence Center, or Cisco Finesse. MyCity
ORGANIZATION_STATE Required. The Organization State to be set for Unified CM, Unified Intelligence Center, or Cisco Finesse. MyState
ORGANIZATION_COUNTRY Required. Drop-down selection of the Organization Country to be set for Unified CM, Unified Intelligence Center, or Cisco Finesse. United States of America
NTP_SERVER Required. The IP Address of the NTP server. xxx.xxx.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. xxx.xxx.xxx.xxx
SUB_NET_MASK_NIC1 Required. A valid subnet mask (IPv4 address) for NIC 1. xxx.xxx.xxx.xxx
DEFAULT_GATEWAY_NIC1 Required. A valid Default gateway (IPv4 address) for NIC1. xxx.xxx.xxx.xxx
DNS_IP_NIC1 Required. A valid IPv4 address for the primary DNS for NIC1. xxx.xxx.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.

xxx.xxx.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. xxx.xxx.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. xxx.xxx.xxx.xxx

Run Automation Script

Launch VMware vSphere PowerCLI (32-Bit) to run the automation script.
The first time you run PowerCLI, you must enter the following command to determine whether the Restricted Execution policy is in effect or is restricted.
get-executionpolicy
If the policy is restricted, enter the following command:
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 syntax:
<Path to the script> <Path of the spread sheet>
			 <vCenter IP / Hostname> <vCenter User> <Password to connect to vCenter>

Command for 500 and 1000 Agent Deployment:

C:\GoldenTemplateTool_921\scripts\DeployVM.PS1 C:\GoldenTemplateTool_921\GoldenTemplate_VMDataSheet_921.xls testvCenter testuser testpassword

Command for 4000 Agent Deployment:

C:\GoldenTemplateTool_921\scripts\DeployVM.PS1 C:\GoldenTemplateTool_921\GoldenTemplate_VMDataSheet_921_4K.xls testvCenter testuser testpassword

Figure 5. Automation Script

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.

Figure 6. Status Messages

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

Figure 7. vSphere Target

If the script runs successfully, it typically completes 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.

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.

Figure 8. Status Report of Golden Template to VM Conversion



OS Customization Process

Validate Network Adapter Settings and Power On

Perform this procedure for all Windows VMs.

Procedure
    Step 1   Select the Virtual Machine in the vSphere client. Right-click the VM and choose Edit settings.
    Step 2   On the Hardware tab, select each Network adapter. Make sure that Connect at power on in the Device Status group is checked:
    Step 3   Power on the virtual machine.
    Important:

    Do not press Ctrl-Alt-Delete. If you press Ctrl-Alt-Delete after powering on, the customization does not take effect. You must complete it manually. For more information, see http:/​/​docwiki.cisco.com/​wiki/​Recover_​from_​Pressing_​Ctrl-Alt-Del_​During_​Power-On .

    Step 4   Wait for the VM to restart and to apply customization. This can take five to ten minutes.

    Edit Registry Settings and Restart VM

    Perform this procedure for all Windows VMs.

    Procedure
      Step 1   Go to Start > Administrative Tools > Computer Management.
      Step 2   On the left panel, expand Computer Management (Local) > System Tools > Local Users and Groups > Users.
      Step 3   On the right panel, right-click the administrator and choose Set Password.
      Step 4   Click Proceed at the warning message, and then enter the new password.
      Step 5   Click OK to save.
      Step 6   Access the Registry Editor (Start > Run > regedit).
      Step 7   Navigate to HKEY_LOCAL_MACHINE > SOFTWARE > Microsoft > Windows NT > Current Version > Winlogon.
      1. Set AutoAdminLogon to 0.
      2. Remove these keys if they exist: DefaultDomainName and DefaultUserName .
      Step 8   Restart the machine. If the machine is in the domain, log in to the domain.
      Step 9   To synchronize time with the domain controller, open a command prompt and type the command NET TIME /DOMAIN:<domain>.

      Copy Answer Files to Virtual Machines

      Golden Template automation tool generates answer files for unattended installations. Individual answer files get copied to the C:\GoldenTemplateTool_lO\PlatformConfigRepository directory. These answer files are then converted to a floppy diskette file format and are used in addition to your VOS product DVD during the installation process.

      Before You Begin

      Download and then install WinImage 8.5 on the client computer from which the automation scripts will be run. http:/​/​winimage.com/​download.htm

      Procedure
        Step 1   In the client computer where the automation tool was run, navigate to %Home%\Platform Config Repository subfolders

        Example: C:\GoldenTemplateTool_IO\PlatformConfigRepository\CUCM .
        Step 2   In the required VOSS product folder, copy the node specific .xml file and paste it in another location, then rename it to platformConfig.xml

        Example: Copy CUCM_PUB_SideA_platformConfig.xml to other location and rename it to platformConfig.xml .
        Step 3   Launch WinImage and select File > New > 1.44 MB and click OK
        Step 4   Drag and drop platformConfig.xml into WinImage
        Step 5   When prompted to inject the file, click Yes.
        Step 6   Select File > Save As
        Step 7   From the Save as type list, choose Virtual floppy image. Provide the file name as platformConfig.flp and click Save
        Step 8   Open vSphere infrastructure client and connect to the vCenter. Go to the customer ESXi host where the VMs are deployed
        Step 9   Navigate to the Configuration tab. In the storage section, right click on the Datastore and choose Browse Datastore, create a folder named <Product_Node>

        Example: CUCM_PUB .
        Step 10   Upload the platformConfig.flp file to the folder <Product_Node>.


        Example: CUCM_PUB .
        Step 11   Navigate to the <Product_Node> Virtual Machine(Ex; CUCM_PUB_SideA). Right-click and choose Edit Settings
        Step 12   On the Hardware tab, click Floppy drive 1, choose the radio button Use The Existing Floppy Image in Datastore.
        Step 13   Mount the platformConfig.flp from the <Product_Node> folder (Ex: CUCM_PUB) on the data store and click OK
        Step 14   Ensure that the Device status shows Connect at Power On checked for the Network adapter and for the Floppy drive and click OK.

        Manual Cloning and OS Customization

        Create Customization File for Windows Based Components

        Complete the following procedure to create the customization file for windows based components .

        Procedure
          Step 1   In VMware vSphere Client, choose View > Management > Customization Specification Manager.
          Step 2   Click New.
          Step 3   On the New Customization Specification page, complete the new customization specification:
          1. From the Target Virtual Machine OS menu, choose Windows.
          2. Under the Customization Specification Information, enter a name for the specification and an optional description and click Next.
          Step 4   On the Registration Information page, specify the registration information for this copy of the guest operating system. Enter the virtual machine owner's name and organization and click Next.
          Step 5   On the Computer Name page, click the most appropriate computer name option that identifies this virtual machine on the network.
          Step 6   On the Windows License page, specify the Windows licensing information for this copy of the guest operating system:
          1. Enter your product volume license key.
          2. Check Include Server License information (required to customize a server guest operating system).
          3. Click Per server to specify the server license mode. Enter 5 as the maximum number of connections you want the server to accept. Click Next.
          Step 7   On the Administrator Password page, enter a password for the administrator account and confirm the password by reentering it. Click Next.
          Step 8   On the Time Zone page, choose the time zone for the virtual machine and click Next.
          Step 9   On the Run Once page, click Next.
          Step 10   On the Network page, choose the type of network settings to apply to the guest operating system and click Next:
          1. Typical settings allow the vCenter server to configure all network interfaces from a DHCP server.
          2. Custom settings require you to manually configure the network settings.
          Step 11   On the Workgroup or Domain page, click Windows Server Domain and enter the destination domain, the username, and the password for a user account that has permission to add a computer to the specified domain.
          Step 12   On the Operating System Options page, check Generate New Security ID (SID) to generate a new security identity and click Next.
          Step 13   On the Ready to complete page, review your Customization File Summary, and then click Finish.

          Generate Answer File for VOS Product Virtual Machines

          Complete the following procedure to generate an answer file for VOS product Virtual machines.
          Procedure
            Step 1   Open the link http:/​/​www.cisco.com/​web/​cuc_afg/​index.html.
            Step 2   Configure the following cluster-wide parameters:
            1. Under Hardware, select Virtual Machine for Primary Node Installed On.
            2. Under Product, select the product name and the product version.
            3. Under Administrator credentials, enter the administrator username and password, and confirm the password.
            4. Under Security Password, enter a password and confirm password.
            5. Under the Application user credentials, enter the application username, password, and confirm the password.

              Cisco suggests that you use the same System Application or Administrator credentials for all nodes.

            6. Under Certificate information, enter the organization name, unit, location, state, and country for the Unified CM and Unified Intelligence Center.
            7. Under SMTP, check the box Configure SMTP host and enter the SMTP location.
            Step 3   Configure the following primary node parameters:
            1. Under NIC Interface Settings, check the check box Use Auto Negotiation.
              Note    Do not change the MTU settings.
            2. Under Network Information, enter the IP address, hostname ,IP mask, and gateway information.

              Do not select the option Use DHCP for IP Address Resolution.

            3. Under DNS, select the option Configure Client DNS, and enter Primary DNS IP and DNS name.
            4. Under Timezone, select the option Use Primary Time Zone Settings.
            5. Under Network Time Protocol, check Use Network Time Protocol and enter the IP address, NTP server name, or NTP Server Pool name for at least one external NTP server.
            Step 4   Configure the following secondary node parameters:
            1. Under NIC Interface Settings, check the check box Use Auto Negotiation.
              Note    Do not change the MTU settings.
            2. Under Network Information, enter the IP address, hostname, IP mask, and gateway information.

              Do not select the option Use DHCP for IP Address Resolution.

            3. Under DNS, select the option Configure Client DNS, and enter primary DNS IP and DNS name.
            4. Under Timezone, check Use Primary Time Zone Settings.
            5. Under List of Secondary Nodes, click Add Secondary Node.
            Step 5   Click Generate Answer files & License MAC to download the answer file for publisher and first subscriber.
            Note    For Unified CM, where an answer file for a second subscriber is required, close and open the answer file generator web page and enter the details for the publisher and second subscriber. Download the answer file for the second subscriber only, because you already downloaded the publisher file along with the first subscriber.
            Step 6   Perform steps given in section for mounting the answer files to VM. See Copy Answer Files to Virtual Machines

            Deploy Virtual Machine from the Golden Template

            Complete the following procedure to deploy the virtual machine from the golden template. Use the deployment checklists to record the hosts, IP addresses, and SAN locations for your deployment.

            Procedure
              Step 1   Right-click the template and choose Deploy Virtual Machine from this template.
              Step 2   Enter a virtual machine name, choose a location, and click Next.
              Step 3   On the Host/Cluster page, specify the host on which you want to store the template. Make sure that the host/cluster is valid. Click Next.
              Step 4   Click Advanced. Specify a valid datastore for the virtual machine that complies with the Cisco HCS for Contact Center component you deploy.
              Step 5   Click Next.
              Step 6   Make sure that the data store RAID levels for the component that you install comply with conditions specified in the table of SAN Configuration for your deployment model.
              Step 7   Click Thick provisioned Lazy Zeroed to allocate a fixed amount of storage space to the virtual disk. Click Next.
              Step 8   Click Customize using an existing customization specification and click Next.
              Step 9   Select the customization file created in Create the Customization File for the Template.
              Step 10   Review the settings for the new virtual machine. Click Finish.