VPS Summary Letter

VPS Summary letter allows specifying template for the text displayed at "Help" page of VPS properties as well as e-mail message sent to the customer after VPS created.

To modify VPS Summary template open user account home page and click "Mail Templates" link at the right bottom toolbox.

The following substitution variables can be used in the message body and message subject:

#email# - true if being rendered to send by e-mail; otherwise false.

#creation# - true if being rendered in the time of VPS creation.

#space# - hosting space details representing the object with the following fields:

  • PackageId (int)
  • PlanId (int)
  • PackageName (string)
  • PurchaseDate
  • StatusId (int)

#user# - user account, space owner representing the object with the following fields:

  • UserId
  • Username (string)
  • Password (string)
  • Email (string)
  • FirstName (string)
  • LastName (string)
  • CompanyName (string)
  • IsDemo (bool)
  • RoleId (int)

#vm# - VPS object with the following fields:

  • Id
  • Name - full qualified VPS name, e.g. "vps01.domain.local"
  • Hostname - host part of VPS name (before the first dot), e.g. "vps01"
  • Domain - domain part of VPS name (DNS suffix), e.g. "domain.local"
  • OperatingSystemTemplate
  • AdministratorPassword
  • CpuCores
  • RamSize
  • HddSize
  • SnapshotsNumber
  • DvdDriveInstalled
  • BootFromCD
  • NumLockEnabled
  • StartTurnOffAllowed
  • PauseResumeAllowed
  • RebootAllowed
  • ResetAllowed
  • ReinstallAllowed
  • ExternalNetworkEnabled
  • PrivateNetworkEnabled
  • ManagementNetworkEnabled

#external_nic# - object containing external network configuration with the following fields:

  • MacAddress – dash delimited MAC address of network adapter, for example “AA-BB-CC-11-22”.
  • SubnetMask – sub net mask of the first IP address (primary) in the list.
  • DefaultGateway – default gateway IP of the first IP address (primary) in the list.
  • PreferredNameServer
  • AlternateNameServer
  • IPAddresses - array of NIC IP addresses. Each element of this array represents the object with fields:
    • IPAddress
    • NATAddress
    • SubnetMask
    • SubnetMaskCidr – sub net mask in CIDR notation
    • DefaultGateway
    • IsPrimary

#private_nic# - object containing private network configuration with the following fields:

  • MacAddress
  • SubnetMask
  • DefaultGateway
  • PreferredNameServer
  • AlternateNameServer
  • IPAddresses - array of NIC IP addresses. Each element of this array represents the object with fields:
    • IPAddress
    • SubnetMask
    • DefaultGateway
    • IsPrimary

#management_nic# - object containing management network configuration with the following fields:

  • IsDHCP
  • MacAddress
  • SubnetMask
  • DefaultGateway
  • PreferredNameServer
  • AlternateNameServer
  • IPAddresses - array of NIC IP addresses. Each element of this array represents the object with fields:
    • IPAddress
    • NATAddress
    • SubnetMask
    • DefaultGateway
    • IsPrimary

Please see this page for more information about WebsitePanel templates.

You may use a special service page to test VPS templates (used in summary letter and Sysprep files) built into WSP that is available in your WSP installation by the following URL:

http://<portal-URL>/DesktopModules/DotNetPanel/VPS/TestVirtualMachineTemplate.aspx

You may download sample VPS summary template from VPS Solution resources page: [link TBD]

Please see this page for more information about template engine library and its syntax: http://www.adersoftware.com/index.cfm?page=templateEngine2