Documents
Resources
Learning Center
Upload
Plans & pricing Sign in
Sign Out

altiris-int-winpe-en

VIEWS: 146 PAGES: 32

									PRIMERGY ServerView Suite
Integration Module V2.1 for Altiris Deployment Server


WinPE Tools Documentation




April 2007 Edition
© Copyright Fujitsu Siemens Computers GmbH 2007


All hardware and software names used are trademarks of their respective manufacturers.


All rights, including rights of translation, reproduction by printing, copying or similar
methods, in part or in whole, are reserved.
Offenders will be liable for damages.
All rights, including rights created by patent grant or registration of a utility model or
design, are reserved.
Delivery subject to availability. Right of technical modification reserved.
Contents
1         Preface ......................................................................................................1

2         Integration Module ....................................................................................3
2.1       About This Guide ........................................................................................3
2.2       Target Audience..........................................................................................3
2.3       Safety Notes ...............................................................................................3
2.4       Notational Conventions ...............................................................................4

3         Utilities ......................................................................................................5
3.1       BIOS Configuration .....................................................................................7
3.1.1     DeskFlash ..................................................................................................7
3.2       RAID Configuration ................................................................................... 10
3.2.1     Sestraid.................................................................................................... 10
3.2.2     ServerView RAID Service (amCLI) ............................................................ 12
3.3       System Identification and Management Controller Configuration................. 15
3.3.1     SCConfig .................................................................................................. 15
3.4       Helper Tools ............................................................................................. 19
3.4.1     CtrIdent .................................................................................................... 19
3.4.2     ErrLev Utility ............................................................................................. 21
3.4.3     GetXmlVal ................................................................................................ 22
3.4.4     EvalMDPLog / EvalMDPLog64 .................................................................. 24
3.4.5     PrepCLI Utility........................................................................................... 26
3.4.6     StartSAClient (x64 only) ............................................................................ 28




WinPE Tools Documentation
1         Preface
The PRIMERGY Integration Module (PIM) is a collection of DOS- and WinPE-based tools
and sample jobs for Altiris Deployment Server (Altiris DS). It is intended to enable users
to configure and install and manage PRIMERGY servers using Altiris DS.
This document describes all supported WinPE tools for the PRIMERGY Integration
Module. For information about the PRIMERGY Integration Module itself please refer to
the PRIMERGY Integration Module User Guide.
For more information about the Altiris Deployment Solution please refer to the Altiris
Deployment Solution User's Guide at:
http://www.altiris.com/support/documentation.




WinPE Tools Documentation                                                                1
2         Integration Module


2.1       About This Guide
This user guide is intended as a reference for using the PRIMERGY Integration Module
with the Altiris DS for managing and deploying PRIMERGY servers.




2.2       Target Audience
This guide is targeted at experienced administrators who are familiar with the servers of
the PRIMERGY family from Fujitsu Siemens Computers and Altiris Deployment Server.




2.3       Safety Notes
           Caution!
           Improper use of the tools and sample jobs can result in loss of critical data.
           Because of the potential risk of data loss, only experienced individuals should
           use the modules sample jobs. Before using the jobs, you must take all
           necessary precautions to ensure that mission-critical systems remain online if a
           failure occurs.




WinPE Tools Documentation                                                                   3
Integration Module




2.4           Notational Conventions
The following notational conventions are used in this manual:

    Typewriter text        Indicates elements of the syntax that must be entered exactly
                           as shown in the ’Syntax’ section.

    Italics                Indicates variables, arguments or file names

    []                     Indicates an optional entry (an option or argument enclosed in
                           square brackets may be specified), i.e. the entry is not
                           mandatory.

    |                      Indicates an alternative option (none, one or more of several
                           options or arguments can be specified).

    …                      Indicates that one or more options or arguments can be
                           specified several times.

    Bold                   Used for highlighting in the text.

    "Quotes"               Indicates cross-references to other chapters or manuals.

                           Warning sign indicating that your health, the correct
                           functioning of your system, or the security of your data may be
                           at risk if you ignore the information given at this point.

                           Indicates additional information, notes and hints.




