Sun N1 Service Provisioning System User's Guide for OS Provisioning Plug-In 3.0

Creating Windows Images and Profiles

A provisioning profile identifies the OS files to use and includes additional information about how those files are to be deployed.

ProcedureHow to Set Up a Windows Image on the Windows RIS Server

Steps
  1. Copy the Windows distribution from a CD or Network Share to the RIS server CIFS.

    Use the RiSetup.exe utility. Select the Keep old existing OSC files option when you create the RIS image.


    Note –

    Do not use MSDN Combo CDs to create a RIS Image. You will get an error message that was described in the Microsoft Knowledge Base Article #300556.To resolve this issue, please use a retail version of the OS image being created.


    If you are using a Windows distribution with integrated Service Packs, follow the instructions in the following sitesto create your RIS image.

    • Download Windows 2000 Service Pack 3

      Download the appropriate service pack from this site. Select the Windows 2000 SP3 Network Installation Windows 2000 SP3 Network Installation download. Similar download pages are available for other Windows OS versions at this site.

  2. Add the required drivers to the RIS image created in the previous step.

    Be sure to include all the drivers, such as those for the network adapter, SCSI hard drives, video, and modem.

    For more information about adding drivers to RIS images, see Microsoft Knowledge Base Article 315279, Microsoft Knowledge Base Article 246184, and Microsoft Knowledge Base Article 254078.


    Note –

    Create the distribution folder accordingly.


    See the sample setup files and drivers in the SampleSIFFiles and SampleDrivers folders for more details.

  3. (Optional) Copy N1 SPS Remote Agent binary to the folder product-directory/$OEM$/$1/N1OSP/ under the image distribution folder.

    product-directory is the Windows image distribution folder that has "i386" or “amd64” as a subfolder that contains the kernel files.


    Note –

    If this folder layout does not exist, create the layout.


    The script expects the N1OSP folder to be part of the image. Copy the tools required for provisioning to this directory path product-directory/$OEM$/$1/N1OSP/. Do not change the N1OSP folder name.

    After you copy the N1 SPS Remote Agent binary to the folder, the directory contents resemble the following example.


    D:\RemoteInstall\Setup\English\Images\WIN2003_TRIAL\$OEM$\$1\N1ISP>dir
         Volume in drive D is Local Disk
         Volume Serial Number is A8D9-4012
    
         Directory of D:\RemoteInstall\Setup\English\Images\WIN2003_TRIAL\$OEM$\$1\N1OSP
    
         02/04/2005	 02:39 PM    <DIR>	    .
         02/04/2005	 02:39 PM    <DIR>	    ..
         01/31/2005	 03:33 PM	 27,595,776 cr_ra_win32_5.2.msi

Creating Custom Windows Provisioning Profiles

You can use the provisioning software to generate a custom Windows provisioning profile for your deployments. The OS Provisioning Plug-In can generate all the necessary variables and plans to provision the Windows OS to your target hosts.

If you want to manually create a Windows provisioning profile, see How to Configure the Setup Information for the Windows Image.

ProcedureHow to Create a Custom Windows Provisioning Profile (Browser Interface)

This procedure describes how to use the OS Provisioning browser interface to generate a custom Windows provisioning profile.

Before You Begin

Make sure the Windows image server exists and that the Windows OS software is available to that server. For more information about creating the Windows image server, see Setting Up the Windows Server.

