Table Of Contents
Managing Server Images
Understanding Server Image Management
Understanding Model Servers and Golden Images
Understanding Golden Image Parameters
Understanding Sysprep Requirements for Windows Images
Understanding the Golden Image Repository
Installing the VFrame Host Agent on Model Servers
Installing the VFrame Host Agent on Linux Servers
Installing the VFrame Host Agent on Windows Servers
Working with Server Images
Viewing the Golden Image Repository Setup
Creating a Folder in the Golden Image Repository
Creating a Golden Image
Exporting a Golden Image
Importing a Golden Image
Restarting an Image Management Job
Working with Golden Image Parameters
Creating Sysprep Files
Deleting Items from the Repository
Troubleshooting Server Image Management
Server Image Management Reference
Server Images Tab
Image Repository Tab
Snapshots Tab
Snapshot Status Tab
Export Dialog Box
Import Dialog Box
Input Sysprep Dialog Box
Repository Setup Dialog Box
Managing Server Images
Server golden images are the combination of operating system and application software that you will deploy on application servers when you create service networks. They are the core of your services.
There are two steps to server image management: the creation and management of a repository of golden images, and the actual use of the images. The following topics describe how to create a repository of golden images; for information on using these images, see Designing Service Networks, page 13-1.
•
Understanding Server Image Management
•Installing the VFrame Host Agent on Model Servers
•Working with Server Images
•Troubleshooting Server Image Management
•Server Image Management Reference
Understanding Server Image Management
These sections explain what server golden images are and how you manage them in VFrame:
•Understanding Model Servers and Golden Images
•Understanding Golden Image Parameters
•Understanding Sysprep Requirements for Windows Images
•Understanding the Golden Image Repository
Understanding Model Servers and Golden Images
VFrame's main purpose is to help you create service-based networks. These networks run the specific applications that you need to deploy to your user community. Because applications run on servers, deploying a service network is in part getting the right applications loaded onto the servers in the network.
Golden images are the way that you deploy applications onto the servers in a service network. A golden image is simply a collection of operating system software and applications configured to run on specific server hardware. You need to create golden images for each unique collection of operating system, software application, and server hardware feature set that you will use in each of your service networks.
In general, this is the process you use to create a golden image:
1. Choose a server that you will use as a model server. This server should have the same hardware features as the application servers that you will use in the service network, or they should at least be compatible with them. Otherwise, your application servers might not be able to run the golden image created from the model server, or not run it well. As you replace application servers with servers that have different hardware features, you need to periodically create a new model server to create a new golden image.
2. Install all desired operating system and application software on the model server, and configure it as required. The model server should function exactly as you expect your servers to function.
3. Install the VFrame host agent and start it so that VFrame becomes aware of the model server. For detailed information, see Installing the VFrame Host Agent on Model Servers.
4. Using VFrame, copy the image from the model server into the golden image repository. For detailed information, see Creating a Golden Image.
You can also import golden images that were created by a different VFrame system, or export images that you create. Using export and import, you can share images among VFrame systems, thus standardizing server deployments within your organization. For more information, see Exporting a Golden Image and Importing a Golden Image.
You cannot use golden images that you created using other programs.
Related Topics
•Understanding Golden Image Parameters
•Understanding Sysprep Requirements for Windows Images
•Understanding the Golden Image Repository
•Installing the VFrame Host Agent on Model Servers
•Working with Server Images
Understanding Golden Image Parameters
After you create or import a golden image, you can optionally define parameters for the image. These parameters are variables whose values users can set when they select the image for a server group in a service network.
VFrame does not use golden image parameters for processing. Instead, the parameters are written to a file on the server, and you can write scripts to process the file during server bootup and perform various actions based on the variable settings. The parameters allow you to customize how an image is used by various service networks.
The interface for creating golden image parameters shares the same dialog boxes that are used for creating variables in the global libraries (select Design > Global Libraries). However, you cannot assign variables from the global library to golden images. All variables defined for a golden image are unique to that golden image.
When you select the golden image for a server group using the server group wizard (from the Operations tab), you can configure the specific parameter values for use by servers in the group. In addition, you can also view and change the attributes for individual servers before they are imaged. From the Operations tab, right-click the server and select Properties.
When you create a copy of the golden image for use on a server, the parameters are written to the following files in the replicated image based on operating system. Your scripts must process the file during system boot to use the parameters.
•Linux servers—The parameter file is /opt/cisco_vfdc/parameter_file.
•Windows servers—The parameter file is C:/cisco_vfdc/parameter_file.
Related Topics
•Working with Golden Image Parameters
Understanding Sysprep Requirements for Windows Images
Windows 2003 servers require the use of the System Preparation tool (sysprep.exe) to reliably allow the creation of golden images. This tool is part of the Windows 2003 package from Microsoft, and there might be updates to the tool on the support.microsoft.com web site.
Read the Microsoft documentation for creating sysprep.inf files and for using the sysprep.exe program to prepare a Windows model server for golden image creation. VFrame relies on your proper use of these tools.
After you create a Windows golden image in VFrame, you must add at least one sysprep.inf file to it before you can deploy the image to a server.
Related Topics
•Creating a Golden Image
•Importing a Golden Image
•Creating Sysprep Files
Understanding the Golden Image Repository
When you create or import a golden image, you are creating a file in the VFrame golden image repository. The repository is an area of disk space and can be in these locations:
•Local—On the VFrame Data Center Director.
•SAN or LUN—On a logical unit in a storage array.
•NFS or Volume—On a volume in a NAS filer.
You can determine the location of your repository by clicking View Repository Setup on the Server Images tab (select Tools > Server Images). If you need to migrate the repository to a different location (for example, if you start running out of space), see Migrating the Golden Image Repository, page 18-11.
The repository is organized hierarchically in folders like any other file system, as shown in Figure 8-1.
Figure 8-1 Golden Image Repository Folder Structure
The following are some key things to understand when organizing and using the repository:
•At the top of the hierarchy is a folder named for each virtual context defined in VFrame. You cannot delete this folder. Consider creating golden images for use in that context's service networks in the hierarchy for the context.
•You can create any number of subfolders within a hierarchy to create the logical organization you require.
•Each golden image behaves like a folder in the repository tree, although it represents a file. The nodes under an image can include these items:
–Linux OS Info—Information related to the Linux operating system used in the golden image.
–Windows OS Info—Information related to the Windows operating system used in the golden image.
–Sysprep—A folder that contains sysprep files, which are used only in Windows images.
–Service Network Server Groups—A folder for each server group that has servers that are using the golden image. The folder contains each server that is currently using a copy of the image.
•When you select an item in the repository, properties related to that item appear in the right pane of the Server Images tab.
•You cannot copy golden images from one folder to another folder. If you need to copy an image, you must first export it, then import it into the desired folder.
•You cannot replace a golden image. If you want to update the image, you have to create a new image, reconfigure your service networks to use the new image (if the image is being used), and then delete the old image.
Related Topics
•Understanding Model Servers and Golden Images
•Viewing the Golden Image Repository Setup
•Creating a Folder in the Golden Image Repository
Installing the VFrame Host Agent on Model Servers
You must install the VFrame host agent (VHA), also known as the migration agent, on model servers. This agent collects the model server's properties and contacts VFrame with the information, making it possible for you to create a golden image from the model server. There are different agents depending on the operating system that is running on the server. These topics describe the installation steps:
•Installing the VFrame Host Agent on Linux Servers
•Installing the VFrame Host Agent on Windows Servers
Installing the VFrame Host Agent on Linux Servers
Before you can create a golden image from a model server that is running the Linux operating system, you must install the Linux version of the VFrame host agent.
Before You Begin
•Set up the server (see Setting Up Model Servers, page 3-23).
•Verify that a DHCP range is configured for the subnet or VLAN where the model server is connected, and that VFrame is configured to respond to DHCP requests from the subnet. For more information about setting up DHCP, see Configuring DHCP Relay Agents in Ethernet Switches and Configuring DHCP in VFrame.
•Verify that the model server can be PXE booted.
Procedure
Step 1 Download the agent to the model server:
•From the model server, use a web browser to connect to the VFrame home page. For example, if the DNS name of the VFrame system is vframe.example.com, open the http://vframe.example.com URL. Click the link to download the host agent package, and then click the link for the Linux agent. Download the agent to the server.
•Download the file to another server and then use a file transfer program such as SCP to transfer the file to the model server.
Step 2 From the model server's command line, change directories to the one where you downloaded the agent and install it using this command (if the name of the file you downloaded is different from the one in the example, use your file name):
rpm -i --nodeps vha.i386.rpm
Note To uninstall the agent, use the rpm --erase vha command.
Step 3 Run the agent by entering this command:
vha {VFrame_IP_address | VFrame_host_name}
where you enter one of these:
•VFrame_IP_address is the IP address of VFrame's server communication interface.
•VFrame_host_name is the DNS host name for that IP address.
For example, enter vha 10.100.30.10 if VFrame's IP address is 10.100.30.10.
After the agent runs successfully, VFrame obtains the model server information and displays the model server in the following two locations:
•Resources tab in the Device selector under Model Servers.
•Snapshots tab on the Server Images tab in the Model Servers list.
You can now create a golden image from the server. For more information, see Creating a Golden Image.
Related Topics
•Understanding Model Servers and Golden Images
•Setting Up Application Servers, page 3-20
•Configuring Server Credentials, page 4-14
Installing the VFrame Host Agent on Windows Servers
Before you can create a golden image from a model server that is running the Windows operating system, you must install the Windows version of the VFrame host agent.
Before You Begin
•Set up the server (see Setting Up Model Servers, page 3-23).
•Verify that a DHCP range is configured for the subnet where the model server is connected, and that VFrame is configured to respond to DHCP requests from the subnet. For more information about setting up DHCP, see Configuring DHCP Relay Agents in Ethernet Switches and Configuring DHCP in VFrame.
•Verify that the model server can be PXE booted.
Procedure
Step 1 Download the agent to the model server:
•From the model server, use a web browser to connect to the VFrame home page. For example, if the DNS name of the VFrame system is vframe.example.com, open the http://vframe.example.com URL. Click the link to download the host agent package, and then click the link for the Windows agent. Download the Windows agent (setup.exe) to the server.
•Download the file to another server that has an accessible shared directory and then map that directory to the model server. Copy the file to the model server.
Step 2 Run the setup.exe command. Follow the instructions in the installation wizard to install the agent. On the final page of the wizard, select to run the agent, and then click Finish.
If you do not choose to run the agent, you can start it yourself by selecting Cisco Systems, Inc. > Cisco Virtual Host Agent > Launch GUI Console from the Start menu. You can also uninstall it using the uninstall command in this folder.
Step 3 On the agent's console, enter the IP address of VFrame's server communication interface, and click Run VHA. A command-line window opens and runs the agent.
Note You can also run the agent from the command line. Change directories to the installation directory (C:\VFrame_Cisco_Systems), and run the WinVha.exe VFrame_IP_address command, replacing VFrame_IP_address with the IP address of VFrame's server communication interface.
After the agent runs successfully, VFrame obtains the model server information and displays the model server in the following two locations:
•Resources tab in the Device selector under Model Servers.
•Snapshots tab on the Server Images tab in the Model Servers list.
You can now create a golden image from the server. For more information, see Creating a Golden Image.
Related Topics
•Understanding Model Servers and Golden Images
•Setting Up Application Servers, page 3-20
•Configuring Server Credentials, page 4-14
Working with Server Images
The following topics provide detailed procedures for working with server images:
•Viewing the Golden Image Repository Setup
•Creating a Folder in the Golden Image Repository
•Creating a Golden Image
•Restarting an Image Management Job
•Exporting a Golden Image
•Importing a Golden Image
•Working with Golden Image Parameters
•Creating Sysprep Files
•Deleting Items from the Repository
Viewing the Golden Image Repository Setup
You can view information about the physical storage setup for the golden image repository. This information can help you determine if the repository needs to be moved to a larger storage location, or if you need to start deleting old images.
Procedure
Step 1 Select Tools > Server Images to open the Server Images tab (see Server Images Tab).
Step 2 Click View Repository Setup to open the Repository Setup dialog box. For information on the fields, see Repository Setup Dialog Box.
Related Topics
•Understanding the Golden Image Repository
Creating a Folder in the Golden Image Repository
The golden image repository automatically includes a top-level folder for each VFrame virtual context that exists. To organize your golden images, you can create folders to create a multilevel hierarchy within each of these top-level folders.
Procedure
Step 1 Select Tools > Server Images to open the Server Images tab (see Server Images Tab).
Step 2 Click Image Repository to open the Image Repository tab if it is not already open (see Image Repository Tab).
Step 3 From the Repository selector, select the folder in which you want to create the new folder.
Step 4 Click New Folder to open the New Folder dialog box.
In the New Folder dialog box, enter a name for the folder. The name must be unique within the folder in which you are adding the new folder. The name can include only alphanumeric characters (a-z, A-Z, 0-9) and the underscore (_).
Step 5 Click OK.
Related Topics
•Understanding the Golden Image Repository
•Deleting Items from the Repository
Creating a Golden Image
After you configure a model server with the operating system and application software to create the desired operational environment, you create a golden image from the model server. Later, when you create a service network, you can select the golden image you created as the image VFrame should deploy to the servers in the service network.
Before you Begin
Install and run the VFrame host agent on the model server as described in Installing the VFrame Host Agent on Model Servers.
Procedure
Step 1 Select Tools > Server Images to open the Server Images tab (see Server Images Tab).
Step 2 Click Snapshots to open the Snapshots tab (see Snapshots Tab).
Step 3 Select the model server in the Model Servers list on the left side of the tab.
You can click the Model Server Properties tab in the right pane to view physical details about the selected server. You can use the information about partition and disk size to estimate how large the golden image will be.
Step 4 On the right pane of the Snapshot tab, enter the following information:
•Job Name—Enter a unique name for the snapshot job.
•Image Name—Enter a unique name for the golden image. You cannot include spaces in the name.
The name is initially set to the job name. The name you enter here will be used as the image name in the golden image repository and it will be the name users select when configuring server groups in their service networks. Make sure the name is meaningful.
•Description—(Optional.) Enter a description of the image. A description will help users identify the purpose of the image when viewing it in the golden image repository.
•Target Folder—Select the folder in which you want to create the image. All folders are available in each virtual context, even those that are in folders for another context.
•Snapshot Type—Select the image's physical characteristics. The snapshot type determines what types of storage can be used when setting up a server group in a service network. Your options are:
–Block—For creating an image that will be replicated only on SAN LUNs. These images cannot be replicated on NAS filer volumes. These images can be used for application servers that boot off the SAN.
–File-based—For creating images that will be replicated on NAS filer volumes or SAN LUNs. These images can be used for application servers that boot off either a NAS filer volume or a SAN.
Step 5 Click OK to save your changes and create the job.
To view the status of the job, click Snapshot Status to open the Snapshot Status tab (see Snapshot Status Tab). Select the job in the upper pane, and you can see the job messages in the bottom pane. The most recent message should indicate that you need to PXE boot the model server to continue the snapshot job.
Step 6 (Windows only) Log into the Windows model server and do the following:
a. Create a folder named C:\sysprep. Ensure that the folder name is all lower-case letters.
a. Run the System Preparation (sysprep.exe) program. Select the Reboot option, then the Reseal option. See the Microsoft System Preparation Tool documentation for detailed information on using the program.
Step 7 PXE boot the model server. You might need to manually invoke PXE boot during the boot process based on how the server is configured.
After the server boots up, the following occurs:
•VFrame responds to the server's PXE boot message and provides the model server an IP address from one of the DHCP IP address ranges you defined.
•The inventory operating system (OS) is loaded on the model server.
•VFrame copies the contents of the model server to the golden image repository with the help of the inventory OS. The time required to complete the copy is related to the size of the image. You can track the process by watching the log messages for the job.
Step 8 After completing the golden image creation process, VFrame tries to reboot the model server by sending a message to the inventory OS and by resetting the power using the LOM interface. If VFrame cannot find appropriate LOM credentials for the server in the device credentials list (see Configuring Server Credentials, page 4-14), the server might not reboot. You should reboot the server manually to release the IP address VFrame leased to the server.
Step 9 (Optional) When the snapshot job is finished, click Image Repository to open the Image Repository tab (see Image Repository Tab). Find the image in the folder you selected, and verify the image's properties are what you expected them to be.
Step 10 If the image is for the Windows operating system, you must create at least one sysprep file. For information on how to create a sysprep file, see Creating Sysprep Files.
Step 11 (Optional) You can define special parameters for a golden image. If you write a program to process the parameters, you can customize the deployment of a golden image when it is used by a server. For information on how to create and use these parameters, see Working with Golden Image Parameters.
Tips
•If you want to stop the golden image creation process, select the job on the Snapshot Status tab and click Stop.
Related Topics
•Understanding Model Servers and Golden Images
•Restarting an Image Management Job
•Deleting Items from the Repository
Exporting a Golden Image
You can export any golden images from the golden image repository to another server. You can then import these exported images into another VFrame system, or import them back into your VFrame system (for example, into another folder). Exporting images allows you to share images among VFrame systems, standardizing your golden images.
Procedure
Step 1 Select Tools > Server Images to open the Server Images tab (see Server Images Tab).
Step 2 Click Image Repository to open the Image Repository tab if it is not already open (see Image Repository Tab).
Step 3 In the Repository selector, select the golden image to export.
Step 4 Click Export to open the Import dialog box (see Export Dialog Box).
Step 5 In the Export dialog box, fill in at least this information:
•Protocol Connection—Select the protocol you want to use for exporting the image. You can select scp or sftp. The server to which you are exporting the image must support the selected protocol.
•Export To—Enter the name and location for the exported image:
–Server—The name or IP address of the server to which you are exporting the image.
–Directory—The full directory path for the exported image.
–Archive—The base name of the golden image you are creating. The image will include one or more compressed files, and VFrame will add a numbered suffix to each file, such as _000, _001, and so on. For example, if you enter LinuxImage, the resulting export file might be named LinuxImage_000.
•Log In—Enter a username and password that can log into the server to which you are exporting the file.
Step 6 Click OK in the Export dialog box.
The Snapshot Status tab is opened (see Snapshot Status Tab). You can select the export job and view its status messages. Because golden images are typically large files, it will take some time to complete the export.
Tips
•If you want to stop the golden image export process, select the job on the Snapshot Status tab and click Stop.
•If you are exporting a Windows golden image, be aware that the sysprep files are not included in the export process. You might want to select each sysprep file defined for the image, select the contents of the file, and copy and paste it into a text file. You can use the text files to redefine the sysprep files when you import the image.
Related Topics
•Understanding Model Servers and Golden Images
•Understanding the Golden Image Repository
•Creating a Golden Image
Importing a Golden Image
If you export a golden image from a VFrame system (either this system or another system), you can import it into the golden image repository. Importing images from other systems allows you to share golden images among VFrame systems. You can also use import to move an image from one folder to another in the same repository (you must first export the image).
Procedure
Step 1 Select Tools > Server Images to open the Server Images tab (see Server Images Tab).
Step 2 Click Image Repository to open the Image Repository tab if it is not already open (see Image Repository Tab).
Step 3 In the Repository selector, select the folder into which you want to import the golden image.
Create a new folder if you want to import the image into a new location (for information on creating folders, see Creating a Folder in the Golden Image Repository).
Step 4 Click Import to open the Import dialog box (see Import Dialog Box).
Step 5 In the Import dialog box, fill in at least this information:
•Protocol Connection—Select the protocol you want to use for importing the image. You can select scp or sftp. The server that hosts the image you are importing must support the selected protocol.
•Import From—Enter the name and location of the image you are importing:
–Server—The name or IP address of the server.
–Directory—The full directory path to the image.
–Archive—The base name of the golden image. If the name includes a numbered suffix (such as _000, _001, and so on), do not include the suffix. For example, if the image is named LinuxImage_000, enter LinuxImage.
•Import To—Enter the name you want to use for the golden image in the repository.
•Log In—Enter a username and password that can log into the server that is hosting the image you are importing.
Step 6 Click OK in the Import dialog box.
The Snapshot Status tab is opened (see Snapshot Status Tab). You can select the import job and view its status messages. Because golden images are typically large files, it will take some time to complete the import. When the job is finished, it will appear on the Image Repository tab in the folder you selected.
Step 7 If the image is for the Windows operating system, it must have at least one sysprep file. Imported images do not include sysprep files. For information on how to create a sysprep file, see Creating Sysprep Files.
Step 8 (Optional) You can define special parameters for a golden image. If you write a program to process the parameters, you can customize the deployment of a golden image when it is used by a server. For information on how to create and use these parameters, see Working with Golden Image Parameters.
Tips
•If you want to stop the golden image import process, select the job on the Snapshot Status tab and click Stop.
Related Topics
•Understanding Model Servers and Golden Images
•Understanding the Golden Image Repository
Restarting an Image Management Job
You can restart jobs you created for creating a golden image, importing one, or exporting one. You can restart these jobs, whether they have succeeded or failed, to create new images or replace existing images.
For information on creating the initial jobs, see these topics:
•Creating a Golden Image
•Exporting a Golden Image
•Importing a Golden Image
Procedure
Step 1 Select Tools > Server Images to open the Server Images tab (see Server Images Tab).
Step 2 Click Snapshot Status to open the Snapshot Status tab (see Snapshot Status Tab).
Step 3 Select the snapshot, export, or import job you want to restart from the upper pane and click Restart to open the Server Images dialog box.
Step 4 The appropriate dialog box opens with the same settings that were used when the job was first run. You can keep these settings, or you can make any changes you require. See these topics based on the type of job:
•For snapshot jobs, see Snapshots Tab.
•For export jobs, see Export Dialog Box.
•For import jobs, see Import Dialog Box.
Step 5 Click OK on the dialog box.
VFrame creates a new job. For snapshot jobs, you must follow the same process described in Creating a Golden Image, to PXE boot the server and complete the golden image creation process.
Related Topics
•Understanding Model Servers and Golden Images
Working with Golden Image Parameters
You can create and edit parameters associated with a golden image. The parameters are variables that you process with your own scripts to customize a server that uses the golden image. Your script should process the parameters during server boot.
For a more detailed explanation of golden image parameters and the purpose they serve, see Understanding Golden Image Parameters.
You cannot add, edit, or delete variables or variable groups for a golden image if the golden image is assigned to a server group in a service network.
Before You Begin
You must have a good understanding of what you want to accomplish with your script. After planning out your script, you should have a list of the types of variables you need.
You also need to understand how to create variables and variable groups, as described in Managing Variable Group Types from Global Libraries, page 12-1. However, keep in mind that you cannot assign variables from the global library to a golden image. All golden image parameters are unique to each golden image.
Procedure
Step 1 Select Tools > Server Images to open the Server Images tab (see Server Images Tab).
Step 2 Click Image Repository to open the Image Repository tab if it is not already open (see Image Repository Tab).
Step 3 From the Repository selector, select the image whose parameters you want to modify.
Step 4 Click Golden Image in the right pane to open the Golden Image tab.
Step 5 To add a variable group:
a. In the Golden Image Parameters group, select the Golden Image Variables folder and click New to open the Variable Group dialog box (see Variable Group Dialog Box, page 12-8).
b. Enter a name and optionally a description for the variable group.
c. Select Multivalued if you want to allow multiple values for each variable in the group.
d. Click OK. The variable group is added to the parameters list.
e. Click Save on the Golden Image tab to save your changes.
Step 6 To add a variable:
a. Select the variable group in which you want to define the variable and click New to open the Variable dialog box (see Variable Dialog Box, page 12-11).
b. Enter a variable name and optionally a description.
c. Select the appropriate variable type.
d. Select Advanced Settings to view and optionally select additional variable characteristics. For example, you can make the parameter optional, set default values, restrict values, and so forth. The variable type determines which settings are available. When you select an advanced option, the dialog box might expand to display additional fields related to your selection.
e. Click OK when your selections are complete. The variable is added to the group.
f. Click Save on the Golden Image tab to save your changes.
Step 7 To modify an existing variable group, select the group and click Edit. You can change the group name, description, and whether the group allows multiple values for its variables. Click Save on the Golden Image tab to save your changes.
Step 8 To modify an existing variable, select it and click Edit. You can modify all variable attributes. Click Save on the Golden Image tab to save your changes.
Step 9 To delete a variable group or a variable, select it and click Delete. Click Save on the Golden Image tab to save your changes.
Related Topics
•Understanding Model Servers and Golden Images
•Understanding Golden Image Parameters
•Understanding Sysprep Requirements for Windows Images
•Creating a Golden Image
•Importing a Golden Image
Creating Sysprep Files
Before you can use a Windows golden image, you must attach at least one sysprep.inf file to the golden image. The best way to create syspref.inf files is to use the Microsoft System Preparation tool (sysprep.exe) as instructed in Microsoft's documentation. Use the Sysprep Answer File option during the System Setup wizard to generate the file.
Explaining the contents and creation of sysprep.inf files is outside the scope of the VFrame documentation. See the Microsoft System Preparation Tool documentation for complete information. The following procedure explains how to get the file you created into the VFrame system to create a deployable Windows golden image.
Before You Begin
Use Microsoft's System Preparation tool to create the sysprep.inf file for the model server.
If you log into VFrame from the model server, you can upload the file directly. Otherwise, copy the sysprep.inf file to the workstation you are using to run VFrame.
Procedure
Step 1 Select Tools > Server Images to open the Server Images tab (see Server Images Tab).
Step 2 Click Image Repository to open the Image Repository tab if it is not already open (see Image Repository Tab).
Step 3 From the Repository selector, select the Sysprep folder in the Windows golden image to which you are adding a sysprep file.
Step 4 Click Input Sysprep to open the Input Sysprep dialog box (see Input Sysprep Dialog Box).
Step 5 Create the sysprep file:
a. Enter a name and optionally a description for this sysprep configuration. The name is used in the repository and is also the name users will select when configuring server groups during service network design.
b. Enter the file name for the sysprep file. Typically the name is sysprep.inf. This is the file name that will be used when creating the file on the Windows server.
c. Create the contents of the sysprep file in the Sysprep Template edit box. The easiest way to do this is to click Open and select the sysprep.inf file you created using Microsoft's tools. You can edit the contents of the file you upload.
To create variables in the sysprep file, which users can configure during server group configuration, enclose the desired variable name in two sets of brackets. For example, the following line creates the variable named system_host_name and assigns it to the ComputerName attribute:
ComputerName = [[system_host_name]]
d. Click Validate to verify that your variables are correctly constructed.
e. Click OK when you are satisfied with the contents of the sysprep file. VFrame adds the sysprep file to the repository, assigning it to the selected Windows golden image.
Related Topics
•Understanding Sysprep Requirements for Windows Images
•Creating a Golden Image
•Importing a Golden Image
Deleting Items from the Repository
You can delete any of these items from the golden image repository, with certain restrictions:
•Folders—You cannot delete a folder that contains a golden image that is in use.
•Golden images—You cannot delete a golden image that is configured for a server group, even if the image is not deployed on a server.
•Sysprep files—You cannot delete a sysprep file that is being used by a server group.
Procedure
Step 1 Select Tools > Server Images to open the Server Images tab (see Server Images Tab).
Step 2 Click Image Repository to open the Image Repository tab if it is not already open (see Image Repository Tab).
Step 3 From the Repository selector, select the folder, golden image, or sysprep file to delete.
Step 4 Click Delete. You are asked to confirm that you want to delete the item. If you click Yes, VFrame creates a job to delete the item, and if the job completes successfully, it is deleted.
Step 5 To view the status of the job, and its log messages, click Snapshot Status and select the deletion job in the jobs list. The log messages appear in the Job Logs in the lower pane.
Related Topics
•Understanding Model Servers and Golden Images
•Creating a Folder in the Golden Image Repository
•Creating a Golden Image
•Creating Sysprep Files
Troubleshooting Server Image Management
These are some problems you might encounter with creating and managing golden images and their solutions:
•You reimaged a model server but VFrame does not recognize the changes.
•An imported Windows golden image did not include sysprep files.
Problem You reimaged a model server but VFrame does not recognize the changes.
Solution You can reuse model servers to create images for different software setups. However, VFrame might not be able to recognize drastic changes such as changing the operating system from Linux to Windows. To work around the problem, delete the model server from VFrame's interface, then restart the VFrame host agent on the model server. VFrame will rediscover the model server with its current configuration and you can proceed to create a golden image.
Problem An imported Windows golden image did not include sysprep files.
Solution When you export a Windows golden image, the sysprep files are not exported with it. When you import the image into another VFrame system, you must recreate the sysprep files for the image.
Server Image Management Reference
These topics describe the main tabs and dialog boxes you use when managing server images:
•Server Images Tab
•Image Repository Tab
•Snapshots Tab
•Snapshot Status Tab
•Export Dialog Box
•Import Dialog Box
•Input Sysprep Dialog Box
•Repository Setup Dialog Box
Server Images Tab
Use the Server Images tab to manage the golden image repository and to create golden images.
How to Get to This Tab
Select Tools > Server Images to open the Server Images tab.
Related Topics
•Understanding Server Image Management
•Working with Server Images
•Troubleshooting Server Image Management
Field Reference
Table 8-1 Server Images Tab
Element
|
Description
|
Buttons
|
The buttons at the top of the page apply to the Image Repository tab only. For information on the buttons, see Image Repository Tab.
|
Image Repository tab
|
The golden image repository and the golden images contained in it. Use this tab to view the properties for various items in the repository, to import and export images, and to create and modify golden image parameters and sysprep files for Windows images.
For more information about using this tab, see Image Repository Tab.
|
Snapshots tab
|
The model servers available for creating golden images. Use this tab to create new golden images from your model servers.
For more information about using this tab, see Snapshots Tab.
|
Snapshot Status tab
|
The server image management jobs. Use this tab to view job status and to look at the logs for image management jobs.
For more information about using this tab, see Snapshot Status Tab.
|
Image Repository Tab
Use the Image Repository tab to manage the golden image repository. You can view properties of existing golden images, including the servers that are using the images. You can also create and delete folders and import, export, or delete images.
How to Get to This Tab
Select Tools > Server Images to open the Server Images Tab and click the Image Repository tab if it is not already open.
Related Topics
•Understanding Model Servers and Golden Images
•Understanding the Golden Image Repository
•Viewing the Golden Image Repository Setup
•Creating a Folder in the Golden Image Repository
•Exporting a Golden Image
•Importing a Golden Image
•Working with Golden Image Parameters
•Creating Sysprep Files
•Deleting Items from the Repository
Field Reference
Table 8-2 Image Repository Tab
Element
|
Description
|
New Folder button
|
Click this button to create a new folder in the selected folder. The New Folder dialog box opens so that you can name the folder and enter a description for it. You must select a folder that can contain golden images to make this button active.
The folder name must be unique within the folder in which you are adding the new folder. The name can include only alphanumeric characters (a-z, A-Z, 0-9) and the underscore (_).
|
Import button
|
Click this button to import a golden image into the selected folder. The Import dialog box opens so that you can identify the image you are importing (see Import Dialog Box). You must select a folder that can contain golden images to make this button active.
|
Export button
|
Click this button to export the selected golden image. The Export dialog box opens so that you can identify the location to which to export the image (see Export Dialog Box). You must select a folder that can contain golden images to make this button active.
|
Delete button
|
Click this button to delete the selected folder, golden image, or sysprep file. You must select an item that can be deleted to make this button active.
|
Input Sysprep button
|
Click this button to create a new sysprep file, which is used with Windows server images. The Input Sysprep dialog box opens so that you can create the file (see Input Sysprep Dialog Box). This button does not appear unless you select the Sysprep folder that appears in a Windows golden image.
|
View Repository Setup button
|
Click this button to open the Repository Setup dialog box where you can see details about the golden image repository (see Repository Setup Dialog Box).
|
Repository
The golden image repository contains all of the golden images that you can use on servers operating in service networks. The repository is organized in a hierarchical folder structure, and the selector is organized in the same way the data is organized on the storage device.
The top level of the folder structure is a folder for each VFrame virtual context. Service network designers are not prevented from using golden images contained within the folder structure of another virtual context than the one they are working in.
When you select an item in the repository, properties associated with the item are displayed in the right pane. The following information describes the property tabs and the items that are associated with them.
|
Folder Properties tab
|
Applies to:
Repository folders, Sysprep folders.
Properties:
Displays the file name and description, if any.
|
Server Images tab
|
Applies to:
Repository folders, Sysprep folders, golden images.
Properties:
Lists the servers that are using golden images or sysprep files contained in the selected folder. If you select a golden image, the tab lists servers only for that image.
The following information is displayed for each server:
•Virtual Context Name—The name of the virtual context that contains the service network that is using the golden image.
•Logical Server Name—The name of the server in the service network that is using the golden image.
•Logical Server State—The state of the server.
•Logical Server Group Name—The server group in the service network that is using the golden image.
|
Golden Image tab
|
Applies to:
Golden images.
Properties:
Lists the properties of the golden image, and lets you add parameters to customize the image. The properties are divided into these sections:
•Golden Image—The name, description (which you can change), and snapshot type.
•Golden Image Details—The complete storage path for the image in the golden image repository. You cannot change this information.
•Golden Image Parameters—The parameters defined for the image. You can add parameters, or modify or delete existing parameters. For detailed information on creating and using these parameters, see Working with Golden Image Parameters. Note that you cannot modify the parameters if the image is being used by a server.
•Save button—Click this button to save any changes you make on this tab.
|
Linux Properties (unnamed tab)
|
Applies to:
Linux OS Info nodes that appear in a Linux golden image.
Properties:
Lists the properties of the Linux operating system, the model server from which the image was created, and the defined partitions.
|
Windows Properties (unnamed tab)
|
Applies to:
Windows OS Info nodes that appear in a Windows golden image.
Properties:
Lists the properties of the Windows operating system, the model server from which the image was created, and the characteristics of the drives defined in the image.
|
Sysprep Properties (unnamed tab)
|
Applies to:
Sysprep files in a Windows golden image.
Properties:
Lists the properties and contents of the sysprep file, and lets you edit the sysprep file. These are the properties:
•Name—The name of the sysprep file as it exists in the repository. You can change this name.
•Description—The description of the sysprep file. You can change the description.
•Sysprep Filename—The name of the file as it will exist on the Windows server (which you cannot change), and its contents (which you can edit). For detailed information about sysprep files, see Input Sysprep Dialog Box.
•Save button—Click this button to save any changes you make on this tab.
•Sysprep Variables—A display-only list of the variables defined in the sysprep file. Edit the sysprep file contents to make changes to this list. Use this list to verify that your variable definitions in the sysprep file are grammatically correct. To create a variable in the sysprep file, enclose a text string in two sets of brackets, for example, [[system_host_name]] creates a variable named system_host_name.
|
Server Group properties (unnamed tab)
|
Applies to:
Server group nodes that appear under a golden image if the image is being used by a server group in a service network. The server group node is the name of the server group.
Properties:
Lists the properties of the server group, including the name of the service network in which it is defined, and the number of servers it contains.
|
Logical Server properties
(unnamed tab)
|
Applies to:
Logical server nodes that appear in a server group node under a golden image if the image is being used by a server group in a service network. The logical server node is the name of the server.
Properties:
Lists the properties of the server, including the name of the virtual context in which the service network is running, and the status of the server.
|
Snapshots Tab
Use the Snapshots tab to create a golden image and to see the properties of the model servers.
How to Get to This Tab
Select Tools > Server Images to open the Server Images Tab and click the Snapshots tab.
Related Topics
•Understanding Model Servers and Golden Images
•Installing the VFrame Host Agent on Model Servers
•Creating a Golden Image
Field Reference
Table 8-3 Snapshots Tab
Element
|
Description
|
Model Servers selector
|
Lists the model servers that you can use when creating golden images. Select a server from one of these lists:
•Linux—All model servers that are running the Linux operating system.
•Windows—All model servers that are running the Windows operating system.
|
Create Snapshot tab
|
The golden image creation job attributes. You must configure a DHCP IP address range before creating a golden image.
Select a model server before filling in these attributes to create a golden image from the server:
•Job Name—A name for the snapshot job. Enter a name that will help you find the job on the Snapshot Status job list.
•Image Name—The filename for the image, which determines the name used in the golden image repository. Initially, the job name is entered as the image name when you specify the job name. You can change the image name. Do not include spaces in the name.
•Description—(Optional) A description for the image.
•Target Folder—The golden image repository folder in which to save the golden image. Select an existing repository folder. If you want to save the image in a folder that does not exist, create the folder on the Image Repository tab and then select it in this field.
•Snapshot Type—The method used for copying image data, either based on blocks or files:
–Block—Images can be replicated in LUNs only.
–File Based—Images can be replicated in LUNs or NAS filer volumes.
•OK button—Click this button to start the snapshot golden image job. To view the job's status, click the Snapshot Status tab. After creating the job, you must PXE boot the model server to finish the job.
•Clear button—Click this button to clear all attribute fields.
|
Model Server Properties tab
|
Details about the model server, such as the type of server, model number, serial number, the state of the model server (snapshot creation failed or succeeded), memory size, MAC address, CPU, and so on. You can use the information about partition and disk size to estimate how large the golden image will be.
|
Snapshot Status Tab
Use the Snapshot Status tab to see the status of server image management jobs.
How to Get to This Tab
Select Tools > Server Images to open the Server Images Tab and click the Snapshot Status tab.
Related Topics
•Creating a Golden Image
•Restarting an Image Management Job
•Exporting a Golden Image
•Importing a Golden Image
Field Reference
Table 8-4 Snapshot Status Page
Element
|
Description
|
Jobs list (upper pane)
The jobs list includes all server management jobs, such as snapshot golden image, import, and export. If you select a job in this list, the log for the job appears in the lower pane.
|
Restart button
|
Click this button to restart the selected snapshot job if the job is completed. A dialog box with the job details is opened. You can change the job characteristics before rerunning the job.
|
Stop button
|
Click this button to stop the selected snapshot job if the job is currently in progress.
|
Filter button
If a filter is applied to the list, the button name is shown as:
Filter... (filtered)
|
Click this button to create a filter so that the list shows only the jobs that you want to see. The Filter dialog box is opened, and you can use these fields to set a filter:
•Job Type—The type of job you want to see, related to the action performed by the job, arranged hierarchically in folders. Select a folder to select all job types in the folder. If you want to select only one or two job types, first deselect All, then make your selections.
•Status—The job status. For example, you can elect to view jobs that are currently running.
•Time Range—Whether to view all jobs no matter when they ran (All), or to view jobs that ran on specific dates within specific times.
•Max Results—The maximum number of results you want to see. For past jobs, the most recent ones are selected over older jobs.
•Apply button—Click this button to apply your filter to the list without closing the Filter dialog box. Click OK to apply the filter and close the dialog box.
•Reset—Click this button to reset all filter values to their defaults (which is to view all jobs without date and time restrictions).
|
Show All button
|
Click this button to display all jobs, removing any filter that is currently set. To reapply the filter, click Filter to open the Filter dialog box (which retains the previous filter values), and click OK.
|
Name
|
The name of the image management job.
|
Type
|
The type of job. Jobs are created for taking a snapshot of a golden image (creating a golden image), exporting one, importing one, or deleting either an image or a repository folder.
|
Status
|
The status of the job, for example, Success or Failed.
|
Start Time
|
The date and time the job started.
|
Percent Complete
|
How much of the job has finished.
|
Duration
|
The amount of time the job took to finish.
|
Job Logs (lower pane)
The log shows the messages for the job you select in the upper pane. To change the sorting order of the messages, click on the column title on which you want to sort.
|
Job Log Filters
|
Use the filter to reduce the size of the list and show only those messages you want to see. Filter elements include:
•Severity—The severity level of the message.
|
Time
|
The date and time the message was logged.
|
Severity
|
The severity level of the message.
|
Entry
|
The job log message received from the server.
|
Export Dialog Box
Use the Export dialog box to export a golden image from the golden image repository to another server. You can then import that image into another VFrame system.
How to Get to This Tab
Select Tools > Server Images and select the Image Repository tab. From the Repository selector, select the golden image you want to export and click Export.
Related Topics
•Server Images Tab
•Exporting a Golden Image
•Restarting an Image Management Job
•Understanding Model Servers and Golden Images
•Understanding the Golden Image Repository
Field Reference
Table 8-5 Export Dialog Box
Element
|
Description
|
Job Information
|
Information about the job.
•Job Name—A name for export job. You can replace the system generated name with a name that will make it easier for you find the job in on the Snapshot Status tab's job list.
•Description—(Optional) A description for the job.
|
Protocol Connection
|
The protocol you want to use for exporting the image. The server to which you are exporting the must support the protocol you select. You can choose SCP or SFTP.
|
Export From
|
The folder and name of the golden image you selected for export. If this is not the image you wanted to export, click Cancel and select the right image.
|
Export To
|
The location to which you are exporting the image:
•Server—The name or IP address of the server.
•Directory—The directory where you want to create the image. Include the full path, for example, /GoldenImages/Linux.
•Archive Name—The name you want to use for the exported golden image. VFrame uses the name as the base name of the file, and appends a numeric suffix, such as _000, _001 and so on. For example, if you specify LinuxImage as the archive name, the export file might be named LinuxImage_000. The exported golden image will consist of one or more compressed files.
•Options—Any command options to include for the selected protocol.
|
Login
|
The credentials required to log into the server to which you are exporting the image:
•Username—A username that can log into the server.
•Password—The password for that username.
|
Import Dialog Box
Use the Import dialog box to import a golden image into the golden image repository.
How to Get to This Tab
Select Tools > Server Images, and select the Image Repository tab. From the Repository selector, select the folder into which you want to import the golden image, then click Import.
Related Topics
•Server Images Tab
•Importing a Golden Image
•Restarting an Image Management Job
•Understanding Model Servers and Golden Images
•Understanding the Golden Image Repository
Field Reference
Table 8-6 Import Dialog Box
Element
|
Description
|
Job Information
|
Information about the job.
•Job Name—A name for import job. You can replace the system generated name with a name that will make it easier for you find the job in on the Snapshot Status tab's job list.
•Description—(Optional) A description for the job.
|
Protocol Connection
|
The protocol you want to use for importing the image. The server on which the image resides must support the protocol you select. You can choose SCP or SFTP.
|
Import From
|
The location of the image you are importing:
•Server—The name or IP address of the server.
•Directory—The directory that contains the golden image. Include the full path, for example, /GoldenImages/Linux.
•Archive Name—The name of the golden image. If the name has numbered suffixes (such as _000, _001 and so on), do not include the suffix. For example, if the golden image you are importing is named LinuxImage_000, the archive name is LinuxImage.
•Options—Any command options to include for the selected protocol.
|
Import To
|
The location in the golden image repository to which you are importing the image.
•Folder—Displays the folder that you selected in the repository. To import into a different folder, click Cancel and select the right folder.
•Image—The name for the image. The name you select must be unique in the entire golden image repository, not just in the folder you select.
|
Login
|
The credentials required to log into the server that contains the image you are importing.
•Username—A username that can log into the server.
•Password—The password for that username.
|
Input Sysprep Dialog Box
Use the Input Sysprep dialog box to add a sysprep file to a Windows image. You must add at least one sysprep file to a Windows image to make it deployable to servers.
How to Get to This Dialog Box
Select Tools > Server Images, click the Image Repository tab, select the Sysprep folder in a Windows golden image, and click Input Sysprep.
Related Topics
•Understanding Sysprep Requirements for Windows Images
•Creating a Golden Image
•Importing a Golden Image
•Creating Sysprep Files
Field Reference
Table 8-7 Input Sysprep Dialog Box
Element
|
Description
|
Name
|
The name of the sysprep settings as it will appear in the VFrame interface. This is used as the name displayed in the repository selector, and is also the name users will select when configuring a server group during service network design.
|
Description
|
The description of the purpose of the sysprep file.
|
File name
|
The name of the sysprep file, normally sysprep.inf. This is the name of the file that will be installed on the Windows server.
|
Sysprep Template
The contents of the sysprep file. You can upload a file from your system, type in the contents of the sysprep file, or do a combination of both.
You can include variables in the sysprep file, and users can set the variables when selecting the sysprep file during server group configuration when designing a service network. To create a variable, enclose a text string in two sets of brackets. For example, this text creates a variable named system_host_name and assigns it to the ComputerName attribute:
ComputerName = [[system_host_name]]
|
Open button
|
Click this button to select a sysprep file from your workstation. To select the sysprep.inf file from a Windows model server, either start VFrame from the model server, or copy the model server's sysprep file to your workstation.
|
Validate button
|
Click this button to validate the variables in the sysprep file contents. VFrame determines if the variables you defined are properly delimited with matching two matching sets of brackets.
|
Save button
|
Click this button to save the sysprep file to your workstation.
|
Clear button
|
Click this button to remove all text from the input area.
|
Input Area
(unlabeled edit box)
|
The contents of the sysprep file.
|
Repository Setup Dialog Box
Use the Repository Setup dialog box to see details about the golden image repository physical storage.
How to Get to This Dialog Box
Select Tools > Server Images and click View Repository Setup.
Related Topics
•Viewing the Golden Image Repository Setup
•Understanding the Golden Image Repository
•Server Images Tab
Field Reference
Table 8-8 Repository Setup Dialog Box
Element
|
Description
|
Type
|
The type of storage on which the repository resides: local, SAN, or NAS filer.
|
Total Size (MB)
|
The total size of the repository.
|
Used Size (MB)
|
The amount of storage used by golden images.
|
Total Inodes
|
The total number of Inodes in the repository.
An Inode is an operating system data structure that holds information about a file. Each file within a file system has at least one or possibly more Inodes. The repository has a limited number of Inodes based on the physical size of the storage device and the type of file system. (For NAS filers, you can specify the Inode size for each volume, although you cannot do this from within VFrame).
|
Used Inodes
|
The number of Inodes that are being used.
If you are using NAS filers for the repository, and you need to migrate the repository to a new filer, you can use the used and total Inode counts to help you determine an appropriate number of Inodes to allocate to the target NAS filer volume.
|
Description
|
The description of the golden image repository. For example, the NAS filer IP address and volume name.
|