4                                                               WinPE Tools Documentation
3          Utilities
This chapter describes the WinPE utilities provided and how to use the utilities in a
scripting environment for server deployment.

           Note:
           Utilities marked (*) are unsupported;
           Unsupported utilities are part of this release for the benefit of supporting
           individual customer setups. Each utility is provided as is. These utilities are not
           guaranteed to work in all possible configurations and must be thoroughly
           tested before being used in mission critical environments.



BIOS configuration

      •    DeskFlash


RAID configuration

      •    ServerView RAID (amCLI)
      •    sestraid


System identification and management controller configuration

      •    SCConfig
      •    ServerControl Service




WinPE Tools Documentation                                                                    5
Utilities


Helper tools

     •      CtrIdent
     •      ErrLev
     •      EvalMDPLog / EvalMDPLog64
     •      GetXmlVal
     •      PrepCLI
     •      StartSAClient




6                                       WinPE Tools Documentation
                                                                                     Utilities




3.1       BIOS Configuration


3.1.1 DeskFlash
DeskFlash (DskFlash.exe) is a command line based BIOS management utility. This utility
can be used for all PRIMERGY systems that are supported by the toolkit.
The correct name of the tool is ‘DeskFlash’, the binary is ‘DskFlash.exe’. Both names
refer to the same utility.
DskFlash can be used to save the BIOS configuration of a PRIMERGY reference system
and to apply the same configuration to a PRIMERGY target system.
In the context of PRIMERGY server deployment, this utility is primarily used to change
the boot sequence of the target PRIMERGY system during the configuration and
installation process.


3.1.1.1 Syntax

DskFlash <no_argument>
DskFlash argument [argument ...]


3.1.1.2 Arguments

 Argument             Description

 /ar                  Save the BIOS configuration to the configuration.
                      Note: Use the ’/ov’ option to overwrite the configuration file in silent
                      mode.

 /upd                 Restore the BIOS.
                      If the required file is not present in the actual working directory, or if
                      the information in the file does not match the board or BIOS
                      version, DskFlash will return error code ’2’.

WinPE Tools Documentation                                                                      7
Utilities


                          Note: Use the ’/ov’ option to overwrite the BIOS configuration in
                          any case.

    /arb                  Allow reboot: the DskFlash kernel can reboot the system if
                          required.

    /ov                   Force overwrite of either the configuration file or the BIOS settings.

    /wd=<path>            Specify the working directory.

    /s /w                 Run DskFlash in silent mode without warning.

    /o=<BIOSfile>         Name of file to be saved or restored

    /lf[=<logfile>]       Log actions to file, logfile name optional.

    -?                    Display help screen.

    <no_argument>         Display help screen.
All arguments are case-sensitive.


3.1.1.3 Return Values
Environment variables: None.

    Error Code        Description

    0                 Command completed successfully.

    1                 Command completed, but log file contains warnings.

    2                 General error.

    4                 Syntax error.

    8                 On one or more target systems, the temporary directory is either
                      missing or does not have enough free space.

    16                On the administrator PC, the temporary directory is either missing or
                      does not have enough free space.

    32                The target system cannot be reached.

    64                On one or more target systems, there is no valid file available for
                      updating the BIOS.



8                                                                  WinPE Tools Documentation
                                                                                  Utilities


3.1.1.4 Configuration File

The configuration file of the DskFlash utility contains information on the board and BIOS
and the contents of the NVRAM. It is binary-coded and has the extension ’.BUP’.
Editing and manipulation of the configuration file is strongly discouraged.


3.1.1.5 Important Notes
DskFlash needs to store temporary data. It looks for either the ‘TMP’ or the ‘TEMP’
environment variable for the path to a temporarily writable folder.
The data that need to be stored in the temporary folder are more than fit on a floppy drive.




WinPE Tools Documentation                                                                   9
Utilities




3.2         RAID Configuration


3.2.1 Sestraid
Sestraid is ServerStart’s tool to analyse the hardware configuration of a PRIMERGY
server and configure the hardware accordingly.


3.2.1.1 Syntax

sestraid <no_argument>
sestraid argument [argument ...]


3.2.1.2 Arguments

 Argument            Description

 -cnb <number>       Use controller <number>. If not supplied controller 0 is used.

 -dr <number>        Use <number> drives to configure the defined array (0 = use all
                     drives).

 -rl <level>         Create an array with RAID level <level>.
                     Values: 0, 1, 1e, 5, 10, 50

 -udr                Create a user defined RAID.
                     Note: Mandatory for creating a user defined array.

 -hs                 Create a global hot spare with array

 -wcf <filename>     Save full RAID configuration to given file.
                     Note: absolute path required.

 -rcf <filename>     Restore RAID Configuration from given filename.
                     Note: absolute path required.