Steps
  1. In the Common Tasks section of the provisioning software page, select OS Provisioning.

  2. On the OS Provisioning Common Tasks page, click Create Profile in the Windows Images section.

  3. On the Plans Details page, click Run.

  4. Choose variables to use for this plan.

    • To use an existing variables set, select a name from the drop-down menu in the WindowsImage component row of the Plan Parameters table.

    • To create a new variables set, click Select from List in the WindowsImage component row of the Plan Parameters table.

      1. Click Create Set.

      2. Type a name for the variables set.

      3. Verify variables and change them, if needed.

        If you need more information than is provided in the prompts in the component variables table, see the detailed list of components, along with default values and examples, in Windows Provisioning Profile Variables.


        Note –

        For custom-based profiles, you must not specify a value for the sif_file variable.


      4. Save the variables set.

      5. Select the variables set that you just saved from the drop-down menu in the WindowsImage component row of the Plan Parameters table.

  5. On the Plan Details Run page, select the Windows image server on which to attach the image.


    Tip –

    The host name of the Windows image server ends in -windows.


  6. If needed, change the Profile Name.

  7. If needed, change the Profile Description.

  8. Verify that the checkbox for the Create the Custom Profile option is selected.

  9. Click Run Plan (includes preflight).

  10. To verify that the Windows image is attached to the Windows image server, click Components in the left pane of the N1 SPS browser interface.

    You should see a component of type com.sun.n1osp#Provision that has a description similar to Windows provisioning profile.

  11. Edit the variables for the custom-based Windows provisioning profile.

    You need to edit the component variables for the custom Windows profile to enter values for the following items.

    • OS Provisioning control service

    • Product key

    • User name

    • Organization name

    • Time zone

    • Terminal server properties

    • Language and locale for the target host

    1. In the Common Tasks section of the provisioning software page, select OS Provisioning.

    2. On the OS Provisioning Common Tasks page, click Provision OS in the Windows Images section.

    3. On the Components page, click the profile you previously created in the Components column.

    4. On the Components Details page, click Edit.

    5. On the Component Details Edit page, click the check box next to the variable that you want to edit, then type the value for the variable in the Value for This Component column.

      Edit the values for the following variables.

      osp_profile_control_service

      Specifies whether to call the OSP Control Service, which automates power off, reboot, and power on functions. For Windows provisioning, set the value of this variable to true.

      user_full_name

      Specifies the full name of the user for the target host.

      organization_name

      Specifies the name of the organization of which the target host is a member.

      product_key

      Specifies the product key for the OS distribution.

      timezone

      Specifies the time zone for the target host.

      profile_language

      Specifies the language or locale to install on the target host.

      profile_language_group

      Specifies the language group to install on the target host.

      install_terminal_server

      Specifies that the profile should install a terminal server on the target host.

      terminal_server_allow_connections

      Specifies whether the target host should allow remote connections.

      terminal_server_licensing_mode

      Specifies how the terminal services manages Client Access Licenses.

      terminal_server_permissions_setting

      Enables administrators to choose the security mode for terminal server users.

    6. Click Check In.

Next Steps

To install the Windows OS on your target host, you must modify the BIOS boot settings, then run the provisioning plan. For more information, see Installing the Windows OS on the Target Host.

ProcedureHow to Create a Custom Windows Provisioning Profile (Command Line Interface)

Steps
  1. To create a variable set for the WindowsImage component, type a command similar to the following example:


    # cr_cli -cmd cdb.vs.add -comp NM:/com/sun/n1osp/untyped/WindowsImage \
    -name "windows2003custom" -u admin -p admin -vars \
    "osp_server=masterserver-osp;os_name="WIN2003_trial"version=2003; \
    installPath="2003customprofile"; \
    description=test windows image 2003;min_disk_size=10GB; \
    boot_server_name=biwl;boot_server_subnet_address=10.42.42.0; \
    boot_server_subnet_ip_address=10.42.42.4;\
    boot_srv_active_directory_domain=n1.west.example.com;\
    windows_product_directory=D:\\\\RemoteInstall\\\\Setup\\\\English
    \\\\Images\\\\Win2003_trial"
    

    Note –

    The windows_product_directory should be included all on one line. For display purposes, this entry appears on two separate lines.


    For more information about the variables, see Windows Provisioning Profile Variables.

  2. Create a file named /tmp/windows-profile with the following entries.


    custom
    Windows 2003 EE x86 Profile
    true 

    The entries in this file correspond to the following plan variables.

    • custom specifies the Profile Name.

    • Windows 2003 EE x86 Profile specifies the Profile Description.

    • true specifies that this plan will generate a custom profile.

  3. To run the plan, type a command similar to the following example:


    # cr_cli -cmd pe.p.run -u admin -p admin \
    -PID NM:/com/sun/n1osp/untyped/WindowsImage-create-profile \
    -tar H:NM:risserver-windows -comp - -vs windows2003custom -pto 30 -nto 10 \
    -f /tmp/windows-profile
    

    Note the default N1 SPS user value you specified with the -u option. This user must exist after the OS installation for the N1 SPS Remote Agent software to start on the target host.

Creating Non-Custom Windows Provisioning Profiles

