Remote LAN Control

Last Updated: 2011-06-23

This topic contains information on:

Remote LAN Control Description

The remote LAN control feature allows you to interface to and control the Interactive Functional Test Software via TCP/IP. The controlling PC used to remotely control the Interactive Functional Test Software can be internal or external, providing it is inside any existing firewalls.

Note: If you are using a wireless bridge (Wireless Access Point), you will need a second LAN card in the client PC to establish a remote LAN connection as the wireless bridge creates a firewall.

Remote LAN control is designed to allow you to perform stress testing of your wireless device remotely, once you have verified the test plan works locally. Therefore, before controlling the Interactive Functional Test Software remotely, you must first configure your wireless device, create test steps (using the scripting tool) and verify that the test plans that you have created work properly. There are also remote LAN control parameters that must be configured in order for remote communication to be successful. See Remote LAN Control Parameters (in the Interactive Functional Test Software) for more details.

Remote LAN Control Parameters (in the Interactive Functional Test Software)

The settings for Remote LAN Control are located in the Configuration tab>>Remote LAN Control window. The following parameters must be configured to allow remote communication.

Enable remote LAN communication control - this box must be checked in order for the Interactive Functional Test Software to be controlled remotely. When you check this box, the Show remote LAN configuration icon () appears in the main toolbar. This icon will be red if there is not remote LAN connection and green () if there is a remote LAN connection. The Show remote LAN configuration icon (red or green) opens the Configuration tab>>Remote LAN Control window.
LAN port - this selects which LAN port to be used for remote communication.

Remote LAN Control API Commands

The remote LAN control API commands are organized into the following categories:

Stress members:

The following commands are all the possible remote settings that, if set locally, would be found in the Stress Testing tab of the Interactive Functional Test Software.

Command: AbortOnFailure (as a Property)

Description: This command aborts any test plan that is currently running is a failure occurs.

Example: N5970A.Stress.AbortOnFailure

Command: AbortTestPlan (as a Method)

Description: This command aborts any test plan that is currently running.

Example: N5970A.Stress.AbortTestPlan

Command: AutoGenerateSeedValue (as a Property)

Description: This command sets/queries whether the seed value will automatically be generated. If this command is False, the value of the manual seed setting is used. This command accepts Boolean values.

Example: N5970A.Stress.AutoGenerateSeedValue

Command: AutoGenLogFileName (as a Property)

Description: This command sets/queries whether an activity log file name will automatically be generated. Automatically generated file names are a time stamp with the format "mm_dd_yyyy_hh_mm_ss N5970A.log" (that is, month, day, year, hour, minute, second). This command accepts Boolean values.

Example: N5970A.Stress.AutoGenLogFileName

Command: AvailableTestPlans (as a Property)

Description: This command queries all the available test plans for the Current DUT and Current format and returns them as a comma separated list (if there are no test plans, nothing is returned). This is a read only command.

Example: N5970A.Stress.AvailableTestPlans

Command: ClearPostMessage (as a Method)

Description: This command clears the log comments.

Example: N5970A.Stress.ClearPostMessage

Command: CurrentTestPlan (as a Property)

Description: This command sets/queries the current test plan for the Current DUT and Current format. The valid settings for this command can be obtained by using the command AvailableTestPlans.

Example: N5970A.Stress.CurrentTestPlan

Command: FailureCount (as a Property)

Description: This command sets/queries the current test plan for the number of failures that have occurred.

Example: N5970A.Stress.FailureCount

Command: LogFileName (as a Property)

Description: This command sets/queries the activity log file name that is to be applied to the next activity log. If the file name is not changed, a new activity log will overwrite any activity log file that is already saved under that file name. This command only applies if AutoGenLogFileName is disabled.

Example: N5970A.Stress.LogFileName

Command: LogTestResults (as a Property)

Description:This command sets whether or not an activity log is taken during the stress test. This command accepts Boolean values. If this command is set to True, an activity log will start as soon as the test plan runs and will stop as soon as the test plan completes. The name of the activity log depends on the AutoGenLogFileName setting.

Example: N5970A.Stress.LogTestResults

Command: ManualSeed (as a Property)

Description: This command allows you to set/query a manual seed value (rather than allowing the Interactive Functional Test Software to automatically generating it).

Example: N5970A.ManualSeed.PostMessage