10                                                           WinPE Tools Documentation
                                                                                   Utilities


 <no_argument>         Analyse the server, clear all existing arrays and configure the best
                       possible array on controller 0.
All arguments are case-sensitive.


3.2.1.3 Return Values

Environment variables: None.

 Error Code       Description

 <0               Internal RAID tool reported this error (inverted). See stderr output for
                  more information.

 0                Command completed successfully.

 >0               ServerView RAID encountered an error. See chapter 3.2.2 ServerView
                  RAID Service (amCLI) for more information.


3.2.1.4 Configuration File
For saving and restoring the RAID configuration, sestraid uses a configuration file in XML
format.
Editing and manipulation of the configuration file is strongly discouraged.


3.2.1.5 Important Notes

Saving and restoring the RAID configuration is only supported for controllers that can be
configured with ServerView RAID. See chapter 9 Addendum in the PRIMERGY
Integration Module documentation.




WinPE Tools Documentation                                                                    11
Utilities




3.2.2 ServerView RAID Service (amCLI)
ServerView RAID is a universal RAID management tool from FSC which supports all of
FSC’s RAID controllers. Refer to PRIMERGY Integration Module documentation chapter
9 for information on supported controllers.
amCLI is a command-line-based RAID controller management utility which hooks into
ServerView RAID. To use amCLI the basic ServerView RAID service (amService.exe)
needs to be running. Some LSI controllers also need the SpySer service running.
amCLI can be used to configure array controllers in a PRIMERGY system.


3.2.2.1 Syntax

amCLI <no_argument>
amCLI <command> <objectID> <parameters>


3.2.2.2 Arguments

 Argument                Description

 -w <ObjectID>           Write configuration to specified file.
 <FileName>
                         Note:
                         ObjectID “21/3” refers to the whole system. To save the
                         configuration of a specific controller, use “amCLI –l” to find out
                         the controller’s objectID. The objectID depends on the
                         system’s configuration and may change when the
                         configuration changes.

 -r <FileName>           Read configuration from specified file and configure system
                         accordingly.

 -c <AdapterID>          Create a custom RAID.
 raid=<level>
                         <AdapterID>: the objectID of the controller where the array is
 <DriveID> …
                         to be created.
                         <level>: the desired raid level
                         <DriveID>: the objectIDs of the drives for the array


12                                                            WinPE Tools Documentation
                                                                                  Utilities


                          Note:
                          Use “amCLI –l” to find out the controller’s and drive’s
                          objectIDs.
                          “amCLI -? exec <AdapterID>” informes about the controller’s
                          array abilities.

 -Z                       Clear controller configuration.

 -l                       List current configuration

 -u <User> -p             ServerView RAID needs Administrator rights. Add user
 <Password>               account data if current user has no administration rights.

 -e <AdapterID            Force the controller to scan the current configuration and to
 scan_configuration       report the configuration to ServerView RAID service
                          <AdapterID>: the objectID of the controller
                          Note:
                          Use “amCLI –l” to find out the controller’s objectID.

 -?                       Display help screen.

 <no_argument>            Display help screen.
All arguments are case-sensitive.


3.2.2.3 Return Values
Environment variables: None.

 Error Code           Description

 0                    Command completed successfully.

 1                    An internal error occurred.

 2                    The syntax of the command was invalid.

 3                    An invalid object was addressed.

 4                    Internal memory allocation failed

 5                    Operation not supported by object

 6                    Property not supported by object



WinPE Tools Documentation                                                                 13
Utilities


 7                     Operation cannot be executed at this time.

 8                     Communication with core service failed.

 9                     No access to SVRAID database

 10                    SVRAID database did not initialise correctly

 11                    SVRAID database corrupt

 12                    Command failed

 13                    Invalid data specified for command

 14                    Login failed

 15                    No administration rights granted.

 16                    Could not open file

 17                    Could not read file

 18                    Could not write file