Through the N1 SPS browser or command line interface, you can manually create a Windows Provisioning profile. When you manually create a provisioning profile, you must supply the appropriate variable values to use in your provisioning plans.

If you want the OS Provisioning plug-in to generate a Windows provisioning profile for you, see How to Create a Custom Windows Provisioning Profile (Browser Interface).

To create a non-custom Windows Provisioning Profile, complete the following tasks.

ProcedureHow to Configure the Setup Information for the Windows Image

This procedure describes how to manually configure the setup information for a Windows image. You must complete this procedure if you are creating a non-custom Windows provisioning profile.

Setup information for Windows is stored in a RIS configuration profile. See the sample setup files from SampleSIFFiles folder for more details.

Steps
  1. Edit the configuration profile file for each distribution to set the parameters mentioned in the following steps.

    To edit this file, use the SetupMgr.exe utility. from the Windows Resource Kit CD (deploy.cab file). You can also manually edit the file using the notepad tool.

    For a Windows 2003 image, the default SIF file is on the RIS Server at the following location:


    //Reminst/Setup/English/Images/Windows2003/i386/templates/ristndrd.sif
  2. Verify or add the following configuration parameters to the [data] section in your ristndrd.sif configuration file:

    AutoPartition=1
    UnattendedInstall="Yes"
  3. Verify or add the following configuration parameters to the [Unattended] section in your ristndrd.sif configuration file:

    UnattendMode=FullUnattended
    NtUpgrade=No
    OverwriteOemFilesOnUpgrade=No
    OemPreinstall = Yes
  4. Verify or add the following configuration parameters to the [UserData] section in your ristndrd.sif configuration file:

    FullName = "N1osp SunUser"
    OrgName = "Sun Microsystems"
    ProductKey=XXXXX-XXXXX-XXXXX-XXXXX-XXXXX
             

    Note –

    Replace the FullName and OrgName values with something that is appropriate for your environment.

    While deploying some operating systems, such as Windows 2000 Advanced Server, ProductKey does not work. Instead, use a ProductID variable.


  5. Verify or add the following configuration parameters to the [GuiUnattended] section in your ristndrd.sif configuration file:

    AdminPassword="sun123"
    AutoLogon=Yes
    AutoLogonCount=1
    EncryptedAdminPassword=NO

    Note –

    AutoLogonCount=1 implies that the super-user administrator is automatically logged on to the target host after installation with the default password as sun123 for the very first time. This is required to execute the provision time commands specified in the [GuiRunOnce] section in the SIF file. When the Administrator user attempts to login again, he will be prompted to change the password.


  6. Edit the software information file (sif) to automate download of critical security updates after the installation.

    Add the following lines to the sif file.


    [WindowsFirewall]
    Profiles=WindowsFirewall.TurnOffFirewall
    
    [WindowsFirewall.TurnOffFirewall]
    Mode=0
  7. Verify or add the following sections to your ristndrd.sif configuration file:

    [Branding]
            BrandIEUsingUnattended=Yes
    [Proxy]
            Proxy_Enable=0
            Use_Same_Proxy=0

    Tip –

    The SetupMgr.exe utility generally adds these sections for you.


  8. Add any specific plug and play drivers to the image.

    See the instructions in Microsoft Knowledge Base article #: 315279.

ProcedureHow to Create a Non-Custom Windows Provisioning Profile (Browser Interface)

This procedure describes how to use the OS Provisioning browser interface to manually create your own Windows provisioning profile.

Before You Begin

Make sure the Windows image server exists and that the Windows OS software is available to that server. For more information about creating the Windows image server, see Setting Up the Windows Server and How to Set Up the Windows RIS Server.

Steps
  1. In the Common Tasks section of the provisioning software page, select OS Provisioning.

  2. On the OS Provisioning Common Tasks page, click Create Profile in the Windows Images section.

  3. On the Plans Details page, click Run.

  4. Click Select from List in the WindowsImage component row of the Plan Parameters table.

  5. Click Create Set.

  6. Type a name for the variables set.

  7. Specify the variable values to use with this plan.

    If you need more information than is provided in the prompts in the component variables table, see the detailed list of components, along with default values and examples, in Windows Provisioning Profile Variables.


    Note –

    You must specify a value for the sif_file variable.


  8. Save the variables set.

  9. Select the variables set that you just saved from the drop-down menu in the WindowsImage component row of the Plan Parameters table.

  10. On the Plan Details Run page, select the Windows image server on which to attach the image.


    Tip –

    The host name of the Windows image server ends in -windows.


  11. Type values for the Profile Name and Profile Description plan variables.

  12. Deselect the Create Custom Profile check box.

  13. Click Run Plan (includes preflight).

  14. To verify that the Windows image is attached to the Windows image server, click Components in the left pane of the N1 SPS browser interface.

    You should see a component of type com.sun.n1osp#Provision that has a description similar to Windows provisioning profile.