Command: PostMessage (as a Property)

Description: This command allows you to add a log comment to the activity log. This is a write only command. The activity log will save a comment up to ten lines long.

Example: N5970A.Stress.PostMessage

Command: RunTestPlan (as a Method)

Description: This command runs the Current test plan, which is set using CurrentTestPlan.

Example: N5970A.Stress.RunTestPlan

Command: TestPlanRepeats (as a Property)

Description: This command sets/queries the number of Test plan repeats. The maximum number of repeat times is 1000.

Example: N5970A.Stress.TestPlanRepeats

MUI members:

The following commands affect the focus of the Interactive Functional Test Software's manual user interface (MUI).

Command: HideApplication (as a Method)

Description: This command hides the Interactive Functional Test Software.

Example: N5970A.MUI.HideApplication

Command: ShowApplication (as a Method)

Description: This command gives focus to the Interactive Functional Test Software.

Example: N5970A.MUI.ShowApplication

DUT members:

The following commands allow you to set the wireless device (DUT) name and format.

Command: AvailableDUTFormats (as a Property)

Description: This command queries the available formats for the Current DUT (CurrentDUTName). This is a read only command.

Example: N5970A.DUT.AvailableDUTFormats

Command: AvailableDUTNames (as a Property)

Description: This command queries the list of wireless devices you have configured. This is a read only command.

Example: N5970A.DUT.AvailableDUTNames

Command: CurrentDUTFormat (as a Property)

Description: This command sets/queries the format applied to the selected wireless device (Current DUT Name).

Example: N5970A.DUT.CurrentDUTFormat

Command: CurrentDUTName (as a Property)

Description: This command sets/queries which wireless device (in the AvailableDUTNames) to test.

Example: N5970A.DUT.CurrentDUTName

Application Information members:

The following command requests information about the Interactive Functional Test Software properties.

Command: Revision (as a Property)

Description: This command queries the application revision. This is a read only command.

Example: N5970A.ApplicationInfo.Revision

Power Supply members:

The following commands control the power supply.

Command: PowerSupplyAvailable (as a Property)

Description: This command checks if there is a power supply defined. This is a read only command.

Example: N5970A.PowerSupply.PowerSupplyAvailable

Command: TurnedOn (as a Property)

Description: This command sets/queries whether the power supply is on.

Example: N5970A.PowerSupply.TurnedOn

Status members:

The following commands read the status of various settings.

Command: ActivityLog (as a Property)

Description: This command queries the activity logging status. This is a read only command.

Example: N5970A.Status.ActivityLog

Command: Cell (as a Property)

Description: This command queries the cell status. This is a read only command.

Example: N5970A.Status.Cell

Command: InstrumentLa (as a Property)

Description: This command queries the instrument status. This is a read only command.

Example: N5970A.Status.InstrumentLa

Command: Modem (as a Property)

Description: This command queries the modem status. This is a read only command.

Example: N5970A.Status.Modem

Command: ScriptRunning (as a Property)

Description: This command queries the script status. This is a read only command.

Example: N5970A.Status.ScriptRunning

Command: WPALog (as a Property)

Description: This command queries the WPA logging status. This is a read only command.

Example: N5970A.Status.WPALog

Email members:

The following commands apply to the e-mail properties.

Command: AttachActivityLog (as a Property)

Description: This command sets/queries whether to attach the most recent activity log to each email.

Example: N5970A.Email.AttachActivityLog

Command: Copy (as a Property)

Description: This command set/queries what e-mail addresses to send a carbon copy of the e-mail.

Example: N5970A.Email.Copy

Command: FromName (as a Property)

Description: This command sets/queries the e-mail address that is displayed in the From field of the email.

Example: N5970A.Email.FromName

Command: Header (as a Property)

Description: This command sets/queries the email message body.

Example: N5970A.Email.Header

Command: SendAllStepsDone (as a Property)

Description: This command sets/queries whether an email message is sent when all test plan steps are complete.

Example: N5970A.Email.SendAllStepsDone

Command: SendCurrentStepDone (as a Property)

Description: This command sets/queries whether an email message is sent when each test plan step is complete.

Example: N5970A.Email.SendCurrentStepDone

Command: SendOnFailure (as a Property)

Description: This command sets/queries whether an email message is sent when a failure occurs in the test plan.

