Creating the VGP in BMC Server Automation for Citrix XenServer

You can build a repeatable process for deploying new virtual systems by using a virtual guest package (VGP). The VGP describes the new virtual system you want to add.

For example, you can base the VGP on an existing VMware vCenter template or create the VGP using values of your own, if you do not have an existing machine or template on which to base the configuration. Having a base package from which to deploy new virtual machines helps enforce consistency and standards, such as including Antivirus and management software on any new virtual machine.

The following sections describe how to create a VGP in BMC Server Automation:

Before you begin

Review the following sections for requirements and recommendations for creating VGPs.

About the VGP

A VGP bundles configuration changes so they can be deployed to hosts/clusters using a Virtual Guest Job. A VGP consists of an instruction set and any files needed for implementing configuration changes. Configuration changes can consist of additions, deletions, and modifications to any of the server objects BMC supports on all operating systems. This capability allows you to create multiple VGPs, each designed and tailored for a specific use.


  • You should create VGPs from virtual machine templates. 

     Click here to review the requirements for creating VM templates.

    This section provides an overview of the steps when creating a VM template on VMware vCenter. A VM template is a reusable image created from an existing VM. You use these VM templates when creating a VGP in BMC Server Automation.


    Review the following requirements for VM templates.

    Requirement / RecommendationDescription
    IPv6 not supported

    When creating templates for BMC Cloud Lifecycle Management, ensure that IPv6 is disabled, as BMC Cloud Lifecycle Management does not support IPv6.

    For information about disabling IPv6, see the following Microsoft support article:

    How to disable IPv6 or its components in Windows

    OS customization supportBefore creating a VM template, ensure that your version of vCenter supports OS Customization for the specified guest OS. See the VMware vSphere online documentation regarding Operating System Compatibility for vCenter Server.
    VMware ToolsVMware Tools must be installed in all templates. Refer to the VMware online documentation for installation details.
    Microsoft System Preparation (Sysprep) tool VMware vCenter uses the Microsoft System Preparation (Sysprep) tool to automate the deployment of various Microsoft operating systems. Sysprep must be present on the vCenter to support OS Customization for Microsoft Windows. If Sysprep is not present for a specific version of Windows, OS Customization will fail. This in turn causes the VirtualGuest create task to fail.
    Recommendations for multiple vCenter environments

    See Working with multiple vCenter deployments.

    Adding a BMC Server Automation agent to the VM template

    Before you use a VM template to create a VGP, use the following procedure to add a BMC Server Automation RSCD agent to the template:

    1. Convert the template to a VM.
    2. Install a BMC Server Automation RSCD agent on the VM (see Installing only the RSCD agent (Linux and UNIX) and Installing an RSCD agent (Windows)).
    3. From a remote machine, use the BMC Server Automation agentinfo utility to ensure connectivity. Enter the following command:
      agentinfo hostname
      If the agent is not reachable, you may need to disable the firewall on the VM.
    4. Delete the BladeLogicRSCD user before converting the VM to a template.
    5. Convert the VM back to a template.
    Linux VM templates

    Linux VM templates must include the following:

    1. Modify the /etc/rc.d/rc.localscript to ensure successful DNS registration. See the following example for the recommended modification:

      dhcpHostname=`grep "DHCP_HOSTNAME=.*" /etc/sysconfig/network`
      dhcpHostname=`echo "$dhcpHostname" | sed "s/\s*//g"`
      if [ -z "$dhcpHostname" ]; then
      echo "DHCP_HOSTNAME=$HOSTNAME" >> /etc/sysconfig/network
      else if [ "DHCP_HOSTNAME=$HOSTNAME" != "$dhcpHostname" ]; then
      sed "s/DHCP_HOSTNAME=.*/DHCP_HOSTNAME=$HOSTNAME/g" /etc/sysconfig/network > /tmp/hostnamechange
      mv /tmp/hostnamechange /etc/sysconfig/network
    2. Distribute the UNIX Users custom object to the BMC Server Automation agent to validate users created on VMs. See the BMC Server Automation online technical documentation for details).


    For creating VM templates for the SUSE Linux, Oracle Enterprise Linux, and Cent OS platform, a cloud user must create the templates in VMware vCenter with Guest OS as RedHat Linux. BMC Server Automation supports creation of virtual guest package on these templates only.

  • Create VGPs in the CSM_Virtual_Guest_Packages folder (under Depot) in the BMC Server Automation Console.
  • To support hostname configuration in the virtual guest, select the Custom option in the VM Config Type Settings tab. For more information, see VMware - Config.
  • Ensure that the VGP for bare-metal virtual machines is assigned a larger disk space amount than what is assigned to the system package. Otherwise, the provisioning fails with the somewhat misleading error message OS Not Found.


