Console

Use the Citrix Provisioning Console to manage components within a Provisioning Farm. The Console can be installed on any machine that can access the farm. For more information, see Using the Console.

Starting the Console

Before starting the Console, make sure that the Stream Service is started and running on the Provisioning Server. (After the Configuration Wizard runs, the Stream Service starts automatically).

To start the Console from the Start menu:

Select All Programs>Citrix>Provisioning Services>Citrix Provisioning Console

The Console main window appears.

Common Console actions

The following menu options are common to most objects in the Console:

New Window From Here:

  • To open a new Console window, right-click on an object in the tree or in the details pane, then select the New Window from Here menu option.
  • A new Console window opens. It may be necessary to minimize the window to view and toggle between one or more windows.

Refresh:

  • To refresh information in the Console, right-click a folder, icon, or object, then select Refresh.

Export List:

  1. To export table information from the details pane to a text or comma delimited file, select Export from the Action menu.
  2. Select the location where this file should be saved.
  3. Type or select the file name in the File name textbox.
  4. Select the file type from and Save as text boxes. 1. Click Save to save the file.

Help: Select an object in the Console, then select Help from the Action menu to display information about that object.

View Options: To customize a Console view:

  1. Select View, then select either Add/Remove Columns, or Customize.
    • If you selected Add/Remove Columns, use the Add and Remove buttons to select which columns to display.
    • If you selected Customize select the checkbox next to each MMC and Snap-in view option that should display in the Console window.
  2. Click OK. The Console window refreshes to display the selected options.

Performing tasks in the Console

The following menu options are common when performing tasks in the Console:

  • Action menu: Select object-related tasks from the Action menu, including boot, restart, send message, view properties, copy or paste properties.
  • Right-click (context menu): Right-click a managed object(s) to select object-related tasks. For a complete list of tasks, refer to that object’s management chapter within this guide.
  • Drag and drop: Using the Drag-and-Drop feature, you can quickly perform several common Console tasks such as:
    • Move target devices by dragging them from one device collection, and dropping them on another device collection within the same site
    • Assign a vDisk to all target devices within a collection by dragging the vDisk and dropping it on the collection. The vDisk and the collection must be in the same site; the new vDisk assignment replaces any previous vDisk assignments for that collection.
    • Add a target device to a view by dragging the device, then dropping it on the view in Console’s tree; Drag a Provisioning Server from one Site, then drop it into another site. Note: Any vDisks assignments that were specific to this server and any store information will be lost.
  • Copy and paste: Select an object in the Console window, then use the Copy and Paste right-click menu options to quickly copy one or more properties of a vDisk, Provisioning Server, or target device, to one or more existing vDisks, Provisioning Servers, or target devices. To copy the properties of a one object type and paste those properties to multiple objects of the same type:
    1. In the tree or details pane, right-click the object which has the properties you want to copy, then select Copy. The object-specific Copy dialog appears.
    2. Place a check in the checkbox next to each of the object properties you want to copy, then click OK.
    3. In the Console tree, expand the directory where the object exists so that those objects display in either the tree or details pane, 4) Right-click on the object(s) in the tree or details pane that you want to paste properties to, then select Paste.
  • Views: Create views containing target devices to display only those target devices that you are currently interested in viewing or performing tasks on. Adding target devices to a view provides a quick and easy way to perform a task on members of that view, such as: Boot, Restart, Shutdown, Send message.

Views can be created at the site level or at the farm level. To perform a task on members of a view:

  1. Right-click on views icon, then select the Create View menu option. The View Properties dialog appears.
  2. Type the name and a description of the new view in the appropriate text boxes, then select the Members tab.
  3. To add target devices to this view, click the Add button. The Select Target Devices dialog appears.
  4. If you are creating the view at the farm level, select the site where the target devices reside. If you are creating the view at the site level, the site information is already populated.
  5. From the drop-down menu, select the device collection where the target devices to add are members.
  6. Select from the list of target devices that display, then click OK.
  7. If necessary, continue adding target devices from different device collections within a site.
  8. Click OK to close the dialog.