Next Steps

To install the Windows OS on your target host, you must modify the BIOS boot settings, then run the provisioning plan. For more information, see Installing the Windows OS on the Target Host.

ProcedureHow to Create a Non-Custom Windows Provisioning Profile (Command-Line Interface)

Steps
  1. To create a variable set for the WindowsProfile component, type a command similar to the following example:


    # cr_cli -cmd cdb.vs.add -comp NM:/com/sun/n1osp/untyped/WindowsImage \
    -name "windows2003" -u admin -p admin -vars "osp_server=masterserver-osp;version=2003; \
    os_name="WIN2003_trial";description=test windows image 2003;min_disk_size=10GB; \
    boot_server_name=biw1;boot_server_subnet_address=10.42.42.0; \
    boot_server_subnet_ip_address=10.42.42.4;boot_srv_active_directory_domain=n1isp.sfbay.sun.com; \
    windows_product_directory=D:\\\\RemoteInstall\\\\Setup\\\\English\\\\Images\\\\Win2003_trial; \
    sif_file=D:\\\\RemoteInstall\\\\Setup\\\\English\\\\Images\\\\Win2003_trial\\\\i386\\\\templates\\\\
    Ispristndrd.sif"
    

    Note –

    The windows_product_directory should be included all on one line. For display purposes, this entry appears on three separate lines.


    For more information about the variables, see Windows Provisioning Profile Variables.

  2. Create a file named /tmp/windows-profile with the following entries.


    noncustom
    Windows 2003 EE x86 Profile
    false
    

    The entries in this file correspond to the following plan variables.

    • noncustom specifies the Profile Name.

    • Windows 2003 EE x86 Profile specifies the Profile Description.

    • false specifies that this plan will not use a custom profile.

  3. To run the plan, type a command similar to the following example:


     # cr_cli -cmd pe.p.run -u admin -p admin -PID NM:/com/sun/n1osp/untyped/WindowsImage-create-profile \
    -tar H:NM:risserver-windows -comp + -vs windows2003 -pto 30 -nto 1 -f /tmp/windows-profile0

Windows Provisioning Profile Variables

The following table lists all component variables for the Windows provisioning profile. For those variables that have default values, the default is listed. For those variables that do not have default values, an example value is shown for illustration.

Table 8–2 Component Variables for Windows Provisioning Profile

Variable Name 

Description 

Default or Sample Value 

osp_server

Virtual server that represents the OS provisioning service 

masterserver-osp (Default)

os_name

Name of the Windows OS distribution on the RIS server 

Win2003_SP1_x86 (Example)

version

Windows version 

2003 (Default)

architecture

 

x86 (Default)

os_language

Language of the Windows OS distribution 

English (Default)

installPath

Name of Windows image 

Windows:[version]_:[architecture] (Default)

description

Description 

 

min_disk_size

Minimum disk size for this profile to be deployed 

10GB (Default)

boot_server_name

Name of Windows boot server 

Winbiserver1 (Example)

boot_server_subnet_address

Subnet served by boot server 

10.42.42.0 (Example)

boot_server_subnet_ip_address

IP address of boot server on this subnet 

10.42.42.1 (Example)

boot_srv_active_directory_domain

Windows active directory domain for this subnet 

:[targetableComponent:boot_server_domain_name]

(Default) 

windows_product_directory

Windows product directory name on boot server 

:[targetableComponent:ris_share_directory]\Setup\:[os_language]\Images\:[os_name]

(Default) 

sif_file

Location of software information file (SIF) 

D:\RemoteInstall\Setup\English\Images\Win2003\i386\templates\ristndrd.sif

(Example) 

windows_component_folder

Location of auto-generated Windows Provision component folder  

/com/sun/n1osp/autogen-:[target(..):sys.hostName]-windows (Default)