InstallRawImageCommand Object


Description:

Install a raw image on one or more chassis or test modules.

NOTE: You must call SetRawArchivesDirCommand before calling this command, unless the raw images are located in the default raw image directory (example: "{application installation directory}/Firmware/rawimg").

Tcl example:

# Connect to the chassis
stc::connect $chassisIpAddr

# Set the directory where the raw images are located
stc::perform SetRawArchivesDir -Dir $imageDir

# Get the physical chassis manager handle
set mgr [stc::get system1 -children-physicalchassismanager]

# Get the handle to the physical chassis
set chassisHandle [stc::get $mgr -children-physicalchassis]

# Get the handle to the physical test modules
set moduleHandles [stc::get $chassisHandle -children-physicaltestmodule]

# Build module list
set installList {}

foreach handle $moduleHandles {
    set slot [stc::get $handle SlotNumber]
    foreach module $moduleList {
            if {$module == $slot } {
                puts "Adding test module $module to the install list"
                lappend installList $handle
            }
    }
}

# Install the raw image on the test modules
stc::perform InstallRawImage -HandleList $installList -Version $imageVersion

Can be used with Command Sequencer: Yes

GUI Command Name: Admin: Install Raw Image

Parents: Sequencer, StcSystem

InstallRawImageCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
AddonPackages

Addon Packages

Type: string

Default: "" (empty string)

EquipmentList

One or more handles for the chassis or test modules to install the specified raw image on.

Type: handle

Default: 0

RestoreFactoryDefaults

Restore Factory Defaults

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Restore Factory Defaults

FALSE

Do not Restore Factory Defaults

Version

Raw image version to install. Example: "2.0.100".

Type: string

Default: 2.0.0

WaitForTestModules

Tells whether to wait or not to wait for TestModule to boot up.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Wait for TestModule to boot up

FALSE

Not to wait for TestModule to boot up

InstallRawImageCommand Read-Only Attributes

Read-Only Attribute Description
Common Read-Only Attributes ElapsedTime, EndTime, ProgressCurrentStep, ProgressCurrentStepName, ProgressCurrentValue, ProgressDisplayCounter, ProgressMaxValue, ProgressStepsCount, StartTime, State, Status