For more information on views, refer to Managing Views.

Configuring the bootstrap from the Console

For the Provisioning Server to start a target device, a boot file is downloaded by the Citrix Provisioning MBA or PXE-compliant boot ROM, when the device is turned on. This file must be configured so that it contains the information needed to communicate with the Provisioning Servers. The Configure Bootstrap dialog is used to define the IP addresses for up to four Provisioning Servers in the boot file.

Note:

For alternative boot methods, refer to Using the Manage Boot Devices Utility.

The Configure Bootstrap dialog includes the following tabs:

  • General
  • Target device IP
  • Server lookup
  • Options

General tab

Field Description
Bootstrap file The currently selected boot file. If you want to select a different boot file to configure, click the Add button or Read Servers from the Database button.
IP settings The IP Address, Subnet Mask, Gateway, and Port for up to four Provisioning Servers, which will perform login processing.
Add Click the Add button to add a new Provisioning Server to the file. Up to four Provisioning Servers may be specified for Provisioning Servers.
Edit Highlight an existing Provisioning Server from the list, then click the Edit button to edit this server’s IP settings.
Remove Select an existing Provisioning Server from the list, then click the Remove button to remove this server from the list of available Provisioning Servers.
Move up and move down Select an existing Provisioning Server, and click to move up or down in the list of Provisioning Servers. The order in which the Provisioning Servers appear in the list determines the order in which the Provisioning Servers are accessed should a server fail.
Read servers from database To populate the boot file with the Stream Service IP settings already configured in the database, click the Read Servers from Database button. This clears the list then populates the list with the first four servers found in the database.

Target device IP tab

Field Description
Use DHCP to retrieve target device IP Select this option to retrieve target device IP; default method.
Use static target device IP Selecting this method requires that a primary and secondary DNS and Domain be identified.

Server lookup tab

  • Use DNS: Select this option to use DNS to find the server. The host name displays in the Host name textbox. If this option is selected and the Use DHCP to retrieve Device IP option is selected (under Device IP Configuration settings), your DHCP server needs to provide option 6 (DNS Server).

    Note:

    If using HA, specify up to four Provisioning Servers for the same Host name on your DNS server.

  • Use static IP: Use the static IP address of the Provisioning Server from which to boot from. If you select this option, click Add to enter the following Provisioning Server information, then click OK to exit the dialog: IP Address, Subnet Mask, Gateway, Port (default is 6910).

    Note:

    If using high availability (HA), enter up to four Provisioning Servers. If you are not using HA, only enter one. Use the Move Up and Move Down buttons to sort the Provisioning Servers boot order. The first Provisioning Server listed will be the server that the target device attempts to boot from.

Options tab

Field Description
Verbose mode Select the Verbose Mode option if you want to monitor the boot process on the target device (optional) or view system messages.
Interrupt safe mode Select Interrupt Safe Mode if you are having trouble with your target device failing early in the boot process.
Advanced memory support This setting enables the bootstrap to work with newer Windows OS versions and is enabled by default. Only disable this setting if your target device is hanging or behaving erratically in early boot phase.
Network recovery method This field includes: Restore Network Connections; Selecting this option results in the target device attempting indefinitely to restore it’s connection to the Provisioning Server, Reboot to Hard Drive (a hard drive must exist on the target device); Selecting this option instructs the target device to perform a hardware reset to force a reboot after failing to re-establish communications. The user determines the number of seconds to wait before rebooting. Assuming the network connection cannot be established, PXE will fail and the system will reboot to the local hard drive. The default number of seconds is 50, to be compatible with HA configurations.
Logging polling timeout Enter the time, in milliseconds, between retries when polling for Provisioning Servers. Each server is sent a login request packet in sequence. The first server that responds is used. In non-HA systems, this time-out simply defines how often to retry the single available Provisioning Server with the initial login request. This time-out defines how quickly the round-robin routine will switch from one server to the next in trying to find an active one. The valid range is from 1,000 to 60,000 milliseconds.
Login general timeout Enter the time-out, in milliseconds, for all login associated packets, except the initial login polling time-out. This time-out is generally longer than the polling time-out, because the Provisioning Server needs time to contact all associated servers, some of which may be down and will require retries and time-outs from the server to the other servers to determine if they are online or not. The valid range is from 1,000 to 60,000 milliseconds.

