System Commands
Controls and queries settings that affect the VNA system.
SYSTem: ACTive | CHANnel CHANnels | CATalog? | DELete | HOLD | RESume | REVision | CPU? | DSP? | DSPFpga? CORRection | COUNt? | REPort HISTory | FPANel? | SCPI? MACRO:COPY | SOURce MCLass | CATalog? MEASurement | NAME? | TRACe? | WINDow? POWer: | LIMit | LOCK | STATe SECurity | [LEVel] SHORtcut | DELete | EXECute | PATH | TITLe WINDows |
Click on a red keyword to view the command details.
See Also
SYSTem:ABORt:THReshold <value>
(Read-Write) When a PNA setting is made while a sweep is in progress, the sweep is immediately aborted by default. This command allows you to change that behavior by specifying a time threshold. When a setting change is made during a sweep and if the total sweep time is less than the threshold time, then the sweep is allowed to finish instead of immediately aborting. In general, PNA setting changes that could cause an aborted sweep are changes that affect how a measurement is made, such as changes in stimulus conditions. For example, with a threshold setting of 60 seconds:
Notes:
|
|
Parameters |
|
<value> |
Threshold time in seconds. Set to 0 to immediately abort a sweep when a PNA setting is made. |
Examples |
SYST:ABOR:THR 10 'When a setting is made during a sweep, if that sweep requires less than 10 seconds more to complete, it will be allowed to finish instead of aborting. |
Query Syntax |
SYSTem:ABORt:THReshold? |
0 - No threshold time; all sweeps are immediately aborted. |
SYSTem:ACTive:CHANnel?
(Read-only) Returns the number of the active channel. The active channel is the channel number that contains the active measurement. The active measurement is the trace that has a highlighted Tr# in the Trace Status area. If there is no active channel, 0 is returned. |
|
Examples |
SYST:PRES SYST:ACT:CHAN? 'Returns 1 |
Return Type |
Integer |
Not Applicable |
SYSTem:ACTive:MEASurement?
(Read-only) Returns the name of the active measurement. While looking at the PNA display, the active measurement is the trace that has a highlighted Tr# in the Trace Status area. Only displayed measurements can be active. If there is no active measurement, " " (empty string) is returned. |
|
Examples |
SYST:PRES 'Returns "CH1_S11_1" |
Return Type |
String |
Not Applicable |
SYSTem:BEEPer:VOLume <num>
(Read-Write) Sets and reads the volume of the internal speaker. |
|
Parameters |
|
<num> |
Relative volume of the internal speaker. Choose a volume between 0 (off) and 100. |
Examples |
SYST:BEEP:VOL 5 system:beeper:volume |
Query Syntax |
SYSTem:BEEPer:VOLume? |
0 |
SYSTem:CHANnels:CATalog?
(Read-only) Returns the channel numbers currently in use. |
|
Examples |
SYST:CHAN:CAT? system:channels:catalog? 'Returns: "1,2,3" |
Return Type |
String of comma-separated numbers |
Not Applicable |
SYSTem:CHANnels:COUPle[:STATe] <bool>
(Read-Write) Sets and reads the state of channel coupling. This causes the PNA to emulate Keysight 8720 channel coupling. When set to ON, all existing S-parameter channels receive the stimulus settings of the active channel. Subsequent changes made to any coupled channel are changed on all coupled channels. Channels with applications such as SMC, VMC, GCA, Noise, IMD are not affected. Coupling is primarily aimed at stimulus settings (such as start, stop, points, power) but also applies to many trigger settings and to Cal Set pointers. |
|
Parameters |
|
<bool> |
ON (or 1) Channels are coupled OFF (or 0) Channels are NOT coupled |
Examples |
SYST:CHAN:COUP 1 system:channels:couple:state OFF |
Query Syntax |
SYSTem:CHANnels:COUPle[:STATe]? |
OFF |
SYSTem:CHANnels:DELete <value>
(Write-only) Deletes the specified channel. |
|
Parameters |
|
<value> |
Channel number to delete |
Examples |
SYST:CHAN:DEL 2 |
Query Syntax |
Not Applicable |
Not Applicable |
SYSTem:CHANnels:HOLD
(Write-only) Places all channels in hold mode. To place a single channel in hold mode, use SENS:SWE:MODE. |
|
Examples |
SYST:CHAN:HOLD |
Query Syntax |
Not Applicable |
Not Applicable |
SYSTem:CHANnels:RESume
(Write-only) Resumes the trigger mode of all channels that was in effect before sending SYSTem:CHANnels:HOLD (must be sent before SYST:CHAN:RESume). |
|
Examples |
SYST:CHAN:RES |
Query Syntax |
Not Applicable |
Not Applicable |
SYSTem:CHANnels:SINGle:COMBine <chanNums>
(Write-only) Sets the trigger count on the list of channels to ONE, and then combines the channels into a single efficient acquisition. The index line stays high during the entire acquisition. |
|
Parameters |
|
<chanNums> |
Existing comma separated list of channel numbers to combine. |
Examples |
SYST:CHAN:SING:COMB 1,3,4 System:channels:single:combine 1,3,4 |
Query Syntax |
Not Applicable |
Not Applicable |
SYSTem:CLOCk[:STATe] <bool>
(Read-Write) Sets and reads the clock visibility state in the VNA status bar. |
|
Parameters |
|
<bool> |
ON (or 1) Clock is visible in the PNA status bar. OFF (or 0) Clock is NOT visible in the PNA status bar. |
Examples |
SYST:CLOC 1 system:clock:state OFF |
Query Syntax |
SYSTem:CLOCk[:STATe]? |
ON |
SYSTem:CONFigure <model>,<address>
(Write-only) Restarts as an "N-port" PNA using the specified multiport test set. Learn more about PNA Multiport capability. See other commands to configure multiport test sets. |
|
Parameters |
|
<model> |
String - Model of the test set with which to restart. Use "Native" to restart without a test set. To see a list of supported test sets, use SENS:MULT:CAT? |
<address> |
Numeric - GPIB Address of the test set. Ignored when model = "Native". |
Examples |
SYST:CONF "NATIVE",0 system:configure "N44xx",18 |
Query Syntax |
Not Applicable |
Not Applicable |
SYSTem:CONFigure:DIRectory? <char>
(Read-only) Returns the directory path location for the specified file type. |
|
Parameters |
None |
<char> |
Type of file. Choose from: STATe - This is the location for the storage of state files. APPLication - This is the location of the PNA firmware executable files. SUPPort - This is the location of private support files for the PNA firmware. See these file locations. |
Example |
SYST:CONF:DIR? SUPP |
Return Type |
String |
Not applicable |
SYSTem:CONFigure:REVision:CPU?
(Read-only) Returns a number that corresponds to the PNA CPU speed that is visible in the Help, About Network Analyzer dialog box. Learn more. Use the following table to learn the clock speed using the returned value. Reported CPU version - Clock speed 1.0 - 266 MHz 2.0 - 500 MHz 3.0 - 1100 MHz 4.0 - 1600 MHz 5.0 - 2000 MHz 6.0 - 2000 MHz dual core. |
|
Parameters |
None |
Example |
SYST:CONF:REV:CPU? |
Return Type |
String |
Not applicable |
SYSTem:CONFigure:REVision:DSP?
(Read-only) Returns the DSP Revision number that is visible in the Help, About Network Analyzer dialog box. Learn more. |
|
Parameters |
None |
Example |
SYST:CONF:REV:DSP? |
Return Type |
String |
Not applicable |
SYSTem:CONFigure:REVision:DSPFpga?
(Read-only) Returns the DSP FPGA Revision number that is visible in the Help, About Network Analyzer dialog box. Learn more. |
|
Parameters |
None |
Example |
SYST:CONF:REV:DSPF? |
Return Type |
String |
Not applicable |
SYSTem:CORRection:WIZard[:IMMediate] <char>
(Write-only) Launches either the Calibration Wizard or the Version 2 Calibration Kit File Manager dialog box. Remote operation returns immediately after the dialog is launched. This is done to avoid timeout issues with I/O protocols such as VISA. Although it is possible to send commands to the PNA while the dialog is open, this is not encouraged. Application programs should wait until the dialog is closed before resuming remote operations. |
|
Parameters |
|
<char> |
Choose from: MAIN - Launches the Calibration Wizard which matches the current channel, such as standard S-params, NoiseFigure, GCA, and so forth. CKIT - Launches the Version 2 Calibration Kit File Manager dialog box. Both display on the PNA screen. |
Examples |
SYST:CORR:WIZ
MAIN |
Query Syntax |
Not Applicable |
Not Applicable |
SYSTem:DATE?
(Read-only) Returns the system date. |
|
Parameters |
None |
Example |
SYST:DATE? |
Return Type |
Comma separated numbers representing year, month, day. |
Not applicable |
SYSTem:ERRor?
(Read-only) Returns the next error in the error queue. Each time the analyzer detects an error, it places a message in the error queue. When the SYSTEM:ERROR? query is sent, one message is moved from the error queue to the output queue so it can be read by the controller. Error messages are delivered to the output queue in the order they were received. The error queue is cleared when any of the following conditions occur:
If the error queue overflows, the last error is replaced with a "Queue Overflow" error. The oldest errors remain in the queue and the most recent error is discarded. |
|
Examples |
SYST:ERR? |
Not Applicable |
SYSTem:ERRor:COUNt?
(Read-only) Returns the number of errors in the error queue. Use SYST:ERR? to read an error. |
|
Examples |
SYST:ERR:COUN? |
Not Applicable |
SYSTem:ERRor:REPort:SUNLeveled <bool>
(Read-Write) Specifies whether or not to report Source Unleveled errors to the SCPI system error buffer. This setting will revert to the default (OFF) setting on Instrument Preset. |
|
Parameters |
|
<bool> |
ON (or 1) Report Source Unleveled Errors. Read errors from the system error buffer using SYST:ERR? OFF (or 0) Do NOT report Source Unleveled Errors. |
Examples |
SYST:ERR:REP:SUNL 1 system:error:report:sunleveled ON |
Query Syntax |
SYSTem:ERRor:REPort:UNLeveled? |
OFF |
SYSTem:FPReset
(Write-only) Performs a standard Preset, then deletes the default trace, measurement, and window. The PNA screen becomes blank. |
|
Examples |
SYST:FPR |
Not applicable |
SYSTem:HISTory:FPANel?
(Read-only) Returns front panel history. |
|
Parameters |
None |
Examples |
SYST:HIST:FPAN? |
Return Type |
String of comma-separated history of front panel actions. |
Not Applicable |
SYSTem:HISTory:SCPI?
(Read-only) Returns SCPI history. |
|
Parameters |
None |
Examples |
SYST:HIST:SCPI? |
Return Type |
String of comma-separated history of SCPI commands sent to the PNA. |
Not Applicable |
SYSTem:MACRo:COPY:CHANnel<cnum>[:TO] <num>
(Write-only) Copies ALL settings from <cnum> channel to <num> channel. Learn more about copy channels. Use SENS:PATH:CONF:COPY to copy ONLY mechanical switch and attenuator settings. |
|
Parameters |
|
<cnum> |
Channel number to copy settings from. If unspecified, value is set to 1. |
<num> |
Channel number to copy settings to. |
Examples |
SYST:MACR:COPY:CHAN1 2 system:macro:copy:channel2:to 3 |
Query Syntax |
Not Applicable |
Not Applicable |
SYSTem:MACRo:COPY:CHANnel<fromChan>:SOURce <fromPort>,<toChan>,<toPort>
(Write-only) Copies and applies an existing Source Power Calibration to another channel. Learn more about source power calibration. |
|
Parameters |
|
<fromChan> |
Channel number of the existing source power correction. |
<fromPort> |
Port number of the existing source power correction. |
<toChan> |
Channel number to which the source power correction will be copied. |
<toPort> |
Port number to which the source power correction will be applied. |
Examples |
SYST:MACR:COPY:CHAN1:SOUR 1,2,1 system:macro:copy:channel2:source 2,1,2 |
Query Syntax |
Not Applicable |
Not Applicable |
SYSTem:MCLass:CATalog?
(Read-only) Returns measurement classes available on the PNA. Learn more about Measurement Classes. |
|
Parameters |
None |
Examples |
SYST:MCLass:CAT? |
Return Type |
String of comma-separated measurement class names. See the complete list of measurement class names. |
Not Applicable |
SYSTem:MCLass:PARameter:CATalog? <name>
(Read-only) Returns ALL parameters that are supported by the specified measurement class. |
|
Parameters |
|
<name> |
String. Measurement Class name. See the complete list of measurement class names. |
Examples |
'Returns all parameters for Gain Compression. SYST:MCL:PAR:CAT? "Gain Compression" Return: "S11,S12,S13,S14,S21,S22,S23,S24,S31,S32,S33,S34,S41,S42,S43,S44,A,B,C,D,R,R1,R2,R3,R4" |
Return Type |
String of comma-separated parameters |
Not Applicable |
SYSTem:MEASurement:CATalog? [chan]
(Read-only) Returns ALL measurement numbers, or measurement numbers from a specified channel. |
|
Parameters |
|
[chan] |
Optional. Channel number to catalog. If not specified, all measurement numbers are returned. |
Examples |
'Returns all measurement numbers SYST:MEAS:CAT? 'Returns the measurement numbers on channel 2 system:measurement:catalog? 2 |
Return Type |
String of comma-separated numbers For example: "1,2" |
Not Applicable |
SYSTem:MEASurement<n>:NAME?
(Read-only) Returns the name of the specified measurement. |
|
Parameters |
|
<n> |
Measurement number for which to return the measurement name. If unspecified, value is set to 1. |
Examples |
'Returns the name of measurement 2 SYST:MEAS2:NAME? |
Return Type |
String |
Not Applicable |
SYSTem:MEASurement<n>:TRACe?
(Read-only) Returns the trace number of the specified measurement number. Trace numbers restart for each window while measurement numbers are always unique. |
|
Parameters |
|
<n> |
Measurement number for which to return the trace number. If unspecified, value is set to 1. |
Examples |
'Returns the trace number of measurement 1 SYST:MEAS1:TRAC? |
Return Type |
Numeric |
Not Applicable |
SYSTem:MEASurement<n>:WINDow?
(Read-only) Returns the window number of the specified measurement number. |
|
Parameters |
|
<n> |
Measurement number for which to return the window number. If unspecified, value is set to 1. |
Examples |
'Returns the window number of measurement 2 SYST:MEAS2:WIND? |
Return Type |
Numeric |
Not Applicable |
SYSTem:POWer<pnum>:LIMit <value>
(Read-Write) Sets and returns the power limit for the specified port. Learn more about Power Limit. |
|
Parameters |
|
<pnum> |
Port number. Choose any PNA port. |
<value> |
Power limit in dBm |
Examples |
SYST:POW1:LIM 5 system:power2:limit 0 |
Query Syntax |
SYSTem:POWer<pnum>:LIMit? |
Return Type |
Numeric |
100 dBm |
SYSTem:POWer:LIMit:LOCK <bool>
(Read-Write) Enables or disables the ability to change the power limit values through the user interface. Learn more about Power Limit. |
|
Parameters |
|
<bool> |
Power limit lock. Choose from: ON or 1 - Disables the ability to change the power limit values from the user interface. OFF or 0 - Enables the ability to change the power limit values from the user interface. |
Examples |
SYST:POW:LIM:LOCK 1 system:power:limit:lock OFF |
Query Syntax |
SYSTem:POWer:LIMit:LOCK? |
Return Type |
Boolean |
OFF |
SYSTem:POWer<pnum>:LIMit:STATe <bool>
(Read-Write) Enables or disables the power limit for the specified port. Learn more about Power Limit. |
|
Parameters |
|
<pnum> |
Port number. Choose any PNA port. |
<value> |
Power limit state. Choose from: ON or 1 Enables the power limit for the port<pnum>. OFF or 0 Disables the power limit for the port<pnum>. |
Examples |
SYST:POW1:LIM:STAT ON system:power2:limit:state 0 |
Query Syntax |
SYSTem:POWer<pnum>:LIMit:STATe? |
Return Type |
Boolean |
OFF |
SYSTem:PRESet
(Write-only) Deletes all traces, measurements, and windows. In addition, resets the analyzer to factory defined default settings and creates a S11 measurement named "CH1_S11_1". For a list of default settings, see Preset. Regardless of the state of the User Preset Enable checkbox, the SYST:PRESet command will always preset the PNA to the factory preset settings, and SYST:UPReset will always perform a User Preset. If the PNA display is disabled with DISP:ENAB OFF then SYST:PRES will NOT enable the display. This command performs the same function as *RST with one exception: Syst:Preset does NOT reset Calc:FORMAT to ASCII as does *RST. |
|
Examples |
SYST:PRES |
Not applicable |
SYSTem:SECurity[:LEVel] <char>
(Read-Write) Sets and returns the display of frequency information on the PNA screen and printouts. |
|
Parameters |
|
<char> |
Choose from: NONE - ALL frequency information is displayed. LOW - NO frequency information is displayed. Frequency information can be redisplayed using the Security Setting dialog box or this command. HIGH - LOW setting plus GPIB console is disabled. Frequency information can be redisplayed ONLY by performing a Preset, recalling an instrument state with None or Low security settings, or using this command. EXTRa - HIGH setting plus:
|
Examples |
SYST:SEC
LOW |
Query Syntax |
SYSTem:SECurity[:LEVel]? |
Return Type |
Character |
None |
SYSTem:SET <block>
(Read-Write) Sends a definite-length binary block Instrument state and sets the PNA with those settings. This command does the same as saving a *.sta file to the PNA (MMEM:STOR STATE) and then MMEM:TRAN to transfer the file to the computer. |
|
Parameters |
|
<block> |
The Instrument state file as definite-length arbitrary binary block. |
Examples |
SYST:SET <block> |
Query Syntax |
SYSTem:SET? (This saves the instrument state file to the remote computer.) |
Return Type |
Definite-length arbitrary binary block. |
Not Applicable |
SYSTem:SHORtcut<n>:ARGuments<string>
(Read-Write) Reads and writes the arguments for the specified macro. On the Edit Macro Dialog, this is called the "Macro run string parameters". |
|
Parameters |
|
<n> |
Numeric. Number of the macro that is stored in the PNA. To find the number of a macro, either open the Macro Setup dialog and count the line number of the desired macro, or query the titles of all of the macros for the desired macro title. |
<string> |
Arguments for the specified macro. |
Examples |
SYST:SHOR1:ARG "http://na.support.keysight.com/pna/help/PNAWebHelp/help.htm" |
Query Syntax |
SYSTem:SHORtcut<n>:ARGuments? |
Not Applicable |
SYSTem:SHORtcut<n>:DELete
(Write-only) Removes the specified macro from the list of macros in the PNA. Does not delete the macro executable file. |
|
Parameters |
|
<n> |
Numeric. Number of the macro that is stored in the PNA. To find the number of a macro, either open the Macro Setup dialog and count the line number of the desired macro, or query the titles of all of the macros for the desired macro title. |
Examples |
SYST:SHOR1:DEL |
Query Syntax |
Not Applicable |
Not Applicable |
SYSTem:SHORtcut<n>:EXECute
(Write-only) Executes (runs) the specified Macro (shortcut) that is stored in the PNA. |
|
Parameters |
|
<n> |
Numeric. Number of the macro that is stored in the PNA. To find the number of a macro, either open the Macro Setup dialog and count the line number of the desired macro, or query the titles of all of the macros for the desired macro title. |
Examples |
SYST:SHOR1:EXEC |
Query Syntax |
Not Applicable |
Not Applicable |
SYSTem:SHORtcut<n>:PATH <string>
(Read-Write) Defines a Macro (shortcut) by linking a path and file name to the Macro number. To be executed, the executable file must be put in the PNA at the location indicated by this command. |
|
Parameters |
|
<n> |
Numeric. Number of the macro to be stored in the analyzer. If the index number already exists, the existing macro is replaced with the new macro. |
<string> |
Full path, file name, and extension, of the existing macro "executable" file. To find the number of a macro, either open the Macro Setup dialog and count the line number of the desired macro, or query the titles of all of the macros for the desired macro title. |
Examples |
SYST:SHOR1:PATH "C:/Program Files/Keysight/Network Analyzer/Documents/unguideMultiple.vbs" |
Query Syntax |
SYSTem:SHORtcut<n>:PATH? |
Not Applicable |
SYSTem:SHORtcut<n>:TITLe<string>
(Read-Write) Reads and writes the name of the specified macro. |
|
Parameters |
|
<n> |
Numeric. Number of the macro that is stored in the PNA. To find the number of a macro, either open the Macro Setup dialog and count the line number of the desired macro, or query the titles of all of the macros for the desired macro title. |
<string> |
The name to be assigned to the macro. |
Examples |
SYST:SHOR1:TITL "Guided 4-Port Cal" |
Query Syntax |
SYSTem:SHORtcut<n>:TITLe? |
Not Applicable |
SYSTem:TIME?
(Read-only) Returns the system time. |
|
Parameters |
None |
Example |
SYST:TIME? |
Return Type |
Comma separated numbers representing hours, minutes, seconds. |
Not applicable |
SYSTem:TOUChscreen[:STATe] <bool>
(Read-Write) Enables and disables the PNA-X touchscreen. This setting remains until changed again from the front-panel or remotely, or until the hard drive is changed or reformatted. |
|
Parameters |
|
<bool> |
Choose from: ON (1) Enables the touchscreen. OFF (0) Disables the touchscreen. |
Examples |
SYST:TOUC
1 |
Query Syntax |
SYSTem:TOUChscreen[:STATe]? |
Return Type |
Boolean |
ON when shipped from factory. |
SYSTem:WINDows:CATalog?
(Read-only) Returns the window numbers that are currently being used. |
|
Examples |
SYST:WIND:CAT? system:windows:catalog? |
Return Type |
String of comma-separated numbers. For example: "1,2" |
Not Applicable |
Last modified:
17-Mar-2014 |
Added note to Abort thres |
7-Feb-2014 |
Changed Active commands to return 0 or "". (A.09.90.10) Moved communicate commands. |
15-Nov-2013 |
Fixed couple in tree |
29-Apr-2013 |
Removed reference to 12 macros |
6-Aug-2012 |
Fixed Meas:CAT and windows cat? |
23-Mar-2012 |
Added Cal All |
24-Jan-2012 |
Updated PSENsor command with 'any'. |
5-Jan-2012 |
Added 6.0 CPU to list |
26-Oct-2011 |
Added Abort command |
11-Jan-2011 |
Minor edit |
4-Nov-2010 |
Security for external sources (9.33) |
14-Oct-2010 |
Added note to PMET:CAT? |
16-Sep-2010 |
Added channel delete (A.09.30) |
9-Apr-2010 |
Added Preset note to 'unleveled' command |
30-Nov-2009 |
Added Help About read commands(9.1) |
30-Jul-2009 |
Added syst:conf:edev and RTOF (9.0) |
24-Feb-2009 |
Added Chan:Coup; Replaced True/False |
4-Nov-2008 |
Added FIFO (8.33) |
30-Oct-2008 |
Added several meas/trace/window query commands (8.33.x) |
29-Sep-2008 |
Removed rev from Psensor example |
17-Sep-2008 |
Added Syst:Pres vs *RST note |
28-Aug-2008 |
Updated Launch Cal Wiz command |
11-Feb-2008 |
Added Noise switch preference (8.2) |
5-Feb-2007 |
Added Extra security and USB power meter commands |
23-Feb-2007 |
Added touchscreen command |
15-Nov-2006 |
Added Unleveled Error reporting |
31-Oct-2006 |
Added PSRTrace command |