Example: N5970A.Email.SendOnFailure

Command: Server (as a Property)

Description: This command sets/queries the email server.

Example: N5970A.Email.Server

Command: Subject (as a Property)

Description: This command sets/queries the email subject line.

Example: N5970A.Email.Subject

Command: ToName (as a Property)

Description: This command sets/queries the e-mail address that the e-mail is sent to.

Example: N5970A.Email.ToName

Connection Integrity members:

The following commands can read the field or control the buttons in the Configuration tab>>Connections Integrity screen.

Command: ReadApps (as a Property)

Description: This command reads the status fields for MMS transfer and UDP in the the Interactive Functional Test Software area of the Configuration tab>>Connections Integrity screen. This is a read only command. Since this command simply reads the fields, it is recommended that you refresh the field before reading them. To refresh the fields, use the StartApps member.

Example: N5970A.ConnectionIntegrity.ReadApps

Command: ReadLAN (as a Property)

Description: This command reads the LAN Topology status fields for the Router, Test Set, Bridge, and Server (whether or not they are connected) and returns them in a comma separated list. This is a read only command.

Example: N5970A.ConnectionIntegrity.ReadLAN

Command: ReadServers (as a Property)

Description: This command reads the status of all the servers used by the Interactive Functional Test Software including FTP, SMS/MMS, and HTTP. This is a read only command.

Example: N5970A.ConnectionIntegrity.ReadServers

Command: ReadTestSet (as a Property)

Description: This command reads all the fields in the Test Set 1 Configuration area of the Configuration tab>>Connections Integrity screen. This is a read only command.

Example: N5970A.ConnectionIntegrity.ReadTestSet

Command: StartApps (as a Method)

Description: This command is equivalent to pressing the Check All Apps button on the Configuration tab >> Connections Integrity screen. The data can be queried using the ReadApps command.

Example: N5970A.ConnectionIntegrity.StartApps

Command: StartLAN (as a Method)

Description: This command is equivalent to pressing the Check All LANs button on the Configuration tab >> Connections Integrity screen. The data can be queried using the ReadLAN command.

Example: N5970A.ConnectionIntegrity.StartLAN

Command: StartServers (as a Method)

Description: This command is equivalent to pressing the Check All Servers button on the Configuration tab >> Connections Integrity screen. The data can be queried using the ReadServers command.

Example: N5970A.ConnectionIntegrity.StartServers

Command: StartTestSet (as a Method)

Description: This command is equivalent to pressing the Refresh Test Set Config button on the Configuration tab >> Connections Integrity screen. The data can be queried using the ReadTestSet command.

Example: N5970A.ConnectionIntegrity.StartTestSet

Creating a Remote LAN Control Program

If you need to control the Interactive Functional Test Software remotely, then you will need to write a program to do so.

There are several ways that you can test remote LAN control commands one line at a time. Although these are not practical environments to build a program, they are useful for becoming familiar with the commands that are available to you. This section explains two options. One is a program included in the the Interactive Functional Test software package. This is can be accessed by clicking Start >> Programs >> Agilent Interactive Functional Test >> Examples >> Remote Client Application called the Agilent N597X Remote Client. The other is by using HyperTerminal.

The Remote LAN Control feature requires that you have a second LAN card installed in the PC running the Interactive Functional Test Software to bypass the Interactive Functional Test system's firewall.

To establish a remote LAN connection using the Agilent N597XRemote Client:

Note: This procedure assumes that the Remote LAN Control Parameters have been configured.

Once the N5970ARemoteClient.exe. is opened, type the IP address or computer name of the PC running the Interactive Functional Test Software in the IP field. If the PC running the Interactive Functional Test Software is the same PC you want to establish a remote LAN connection with, you can enter localhost.
Click Connect. If successful, the Show remote LAN configuration icon () will change from red to green ().
Type a remote LAN control command in the field above the Send button. See Remote LAN Control Commands for a complete list of commands that the Interactive Functional Test Software accepts. Also, if you type a question mark, ?, in the command line and then click send, the response window will display the complete list of commands.
Click Send. Any response from the program is displayed in the lower window. Commands that set/query multiple parameters are set or displayed in the response window as a comma separated list.

You can clear the contents of the lower window by clicking Clear.

To establish a remote LAN connection using HyperTerminal: