InstallTestPackageCommand Object


Description:

Install a test package bundle (example: "stc") on one or more port groups.

Supports one of the following operations based upon the input provided:

1. Install and or activate a test package bundle (example: "stc") on one or more port groups. Note that this operation is no longer supported for test modules supporting profile activation. Support can be determined by checking the AvailableProfiles attribute for a test module.

2. Activate a profile (example: "default") on one or more test modules. A test module profile contains information about the active test package, number of CPU cores, amount of memory and enabled/disabled status for each port group. The AvailableProfiles test module property provides the list of available profiles that can be activated on a test module.

NOTE: You must call SetFirmwareArchivesDirCommand before calling this command, unless the test package bundle is located in the default firmware directory (example: "{application installation directory}/Firmware/bundle").

Can be used with Command Sequencer: Yes

GUI Command Name: Admin: Install Test Package

Parents: Sequencer, StcSystem

InstallTestPackageCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
EquipmentList

One or more handles for the test modules to activate profiles on.

Type: handle

Default: 0

PortGroupList

One or more handles for the port groups to install a test package on.

Note that this operation is no longer supported for test modules supporting profile activation.

Support can be determined by checking the "AvailableProfiles" property for a test module.

Type: handle

Default: 0

ProfileActivateList

List of profiles to activate on the test modules specified in EquipmentList. If one profile is specified, then it will be activated on all test modules. To activate different profiles for each test module specified in EquipmentList, the number of profiles specified must be equal to the size of EquipmentList. Otherwise only the first profile will be activated on all test modules.

Type: string

Default: "" (empty string)

ProfileInstallList

Currently not supported.

Type: string

Default: "" (empty string)

TestPackage

Test package bundle (example: "stc") to install on the specified port group or groups.

Type: string

Default: "" (empty string)

Version

Test package version (example: "2.0.100") to install on the specified port group or groups.

Type: string

Default: "" (empty string)

InstallTestPackageCommand Read-Only Attributes

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