Consider the following general recommendations for creating VGPs:

  • Do not include any static IP addresses in the configuration of the VGP.
  • Do not include any information that is instance-specific, such as a hard-coded host name.

To create a VGP for BMC Cloud Lifecycle Management

This section describes how to create a VGP manually. Beginning with BMC Server Automation 8.2, you can also create VGPs automatically, using the Virtual Guest Template Enrollment Job. For more information, see the related topic in the BMC Server Automation online technical documentation.

  1. From the Depot folder, right-click the depot folder where you want to add the VGP. From the pop-up menu, select New > Virtual Guest Package> Citrix XenServer.


    You should create VGPs in the Depot in the CSM_Virtual_Guest_Packages folder.

  2. On the Virtual Guest Package dialog, enter the following:

    The virtual machine name and the server name are required. However, BMC Cloud Lifecycle Management overrides these values.




    Enter a name for the package.


    Enter a brief description of the package.

    Member of

    Browse to the folder in the Depot where you want the VGP to be created.

    VM Guest Package type

    Perform the following steps:

      1. Click the Browse button to choose a Citrix XenServer template, custom template, or virtual machine on which to base the new virtual machine.
      2. On the Select Citrix XenServer Template dialog box box, select the server that contains the template or virtual machine.
      3. Select the virtual machine or template type, either a XenServer-provided template, custom template, or virtual machine.
      4. Select the virtual machine or template from the displayed list, and click OK.
  3. Click Next.
  4. On the Permissions panel, enter the permissions for the VGP. The Permissions panel is an access control list granting roles access to this VGP. Access to all objects, including the sharing of objects between roles, is controlled through access control lists (ACLs). Make sure that your role has the VirtualGuestPackageCitrixXen.* permission to create a VGP for a Citrix XenServer environment.
  5. Click Finish.
    A dialog displays, indicating that the package is being saved to the Depot.

To modify the VGP

After the VGP is saved, the Virtual Guest Package editor is displayed, enabling you to modify the VGP.

  1. On each tab in the editor, enter the desired configuration settings for your VGP.
  2. The following panels apply to Citrix XenServer environments:

     Citrix XenServer - General - Memory - Processor Settings panel - Click here to see descriptions of the fields

    The General/Memory/Processor Settings panel lets you specify identification information and processor and memory settings for the virtual machine.

    General settings

    Specify the following:

    • Virtual Machine Name
    • Virtual Machine Description
    • Source VM/Template Name—Read-only field based on the selected VM/template.

      Note: If you select a template with a name that exists both as XenServer and custom templates, preference is given to the custom template, which is used as a reference during the deploy operation.

    • Source VM/Template Description—Read-only field based on the selected VM/template.

      Note: If the template is from a server running XenServer 5.5, the Template Description shown on this panel may not match the template description shown in XenCenter.

    Processor and memory settings

    Select the following:

    • Number of VCPUs
    • Initial Memory (MB)
    • Under Boot Settings, specify any advanced boot parameters.
    • Auto Start—Automatically starts the new virtual machine as soon as the host is booted.

     Citrix XenServer - Storage - Network Settings panel - Click here to see descriptions of the fields

    The Storage/Network Settings panel lets you specify storage and network settings appropriate for the new virtual machine.


    Click Add to open the Disk Settings dialog box, where you can add any of the following:

    • Disk Name
    • Disk Description
    • Size (MB)
    • Select Server—Select a server from the drop-down list. The selection populates the list of disks at the bottom of the dialog box.
    • Location—Displays the path for the storage location of the disk you selected.

    Click Add to open the Virtual Interface Settings dialog box and add any of the following:

    • Server—Select a server from the drop-down list.
    • Network Name—Select from the networks attached to the selected server.
    • MAC Address—You can either enter a MAC address, or choose to have the address generated automatically.
    • Under IP Configuration, there are two tabs for IPv4 and IPv6 addresses. Choose to have the IP address obtained automatically using Dynamic Host Configuration Protocol (DHCP), or choose to use a specific IP address by specifying the following:
      • IP Address
      • Subnet mask (for IPv4)
      • Prefix Length (for IPv6)
      • Default gateway
    • Under DNS Configuration, choose to have the DNS server obtained automatically, or to use a specific server by specifying the following:
      • Primary DNS server
      • Secondary DNS server
      • Tertiary DNS server
    • Specify a DNS Suffix for this Connection.

  3. Save the package.

Where to go next

Publishing the Product Catalog

Was this page helpful? Yes No Submitting... Thank you