Sifos Technologies PhyView PVA-3000, Reference Manual

Page: 73 / 134

PVA-3000 Reference Manual
December 2, 2019 Sifos Technologies Page
73
4.3. PowerShell PSA Command Documentation Conventions
In presenting the PowerShell API over the next few sections, certain conventions will be commonly utilized. These are
described in the following table.
Convention Definition
key word
(command)
An API command that will typically be followed by one or more subcommands and/or command
parameters. The minimum required text to execute the command on the command line is
highlighted in purple. (Scripts must utilize the full name of the command.)
-? A universal argument that responds with information on how to use the command including all
command arguments. If a command is given no arguments, the Help menu often will appear.
? A universal query argument that generates a reply of the configuration state of the associated
entity or function.
< parameter >
The “<” and “>” brackets indicate that a particular argument or argument set are optional.
key word
(sub-command)
A subcommand associated with a command. Sub-commands may be followed by associated
parameters but seldom have “nested” sub-commands. Minimum required command line
characters are shown in purple. Absence of an optional sub-command following any command
will cause the associated configuration to remain unchanged.
parameter A numeric or alpha-numeric value that accompanies a particular command or sub-command. It
generally follows the command or sub-command to which it is associated. Absence of an
optional command parameter results in no change to the associated configuration value.
< port > An optional route parameter for all blade-port specific commands. If omitted, the most recent
command specifying a port (command destination) will govern routing of subsequent
commands.
port = < slot , portId >
Example: “3,2” = slot 3, port 2. Slot and Port will default to
lowest available slot, Port 1 upon connecting to a PSA. The current value of port is always
displayed in the PowerShell command prompt . The command line will reject values of port
that are not available in the current selected PSA chassis.
See Section 6.1.1 for description of 99,99 , 99,1 , and 99,2 broadcast configuration ports .
“|”
Indicates logical “OR”
“+” Indicates logical “AND”
stat A special optional query available to many commands to report Operational State and in some
cases, to return a measurement result.
PARAMETER A default configuration parameter.
4.3.1. PowerShell Help Facilities
PowerShell provides interactive help capability at the PowerShell command line. First, an alphabetical listing and
short description of all PowerShell API commands is available by entering the following command:
PSA-1,1> pva_command
Each PowerShell command may then be further explained by typing the specific command followed by the “
-?
”
keyword. An example would be:
PSA-1,1> pva_speed -?
Tcl/Tk help is available from “Help” applications that are provided with Tcl/Tk.
4.4. PowerShell PSA Important Global Settings
PowerShell PSA incorporates many global settings (or global variables), some of which will be of interest to test script
developers and other system users. These settings and their associated global variable names are described in the
following table.
Setting Global Variable Value Range Configuration Commands
Current Test Port port 1,1 - 12,2 Any command or query with a non-
broadcast
slot,port specified will alter port
PVA Test Blade
Populated Slots pvaSlotRange { 1 2 3
…
12 }
psa and psa_config will update these
lists or arrays based on currently
connected PSA. Test Port Firmware
Version pvaPortVersion Array of n . nn formatted
values per test port
Test Port Hardware
Version psaTestBladeHWver Array of integer version
numbers per test port
Test Report Location pvaResultsPath Full file path pva_dut
4.1. Script Editing with N+ (for Microsoft Windows)
PowerShell PSA scripts may be created and edited in the freely available + source code editor that is readily
available on the web (e.g. https://notepad-plus-plus.org ). This powerful editor is knowledgeable of Tcl/Tk and