3.2.2.4 Important Notes
Controllers which are to be managed with ServerView RAID need to either be RAID
controllers or be configured as RAID controllers. In save/restore mode ServerView RAID
always analyses the complete system and does not complain if no RAID controller is
found.
amCLI requires the ServerView RAID service (amService) to be running. It needs to be
started and to initialise (this may take a few minutes with big systems) before amCLI can
be used.
The ServerView RAID service relies on events to be notified of changes within the
controller configuration. With WinPE there is no event handling. To make sure the service
always ‘sees’ the correct controller configuration it is recommended to force the controller
to scan and update the configuration to the service.
This can be done with the command: amCLI -e <objectID> scan_configuration
ServerView RAID needs administrator rights. Add user account data (options –u –p) if
current user has no administration rights. When amCLI is used with WinPE in most cases
a user with administration rights needs to be created.



14                                                             WinPE Tools Documentation
                                                                              Utilities




3.3       System Identification and Management
          Controller Configuration


3.3.1 SCConfig
The ServerControl Service is a universal system management tool which supports all of
Fujitsu Siemens’ PRIMERGY servers. Refer to PRIMERGY Integration Module
documentation chapter 9 for information on supported systems.
SCConfig is a command-line-based system management utility which hooks into the
ServerControl Service. To use SCConfig the ServerControl service (svrctrl.exe) needs to
be running. The ServerControl Service is started automatically within FSC’s WinPE.
SCConfig can be used configure PRIMERGY servers.


3.3.1.1 Syntax

SCConfig –transfer <filename>


3.3.1.2 Arguments

 Argument                  Description

 -transfer <filename>      Pass a XML-file with commands to execute to SCConfig.
No other arguments are supported.




WinPE Tools Documentation                                                               15
Utilities



3.3.1.3 Return Values
Environment variables: None.

 Error Code      Description

 0               Success.

 1               Error.
See the command file <filename> for individual command errors.


3.3.1.4 Important Notes
SCConfig requires the ServerControl service (svrctrl.exe) to be running. It needs to be
started before SCConfig can be used. Within FSC’s WinPE the service is always running.


3.3.1.5 Command File

SCConfig uses a command file which is both used to specify the command for the
ServerControl Service and to report back the individual command results. To keep the
original command file unchanged, it is recommended to use a copy of the command file
for the actual command execution.
The command file needs to be clean XML and consists of various commands which get
transferred and executed one by one.
The individual commands in the command file need to be setup as follows:

<!— {comment} -->
<CMD Context="SCCI" OC="ConfigSpace" OE="{CSV}" OI="{OI}"
Type="SET" MID="81">
<DATA Type="{DataType}" Len="{Len}">{Data}</DATA>
<STATUS></STATUS>
</CMD>
Where
     {comment}    any comment
     {CSV}        a ConfigSpace Variable. See scci_cs.pdf in the “Manual32” folder for
                  details on ConfigSpace Variables.

16                                                         WinPE Tools Documentation
                                                                                   Utilities


     {OI}          the Object ID. Usually 0 since most Variables only have one instance.
                   Needs to be set to the correct and corresponding value when
                   addressing user-related variables.
     {DataType}    the data type. Data can be supplied as xsd::hexBinary or xsd::string.
     {Len}         the length in bytes of the supplied data. Optional when using
                   xsd::string
     {Data}        are the supplied data
After command completion the result of the individual commands is written to
<STATUS></STATUS>.

 Status Return Code        Description

 0x00                      CM_STAT_SUCCESS.

 0x01                      CM_STAT_INVALID_CMD

 0x02                      CM_STAT_INVALID_OBJ

 0x03                      CM_STAT_DEVICE_NOT_EXIST

 0x04                      CM_STAT_INVALID_SET_VALUE

 0x05                      CM_STAT_DEVICE_BUSY

 0x06                      CM_STAT_EXEC_FAILED

 0x07                      CM_STAT_OBJ_READONLY

 0x08                      CM_STAT_OBJ_WRITE_PROTECT

 0x09                      CM_STAT_INTERFACE_CORRUPT

 0x0A                      CM_STAT_SET_STRING_TOOLONG

 0x0B                      CM_STAT_SET_COUNT_WRONG

 0x0C                      CM_STAT_NO_MORE_REPLIES

 0x0D                      CM_STAT_ACCESS_VIOLATION

 0x0E                      CM_STAT_FRAME_ALLOC_ERROR

 0x0F                      CM_STAT_DEVICE_NOT_RESPONDING

 0x10                      CM_STAT_CHECKSUM_ERROR