Configuring the bootstrap file

  1. In the Console, select a Provisioning Server within the Servers folder in the tree, then select Configure bootstrap from the Actions pane or the context menu. The Configure Bootstrap dialog appears.

    Select the boot file that was copied to the directory you selected during the Provisioning Server setup. Because the server returns the list of bootstrap files found under Citrix Provisioning Program Data, the server must be active for the Configure Bootstrap menu item to appear.

    Important:

    If a previous version of Citrix Provisioning was installed on this server, you must change the default location from:

    C:\\Program Files\\Citrix\\Citrix Provisioning
    

    to:

    C:\\Documents and Settings\\All Users\\Application Data\\Citrix\\Citrix Provisioning\\Tftpboot
    

    If the default is not changed, the bootstrap file can not be configured from the Console and target devices will fail to boot; receiving a ‘Missing TFTP’ error message.

    If you installed the Console on a separate machine, select the path of the remote Provisioning Server (which has boot services installed).

  2. The Configuration Wizard writes the list of IP addresses to the database for the server. Selecting Read Servers from the Database gets the first IP and Port for the server and populates it into the list. This step should only be performed when the list is blank, or to replace the whole list with new values. These values are set in the Streaming network cards section of the Configuration Wizard’s Network Communications page. Citrix Provisioning uses the first network card selected.

  3. Choose from the following options:

    • Select the Verbose Mode option if you want to monitor the boot process on the target device (optional). This enables system messaging on the target device.
    • Select Interrupt Safe Mode if the target device hangs early in the boot process.
    • Select Advanced Memory Support option to enable the bootstrap to work with newer Windows OS versions (enabled by default). Only disable this setting if your target device is hanging or behaving erratically in early boot phase.
  4. Select from the following Network Recovery Methods:

    • Restore Network Connections - Selecting this option results in the target device attempting, indefinitely, to restore it’s connection to the Provisioning Server.
    • Reboot to Hard Drive - Selecting this option instructs the target device to perform a hardware reset to force a reboot after failing to re-establish communications for a defined number of seconds. The user determines the number of seconds to wait before rebooting. Assuming the network connection can not be established, PXE will fail and the system will reboot to the local hard drive. The default number of seconds is 50. Click the Browse button to search for and select the folder created in Step 1, or enter a full path or UNC name.

    Important:

    If the partition containing the vDisks is formatted as a FAT file system, a message displays a warning that this could result in sub-optimal performance. It is recommended that NTFS be used to format the partition containing the vDisks. Do not change the address in the Port field.

    All boot services (PXE, TFTP) must be on the same NIC (IP). But the Stream Service can be on a different NIC. The Stream Service allows you to bind to multiple IPs (NICs).

  5. Configure the following:

    Login Polling Timeout

    Enter the time, in milliseconds, between retries when polling for servers. Each server is sent a login request packet in sequence. The first server that responds is used. This time-out simply defines how often to retry the single available server with the initial login request. This time-out defines how quickly the round-robin routine will switch from one server to the next, in trying to find an active server. The valid range is from 1,000 to 60,000 milliseconds.

    Login General Timeout

    Enter the time-out, in milliseconds, for all login associated packets, except the initial login polling time-out. The valid range is from 1,000 to 60,000 milliseconds.

  6. Click OK to save your changes.