WinPE Tools Documentation                                                                  17
Utilities


 0x11       CM_STAT_OUT_OF_MEMORY

 0x12       CM_STAT_ILLEGAL_NR_ARGS

 0x13       CM_STAT_NO_DATA

 0x14       CM_STAT_INVALID_CABINET_NUMBER

 0x15       CM_STAT_MORE_REPLIES_FOLLOWING

 0x16       CM_STAT_REQUEST_PENDING

 0x17       CM_STAT_CMD_HEADER_INCOMPLETE

 0x18       CM_STAT_ACCESS_DENIED




18                                    WinPE Tools Documentation
                                                                                    Utilities




3.4          Helper Tools


3.4.1 CtrIdent
CtrIdent is a command-line-based utility for scanning the PCI bus. The utility compares
the controllers on the PCI bus against a configuration file or displays all PCI controllers in
the system. It can be used for looping through all controllers on the PCI bus.


3.4.1.1 Syntax

CtrIdent
CtrIdent [argument]


3.4.1.2 Arguments

 Argument              Description

 -findnext             Finds the next controller on the PCI bus which matches the rule set
                       defined in CtrIdent.cfg.

 -list                 Lists all PCI controllers

 -cfg <filename>       Specifies configuration file.

 -res <resultfile>     Specifies result file.

 -help                 Prints help information.

 <no_argument>         Prints tool version and help.
All arguments are case-sensitive.


3.4.1.3 Return values
Environment variables: TOOLNAME, CTRLINDX.


WinPE Tools Documentation                                                                   19
Utilities


 Error Code        Description

 0                 Command completed successfully. TOOLNAME and CTRLINDX are
                   set to next controller when called with argument ‘-findnext’.

 1                 No more controllers found.

 200               Could not open configuration file

 202               Syntax error in configuration file

 203               Too many tools specified in configuration file

 204               Too many controllers specified in configuration file

 210               Could not open result file

 220               Memory allocation failed

 222               Invalid call


3.4.1.4 Configuration File
CtrIdent uses a configuration file to sort controllers into categories. The name and
location of the configuration file can be specified.
Two environment variables are used as starting point, TOOLNAME and CTRLINDX (if
empty, CtrIdent starts at the first controller found). The result of the comparison is written
to a result file, cires.bat. This result script needs to be run after CtrIdent to supply
TOOLNAME and CTRLINDX with the result of the comparison.
The configuration file setup is similar to the INI-file format and is structured into sections
with controller-value-pairs, where controllers are identified by VendorID, DeviceID,
SubsystemVendorID, SubsystemID and RevisionID.
All IDs except RevisionID need to be specified with 4 digits, RevisionID is specified with 2
digits. FFFF or FF in the specification is ignored.
Example:
     [SectionName]
     VID1_DID1_SVI1_SDI1_R1="Controller Name"
     1000_0030_FFFF_FFFF_FF="LSI Logic 1030 Ultra320"
If the comparison is a hit, TOOLNAME is set to SectionName and CTRLINDX is set to the
number of found controllers for this section.


20                                                               WinPE Tools Documentation
                                                                                   Utilities


3.4.2 ErrLev Utility
ErrLev is a command-line-based utility for setting or resetting the error level.


3.4.2.1 Syntax

ErrLev
ErrLev [<value>]


3.4.2.2 Arguments

 Argument                           Description

 <value>                            Set the error level to <value>.

 <no_argument>                      Reset the error level (set to 0).


3.4.2.3 Return values

Either the argument <value> or 0.




WinPE Tools Documentation                                                                21
Utilities




3.4.3 GetXmlVal
GetXmlVal is a tool to evaluate ServerStart’s “systemdata.xml“ file to get information
about a PRIMERGY server. The tool is designed to extract values from an XML file where
the tags do not feature properties.


3.4.3.1 Syntax

GetXmlVal <file> <param> <variable>


3.4.3.2 Arguments

 Argument         Description

 <file>           Specifies the file in which to search for the first occurrence of the
 <param>          specified XML parameter.
 <variable>
                  The specified environment variable is set to the value of the
                  parameter.

 -?               Prints help information.
All arguments are case-sensitive.


3.4.3.3 Return values

Environment variables: none.

 Error Code      Description

 0               No error.

 Other           An error occurred. View command line output for more information..




22                                                            WinPE Tools Documentation
                                                                                Utilities



3.4.3.4 Important Notes
GetXmlVal is a tool to evaluate ServerStart’s “systemdata.xml“ file. It is designed to
extract values from an XML file where the tags do not feature properties. The values of
the XML tag are stored in environment variables to for further use in scripting
environment.




WinPE Tools Documentation                                                                 23
Utilities




3.4.4 EvalMDPLog /
      EvalMDPLog64
EvalMDPLog[64] is used to evaluate ServerStart’s WinPE startup phase and log all
status- and error-messages into the job status of the called job in the deployment server.


3.4.4.1 Syntax

EvalMDPLog[64] [argument]


3.4.4.2 Arguments

 Argument          Description

 -log <file>       Specfies the logfile o be evaluated.

 -full             Logs all messages from the logfile to the deployment server.

 -basic            Logs only important messages to the deployment server.

 -help             Prints help information.
All arguments are case-sensitive.


3.4.4.3 Return values
Environment variables: none.

 Error Code                    Description

 0                             No error.

 1                             Could not find log file.

 10                            Could not open log file

 20                            Syntax error in log file

 998                           Syntax error in EvalMDPLog call.


24                                                            WinPE Tools Documentation
                                                                                  Utilities


3.4.4.4 Important Notes

EvalMDPLog is used to evaluate ServerStart’s WinPE startup phase and log all status-
and error-messages into the job status of the called job on the deployment server.
It can only be used when Altiris AClient is already running. It uses WLogEvent to notify to
deployment server of status- or error events.




WinPE Tools Documentation                                                                25
Utilities




3.4.5 PrepCLI Utility
PrepCLI is a command-line-based utility for creating a service partition. This service
partition is used by various online diagnostic utilities, service utilities, firmware and driver
update functions supported by the GlobalFlash utility, which is part of FSC’s server
management software.
GlobalFlash is a firmware and BIOS update utility for PRIMERGY servers. For more
information on GlobalFlash, please see the GlobalFlash manual on the ServerBooks CD.


3.4.5.1 Syntax

PrepCLI <no_argument>
PrepCLI argument [argument ...]


3.4.5.2 Arguments

 Argument                  Description

 -g <hd_number>            Create a service partition on disk drive <hd_number>.

 -G <hd_number>            Delete a service Partition from disk drive <hd_number>.

 -c                        Check service partition.

 <no_argument>             Display help screen.
All arguments are case-sensitive.


3.4.5.3 Return Values

Environment variables: None.

 Error Code            Description

 0                     -c: Service Partition on boot drive not yet initialised.
                       other: Command completed successfully



26                                                                WinPE Tools Documentation
                                                                                    Utilities


 -3                    -g: Service Partition already exists.

 -2                    -c: No Service Partition found.

 -1                    -c: Service Partition on other than boot drive found.
                       other: Error.

 1                     -c: Service Partition on boot drive, initialised with DOS.

 Other                 Error


3.4.5.4 Important Notes

PrepCLI can be used to create a service partition on the system disk of PRIMERGY
servers, which is required by GlobalFlash.
It is recommended that you use PrepCLI instead of other partitioning tools, otherwise the
proper functioning of GlobalFlash cannot be guaranteed.
The following restrictions for creation of the service partition apply:
      •    It must lie within the first 2GB of the disk drive,
      •    It must lie within the first 1024 cylinders of the disk drive,
      •    It must have a size of at least 150MB, and
      •    It must be a primary partition.




WinPE Tools Documentation                                                                 27
Utilities




3.4.6 StartSAClient (x64 only)
StartSAClient is a tool which connects back to the Altiris deployment server and starts
saclient.cmd from the deployment server itself. All information necessary to connect to
the deployment server is read from X64Share.cmd and ld.cmd in the MDP\AClient folder
at TFTP root of the deployment server. It can only be used within x64 WinPE.


3.4.6.1 Syntax

StartSAClient


3.4.6.2 Arguments

The tool supports no arguments.


3.4.6.3 Return values
Environment variables: none.

 Error Code       Description

 0                No error.

 Other            An error occurred.




28                                                          WinPE Tools Documentation

								
To top