Polycom ViewStation EX - Manuals

Page 2 - Trademark Information; Patent Information

Trademark Information Polycom®, the Polycom logo design, and ViewStation® are registered trademarks of Polycom Inc. ARENA™, Global Management System™, PathNavigator™, Polycom OneDial™, and Visual Concert™ are trademarks of Polycom, Inc. in the United States and various other countries. Internet Expl...

Page 3 - Contents

© Polycom, Inc. 2003 i Contents ........................................................................................................... i What’s New in Release 5.0? ............................................................................ 2 Accessing the API Interface ...........................

Page 10 - The following table lists the major changes for Release 5.0.; camera near; commands need; button near

ViewStation EX, ViewStation FX, and VS4000 API Guide 2 www.polycom.com What’s New in Release 5.0? The following table lists the major changes for Release 5.0. Type of Command Command Change system allowmixedcalls new command audioqualityg7221 new command camera near move When you are not in a call: ...

Page 11 - Accessing the API Interface; Using Telnet

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 3 Accessing the API Interface Using Telnet To start a Telnet session from Windows:1. From your computer desktop, click Start and Run . 2. In the Run window, enter the following information in the Open field: telnet <system ...

Page 12 - panel of the VS4000 system.; ViewStation EX and ViewStation FX; back panel of the system.; Starting a Communications Session; select

ViewStation EX, ViewStation FX, and VS4000 API Guide 4 www.polycom.com 1. Locate the RS-232 serial cable (DB9-to-DB9 straight through). 2. Connect one end of the cable to the serial port of your PC. 3. Connect the other end to the RS-232 serial port on the back panel of the VS4000 system. ViewStatio...

Page 13 - RS-232 Interface Information; RS-232 User Interface Screen; System; Baud Rate

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 5 RS-232 Interface Information The following provides additional information about the ViewStation EX, ViewStation FX, and VS4000 systems’ RS-232 interface. RS-232 User Interface Screen The RS-232 user interface screen is used...

Page 14 - The following information describes; Note; —If the near site is set to

ViewStation EX, ViewStation FX, and VS4000 API Guide 6 www.polycom.com • Pass-Thru Mode to Pass-Thru Mode: Both endpoints are set to Pass-Thru Mode. • Pass-Thru Mode to Control Mode: The near site is set to Pass-Thru Mode and the far site is set to Control Mode. Operational Modes: The following info...

Page 15 - Flow Control; Resulting Operation

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 7 control the far site system, using the far site’s Command Line Interface. The following table summarizes the port operation based on the RS-232 mode configured by each endpoint. Flow Control The system support hardware flow ...

Page 16 - Pin Number

ViewStation EX, ViewStation FX, and VS4000 API Guide 8 www.polycom.com RS-232 Serial Cable Pinout and Connections (ViewStation EX and FX) The RS-232 serial cable has a 9-pin DB-9 connector on one end and an 8-pin mini-DIN connector on the other end. It is used to connect the ViewStation EX or ViewSt...

Page 18 - Status Display; Using the “listen” or “dial” Command

ViewStation EX, ViewStation FX, and VS4000 API Guide 10 www.polycom.com Status Display The call status can be displayed in a number of ways. The display call status command shows table of current calls. Using the “listen” or “dial” Command To display real-time status on individual B channels (incomi...

Page 21 - Syntax Summary; gabpassword set MyPassword

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 13 Syntax Summary The following syntactic notation is used for the API shell control commands. Note All defined commands are case sensitive. <x> A required parameter. The text between the angled brackets is one or more p...

Page 22 - compound name; About the “get” Subcommand; get; Example 1; Response; gmscountry; Example 2; Response; gmscountry

ViewStation EX, ViewStation FX, and VS4000 API Guide 14 www.polycom.com If the string parameter contains a compound name or spaces, use quotation marks, as in the following examples: gabpassword set "My FX Password" gabpassword set "111 222 333" {a..b} A number ranging from a to b. A...

Page 23 - System Commands; Description; history; from the history list.; There is no space between the; Example; The following is a Telnet session sample:

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 15 System Commands This section describes each shell command and its parameters. All commands are listed with their parameters spelled out. !<“str”|{1..64}> Description This command allows you to execute a previously use...

Page 24 - Subcommands; abk

ViewStation EX, ViewStation FX, and VS4000 API Guide 16 www.polycom.com gatewaynumber set 123456789 gatewaynumber 123456789 restart system for changes to take effect. restart now? <y,n> ->!2 hangup video hanging up video call ->!h hangup video hanging up video call ->!hi history 1 gat...

Page 25 - batch; Examples; abk batch 0; password; adminpassword

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 17 abk allabk letter <{a..z}>abk range <{a..b}> Description This command displays local Address Book entries. batch Displays a batch of 10 records. The maximum number of batches that can be displayed is 59. all Dis...

Page 26 - want to erase the current setting, omit the; adminpassword set MyFXpsswd; User Interface Screen Location; advnetstats

ViewStation EX, ViewStation FX, and VS4000 API Guide 18 www.polycom.com Note This command cannot be accessed through the RS-232 port. set Sets the password used for remote management of the system if followed by the password parameter. If you want to erase the current setting, omit the password para...

Page 27 - Sample Output

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 19 Examples advnetstats advnetstats 1 Sample Output call:1 tar:24k rar:24k tvr:64.3k rvr:104k tvru:63.8k rvru:114.6k tvfr:15.0 rvfr:15.0 vfe --- tapl:66 rapl:0 taj:46mS raj:40mS tvpl:122 rvpl:0 tvj:21mS rvj:60mS dc:--- rsid:Po...

Page 28 - yes; allowabkchanges get; allowabkchanges

ViewStation EX, ViewStation FX, and VS4000 API Guide 20 www.polycom.com tmlpr Transmit MLP rate (H.320 calls only) rvj Receive video jitter (H.323 calls only) rmlpr Receive MLP rate (H.320 calls only ) dc Data conference rsid Remote system id User Interface Screen Location System Info>Diagnostics...

Page 29 - allowdialing get; allowdialing

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 21 allowdialing <yes|no|get> Description This command enables or disables the Allow Dialing option. yes Allows users to place calls. no Disables dialing. Your system can only receive calls. get Displays the current setti...

Page 30 - allowmixedcalls yes; allowremotemon get; allowremotemon

ViewStation EX, ViewStation FX, and VS4000 API Guide 22 www.polycom.com Example allowmixedcalls yes User Interface Screen Location System Info>Admin Setup>Video Network > Call Preferences: Allow H.320 and H.323 Mixed Calls allowremotemon <get> Description This command displays the cur...

Page 31 - allowusersetup yes; This command answers incoming video or POTS calls.; phone; Answers incoming POTS calls.; video; answer phone; answer

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 23 Example allowusersetup yes User Interface Screen Location System Info>Admin Setup>General Setup (page 2-Next): Allow User Setup answer <phone|video> Description This command answers incoming video or POTS calls....

Page 32 - Displays the current threshold value of the call.; Displays the current threshold value of the call.

ViewStation EX, ViewStation FX, and VS4000 API Guide 24 www.polycom.com set Sets the call speed threshold value. Requires a parameter from <64|112|128|168|192|224|256|280| 320|336|384|392|448|512>. get Displays the current threshold value of the call. 64..512 Range of selectable speeds. Exampl...

Page 33 - autoanswer donotdisturb; autoanswer

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 25 Example audioqualityg7221 set 256 User Interface Screen Location System Info>Admin Setup>Phone/Audio: Audio Quality autoanswer <yes|no|donotdisturb|get> Description This command sets the Auto Answer Point to Poi...

Page 34 - This command enables or disables the Auto Discover NAT option.; Displays the current setting (; or; autodiscovernat yes; autodiscovernat

ViewStation EX, ViewStation FX, and VS4000 API Guide 26 www.polycom.com autodiscovernat <yes|no|get> Description This command enables or disables the Auto Discover NAT option. yes Enables the option to automatically assign the WAN IP address that is used to place and receive calls outside the ...

Page 35 - backlightcompensation no; backlightcompensation

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 27 get Displays the current setting ( yes or no ). Example autoh323dialing yes User Interface Screen Location System Info>Admin Setup>LAN/H.323>H.323>Setup: Auto H.323 Dialing backlightcompensation <yes|no|get&g...

Page 36 - auto; button

Page 38 - Sends the Zoom in key to the user interface.; This command sends the up arrow command to the user interface.; This valid command combines the following commands:; both; Displays the selected call types.; callpreference

ViewStation EX, ViewStation FX, and VS4000 API Guide 30 www.polycom.com zoom+ Sends the Zoom in key to the user interface. zoom- Sends the Zoom out key to the user interface. Example 1 button up This command sends the up arrow command to the user interface. Example 2 button near left right callhangu...

Page 39 - Disables the register mode.; Displays the selected call state mode (; register; unregister; callstate register; Output to Example; callstate registered; callstate

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 31 callstate <register|unregister|get> Description This command registers the Telnet or RS-232 session to receive notifications about call state activities. register Registers the system to give notification of call acti...

Page 40 - When you are not in a call, all; camera near move; commands need to be preceded by a; Near camera direction change (start zooming; camera

ViewStation EX, ViewStation FX, and VS4000 API Guide 32 www.polycom.com camera <near|far|register|unregister> Subcommands camera near <{1..4}|source|move|stop|getposition| setposition|tracking>camera far <{1..5}|source|move|stop|tracking>camera <near|far> sourcecamera <nea...

Page 43 - camera far 2; camera1ptz yes; camera1ptz

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 35 Example 1 camera far 2 This command causes the remote terminal to begin sending its camera 2. Example 2 camera far move left This command causes the far camera to start panning to the left. Example 3 camera near move zoom+ ...

Page 44 - camera4ptz get; camera4ptz

ViewStation EX, ViewStation FX, and VS4000 API Guide 36 www.polycom.com camera4ptz <yes|no|get> Description This command sets camera source 4 to pan-tilt-zoom mode. This command is specific to the VS4000 system. Note See the command camerainput on page 37 to set your VS4000 camera source to S-...

Page 45 - cameradirection normal; camerainput

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 37 Example cameradirection normal User Interface Screen Location System Info>Admin Setup>Video/Camera>Cameras: Camera Direction camerainput <1|2|3|4> <off|s-video| composite|get> camerainput 1 <off|s-vi...

Page 46 - camerainput 1 s-video; chaircontrol

ViewStation EX, ViewStation FX, and VS4000 API Guide 38 www.polycom.com Example 1 camerainput 1 s-video Example 2 camerainput 4 get Output to Example 2 camerainput 4 off User Interface Screen Location System Info>Admin Setup>Video/Cameras>Cameras>VS4000 Camera Setup: Primary Camera chair...

Page 48 - This command turns the diagnostic color bars on or off.; on; Turns on the color bars.; off; Turns off the color bars.; colorbar on; your locatio; Displays the current setting.; country set; colorbar

ViewStation EX, ViewStation FX, and VS4000 API Guide 40 www.polycom.com colorbar <on|off> Description This command turns the diagnostic color bars on or off. on Turns on the color bars. off Turns off the color bars. Example colorbar on User Interface Screen Location System Info>Diagnostics&...

Page 49 - country set germany; No data conference type is selected.; dataconferencetype netmeeting; dataconferencetype

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 41 Note Use quotation marks around a compound name or strings containing spaces (Ex: “united states” or “111 222 333”). Examples country set germany country set “ united states “ User Interface Screen Location System Info>A...

Page 50 - daylightsavings yes; daylightsavings

ViewStation EX, ViewStation FX, and VS4000 API Guide 42 www.polycom.com daylightsavings <yes|no|get> Description This command sets the Global Management System daylight savings time. yes Enables daylight savings time. no Disables daylight savings time. get Displays the status of this option ( ...

Page 51 - dhcp client; dhcp

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 43 the current setting, omit the xxx.xxx.xxx.xxx parameter. get Displays the default gateway IP address. xxx.xxx.xxx.xxx Default gateway IP address. Example defaultgateway set 192.168.1.5 User Interface Screen Location System ...

Page 52 - dial

ViewStation EX, ViewStation FX, and VS4000 API Guide 44 www.polycom.com User Interface Screen Location System Info>Admin Setup>LAN/H.323>LAN/Intranet>LAN &Intranet: DHCP dial <addressbook|auto|manual|phone> dial addressbook <"addr book name">dial auto <speed>...

Page 53 - dial addressbook; dialchannels parallel; dialchannels

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 45 h323|h320|ip|isdn Type of call. The parameters ip and isdn are deprecated. phone Dials a POTS number. Requires the parameter dialstring . dialstring Valid POTS directory number. Note Use quotation marks around a compound na...

Page 54 - Sets the command. A priority level from the range; diffserv set 0; dir; This command lists flash files. No wild cards are allowed.; string; diffserv

ViewStation EX, ViewStation FX, and VS4000 API Guide 46 www.polycom.com diffserv <set|get><{0..63}> diffserv set <{0..63}>diffserv get Description This command lets you enable the DiffServ option and specify a number that represents a priority level for the Type of Service (Quality...

Page 55 - This command displays banner information.; display call

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 47 Note Use quotation marks around a compound name or strings containing spaces (Ex: “united states” or “111 222 333”). Examples dir dat dir abk dir display call Description This command displays call ID, status, speed, and th...

Page 56 - Ouput; dd; displaybolt 5; displaybolt

ViewStation EX, ViewStation FX, and VS4000 API Guide 48 www.polycom.com Ouput Hi, my name is: Jw_SystemHere is what I know about myself:Serial Number: xxxxxBrand: PolycomSoftware Version: Release 5.0 FX - 14 Mar 2003Model: VSFX4Network Interface: PRI_E1MP Enabled: YesH323 Enabled: YesIP Address: 192...

Page 57 - displayglobaladdresses yes; displaygraphics yes; displayglobaladdresses

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 49 displayglobaladdresses <yes|no|get> Description This command enables or disables the display of global addresses in the system’s Address Book. yes Enables the display of global addresses. no Disables the display of gl...

Page 58 - displayipext yes; displayipext

ViewStation EX, ViewStation FX, and VS4000 API Guide 50 www.polycom.com User Interface Screen Location System Info>Admin Setup>Video/Cameras>Monitors>TV Monitors: Display Icons in a Call displayipext <yes|no|get> Description This command enables or disables the display of the IP ex...

Page 59 - This command outputs the list of all the system settings.; displayparams

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 51 get Displays the current setting ( yes or no ). Example displayipisdninfo yes User Interface Screen Location System Info>Admin Setup>General Setup: Display My IP and ISDN Information displayparams Description This com...

Page 60 - dns

ViewStation EX, ViewStation FX, and VS4000 API Guide 52 www.polycom.com gmsurl 9 <empty> gmsurl 10 <empty> gmscontactperson <empty> gmscontactnumber <empty> gmscontactemail <empty> gmscontactfax <empty> gmstechsupport <empty> gmscity <empty> gmsstate &...

Page 61 - This option can only be set when DHCP is off.; dns get 4; dynamicbandwidth

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 53 Description This command is used to configure DNS servers (up to 4 DNS servers can be configured). After a change is made, the system prompts the user for restart. Note This option can only be set when DHCP is off. set <...

Page 62 - dynamicbandwidth yes; . If you want to erase the current

ViewStation EX, ViewStation FX, and VS4000 API Guide 54 www.polycom.com no Disables the option. get Displays the current setting ( on or off ). Example dynamicbandwidth yes User Interface Screen Location System Info>Admin Setup>LAN/H.323>QOS: Dynamic Bandwidth e164ext <set|get> ["...

Page 63 - restart system for changes to take effect. Restart; Gateway; not; echocanceller yes; echocanceller

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 55 Response e164ext <empty> restart system for changes to take effect. Restart now? <y, n> User Interface Screen Location System Info>Admin Setup>LAN/H.323>H.323>Gateway: Gateway Number>Extension ech...

Page 64 - enablesnmp yes; enablesnapshots

ViewStation EX, ViewStation FX, and VS4000 API Guide 56 www.polycom.com enablesnmp <yes|no|get> Description This command enables or disables the ability to take or send snapshots . This option is enabled by default. yes Enables the option. no Disables the option. get Displays the current setti...

Page 65 - exit; farcontrolnearcamera yes; exit

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 57 User Interface Screen Location System Info>Admin Setup>LAN/H.323>SNMP: Enable SNMP exit Description This command ends an API command session. Example exit farcontrolnearcamera <yes|no|get> Description This co...

Page 66 - farloop on; farloop

ViewStation EX, ViewStation FX, and VS4000 API Guide 58 www.polycom.com farloop <on|off> Description This command turns the far-end loop on or off, when in a call. on Turns the option on. off Turns the option off. Example farloop on User Interface Screen Location System Info>Diagnostics>...

Page 67 - farnametimedisplay set; System Info>User Setup: Far Site Name Display; This command displays Global Address Book entries in batches.; gabk batch 9; Displays the current GAB password.; gabk batch

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 59 Examples farnametimedisplay set farnametimedisplay set 120 User Interface Screen Location System Info>User Setup: Far Site Name Display gabk batch <{0..59}> Description This command displays Global Address Book ent...

Page 68 - gabpassword set gabPass; gabserverip

ViewStation EX, ViewStation FX, and VS4000 API Guide 60 www.polycom.com password Password used to access the GAB server. Valid characters are: a through z (lower and uppercase), -, _, @, /, ;, ,, ., \, 0 through 9. Note Use quotation marks around a compound name or strings containing spaces (Ex: “un...

Page 69 - gatekeeperip

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 61 User Interface Screen Location System Info>User Setup>LAN/H.323>Global Address>Server: Server IP Address gatekeeperip <set|get> ["xxx.xxx.xxx.xxx"] gatekeeperip set ["xxx.xxx.xxx.xxx"]gatek...

Page 70 - gatewayareacode set 512; gatewayareacode set; gatewayareacode

ViewStation EX, ViewStation FX, and VS4000 API Guide 62 www.polycom.com gatewayareacode <set|get> ["areacode"] gatewayareacode set ["areacode"]gatewayareacode set gatewayareacode get Description This command sets the gateway area code. set Sets the area code when followed by th...

Page 71 - This command sets the gateway country code.; gatewaycountrycode set 1; gatewaycountrycode

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 63 gatewaycountrycode <set|get> ["number"] gatewaycountrycode set ["number"]gatewaycountrycode setgatewaycountrycode get Description This command sets the gateway country code. set Sets the gateway countr...

Page 72 - parameter. If you want to erase; gatewayext set; gatewayext

ViewStation EX, ViewStation FX, and VS4000 API Guide 64 www.polycom.com gatewayext <set|get> ["gateway extension"] gatewayext set ["gateway extension"]gatewayext setgatewayext get Description This command sets the gateway extension number. You need to restart the system for cha...

Page 73 - gatewaynumber set; gatewaynumber

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 65 gatewaynumber <set|get> ["number"] gatewaynumber set ["number"]gatewaynumber setgatewaynumber get Description This command sets the gateway number. set Sets the gateway number when followed by the numb...

Page 74 - did; gatewaynumbertype number+extension; gatewaynumbertype

ViewStation EX, ViewStation FX, and VS4000 API Guide 66 www.polycom.com gatewaynumbertype <did|number+extension|get> Description This command specifies the Gateway Number Type. It can be either Direct Inward Dial (DID) or Number + Extension. did The number of digits in the DID is that portion ...

Page 75 - valid speed; Sets the gateway prefix when followed by the; gatewayprefix

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 67 gatewayprefix <set|get>< " valid speed " > [ " value " ] gatewayprefix set <"valid speed"> ["value"]gatewayprefix set <"valid speed"> gatewayprefix get <...

Page 76 - This command lists all the available speeds at once.; Output; gatewaysetup

ViewStation EX, ViewStation FX, and VS4000 API Guide 68 www.polycom.com Example gatewayprefix set 168 90 User Interface Screen Location System Info>Admin Setup>LAN/H.323>H.323>Gateway (page 2): Prefix gatewaysetup Description This command lists all the available speeds at once. Example g...

Page 77 - Sets the gateway suffix when followed by the; gatewaysuffix

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 69 gatewaysuffix <set|get><"valid speed"> ["value"] gatewaysuffix set <"valid speed"> ["value"]gatewaysuffix set <"valid speed">gatewaysuffix get <"valid s...

Page 78 - This command generates DTMF dialing tones to POTS line.; Turns on the test tone.; Turns off the test tone.; gendial

ViewStation EX, ViewStation FX, and VS4000 API Guide 70 www.polycom.com Example gatewaysuffix set 192 11 User Interface Screen Location System Info>Admin Setup>LAN/H.323>H.323>Gateway (page 2): Suffix gendial [{0..9|#|*}] Description This command generates DTMF dialing tones to POTS line...

Page 79 - get screen; Output Example; CGenToneScreen; This command sets the GMS city information.; get screen

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 71 get screen Description This command returns the name of the current screen. It is intended to let the control panel programmer know which screen the user interface is currently displaying. Example get screen Output Example ...

Page 80 - gmscity set Paris; This command sets the GMS contact E-mail information.; gmscontactemail set [email protected]; Info 1: Contact Email; gmscontactemail

ViewStation EX, ViewStation FX, and VS4000 API Guide 72 www.polycom.com Example gmscity set Paris User Interface Screen Location System Info>Admin Setup>LAN/H.323>Global Management> Info 1: City gmscontactemail <set|get> ["email"] gmscontactemail set ["email"]gmscon...

Page 81 - This command sets the GMS contact fax information.; gmscontactfax

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 73 gmscontactfax <set|get> ["fax"] gmscontactfax set ["fax"]gmscontactfax setgmscontactfax get Description This command sets the GMS contact fax information. set Sets the GMS contact fax information when ...

Page 82 - gmscontactnumber set; gmscontactnumber

ViewStation EX, ViewStation FX, and VS4000 API Guide 74 www.polycom.com gmscontactnumber <set|get> ["number"] gmscontactnumber set ["number"]gmscontactnumber setgmscontactnumber get Description This command sets the GMS contact number information. set Sets the GMS contact numbe...

Page 83 - gmscontactperson set; gmscontactperson

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 75 gmscontactperson <set|get> ["person"] gmscontactperson set ["person"]gmscontactperson setgmscontactperson get Description This command sets the GMS contact person information. set Sets the GMS contact ...

Page 84 - This command sets the GMS country information.; gmscountry set Argentina

ViewStation EX, ViewStation FX, and VS4000 API Guide 76 www.polycom.com gmscountry <set|get> ["country"] gmscountry set ["country"]gmscountry set gmscountry get Description This command sets the GMS country information. set Sets the GMS country information when followed by the ...

Page 85 - This command sets the GMS state information.; Sets the GMS state information when followed by the; parameter. If you want to erase the current; Displays the current state information.; state; Character string specifying the state information.; gmsstate set Texas; gmsstate

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 77 gmsstate <set|get> ["state"] gmsstate set ["state"]gmsstate set gmsstate get Description This command sets the GMS state information. set Sets the GMS state information when followed by the state param...

Page 86 - gmstechsupport set; gmstechsupport

ViewStation EX, ViewStation FX, and VS4000 API Guide 78 www.polycom.com gmstechsupport <set|get> ["tech support digits"] gmstechsupport set ["tech support digits"]gmstechsupport setgmstechsupport get Description This command sets the GMS technical support phone number informati...

Page 87 - parameter. If you want to; must be; gmsurl get 1; Output to Example 2; gmsurl

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 79 gmsurl <set|get> <{1..10}> ["xxx.xxx.xxx.xxx"] gmsurl set <{1..10}> ["xxx.xxx.xxx.xxx"]gmsurl set <{1..10}>gmsurl get <{1..10}> Description This command sets the URL of the GMS ...

Page 88 - graphicsmonitor fxvga; graphicsmonitor

ViewStation EX, ViewStation FX, and VS4000 API Guide 80 www.polycom.com User Interface Screen Location System Info>Admin Setup>LAN/H.323>Global Management> Setup>Select Server URLs... graphicsmonitor <tv|fxvga|visualconcert|get> Description This command sets the graphics monitor...

Page 89 - graphicsmonitorfxvga on; graphicsmonitorfxvga

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 81 graphicsmonitorfxvga <on|off|get> Description This command enables or disables the system’s VGA graphics monitor. on Enables the VGA monitor as the graphics monitor. Enable this option if you have a high-resolution VG...

Page 90 - graphicsmonitortv on; graphicsmonitorvisualconcert on; graphicsmonitorvisualconcert

ViewStation EX, ViewStation FX, and VS4000 API Guide 82 www.polycom.com off Disables the TV monitor as the graphics monitor. get Displays the current setting ( on or off ). Example graphicsmonitortv on User Interface Screen Location System Info>Admin Setup>Video/Camera>Monitors>Graphics ...

Page 91 - Sets the H.323 name when followed by the; Displays the current setting for this option.; My System

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 83 h323name <set|get> ["H.323name"] h323name set ["H.323name"]h323name seth323name get Description This command sets the H.323 name. set Sets the H.323 name when followed by the H.323name parameter. If yo...

Page 92 - hangup phone; hangup video 2; help; syntax; hangup

ViewStation EX, ViewStation FX, and VS4000 API Guide 84 www.polycom.com hangup <phone|video> hangup phonehangup video [{1..3}]hangup video Description This command hangs up a telephone or video call. phone Hangs up the current audio call. video Hangs up the current video call if no parameter f...

Page 93 - Displays detailed help for all commands.

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 85 all Displays detailed help for all commands. help Describes the various types of help described in this section. verbose Sets verbose mode: shows syntax and help for commands. terse Sets terse mode: shows only help for comm...

Page 94 - This command sets the high-resolution state for camera 2 or 3.; Enables high-resolution mode for the selected camera.; Displays the current state for the selected camera (; hires

ViewStation EX, ViewStation FX, and VS4000 API Guide 86 www.polycom.com Output to Example 2 (partial) ! abk adminpassword advnetstats allowabkchanges allowdialing allowmixedcalls allowremotemon allowusersetup answer audioquality audioqualityg7221 autoanswer autodiscovernat hires <{2|3}> <ye...

Page 96 - hostname

ViewStation EX, ViewStation FX, and VS4000 API Guide 88 www.polycom.com hostname <set|get> ["hostname"] hostname set ["hostname"]hostname sethostname get Description This command sets the LAN host name. This is the name assigned to the system for TCP/IP configuration and it can...

Page 97 - hostname set MySystem; hostname set; hostname ADMIN; ipaddress

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 89 invalid characters are removed from the system name to obtain a valid LAN host name. If the resulting string is empty, the default LAN host name is Admin. Example 1 hostname set MySystem Example 2 hostname set Output to Exa...

Page 98 - ipdialspeed

ViewStation EX, ViewStation FX, and VS4000 API Guide 90 www.polycom.com xxx.xxx.xxx.xxx IP address of the system. Example ipaddress set 192.168.1.111 User Interface Screen Location System Info>Admin Setup>LAN/H.323>LAN/Intranet> LAN & Intranet: IP Address ipdialspeed <set|get>&...

Page 99 - Sets the IP precedence. A priority level from the range; ipprecedence

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 91 Note Use quotation marks around a compound name or strings containing spaces (Ex: “united states” or “111 222 333”). Example ipdialspeed get 168 Output ipdialspeed 168 off User Interface Screen Location System Info>Admin...

Page 100 - LAN & Intranet: all information displayed on this screen; ipstat

ViewStation EX, ViewStation FX, and VS4000 API Guide 92 www.polycom.com ipstat Description This command outputs the same information that is displayed on the LAN & Intranet and Advanced LAN Settings screens: LAN host name, WINS resolution, DHCP, IP address, DNS servers 1-4, default gateway, subn...

Page 101 - Enables audio confirmation.; keypadaudioconf yes; keypadaudioconf

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 93 keypadaudioconf <yes|no|get> Description This command sets the keypad audio confirmation. When this option is enabled, an audio response is echoed when a numeric key is depressed on the remote control. yes Enables aud...

Page 102 - language set german; lanport auto; lanport

ViewStation EX, ViewStation FX, and VS4000 API Guide 94 www.polycom.com set Sets the command. It requires a parameter from <englishus, englishuk, french, german, italian, spanish, japanese, chinese, portuguese, norwegian>. get Displays the current language on the system. englishus, englishuk, ...

Page 103 - lanstat

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 95 User Interface Screen Location System Info>Admin Setup>LAN/H.323>LAN/Intranet> Advanced LAN Settings lanstat <min|misc|reset|sec|tmin|total> lanstat minlanstat min [{0..60}]lanstat misclanstat resetlanstat...

Page 104 - lanstat min 1; Output to Example 1; Port 0; lanstat misc; Miscellaneous LAN Counters:

ViewStation EX, ViewStation FX, and VS4000 API Guide 96 www.polycom.com 0..60 Maximum number of minutes that can be specified is 60. Example 1 lanstat min 1 Output to Example 1 lanstat: LAN statistics for minute -1 lanstat: Port 0 Port 1 lanstat: rx_bytes 985 0 lanstat: tx_bytes 351 0 lanstat: rx_pa...

Page 105 - listen sleep; listen sleep registered; listen

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 97 lanstat: Max tx iterations = 8 lanstat: Max rx iterations = 4 lanstat: Max interrupt iters = 3 lanstat: Total interrupts = 113137865 lanstat: Max interrupt delay = 441170 lanstat: Last interrupt delay = 214835 lanstat: end ...

Page 106 - listen waking up; maxgabinternationalcallspeed get; Displays the current valid speed.; maxgabinternationalcallspeed set 512; maxgabinternationalcallspeed

ViewStation EX, ViewStation FX, and VS4000 API Guide 98 www.polycom.com listen waking up Notification of event: the system is waking up. maxgabinternationalcallspeed <set|get> < " valid speed " > maxgabinternationalcallspeed get Description This command sets the maximum speed for...

Page 107 - valid; maxgabinternetcallspeed get; maxgabinternetcallspeed set 384; maxgabinternetcallspeed

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 99 maxgabinternetcallspeed <set|get> < " valid speed " > maxgabinternetcallspeed get Description This command sets the maximum speed for Internet (IP/H.323) calls made from the Global Address Book. set Sets...

Page 108 - maxgabisdncallspeed get; maxgabisdntcallspeed set 384; maxgabisdncallspeed

ViewStation EX, ViewStation FX, and VS4000 API Guide 100 www.polycom.com maxgabisdncallspeed <set|get> < " valid speed " > maxgabisdncallspeed get Description This command sets the maximum speed for ISDN (H.320) calls made from the Global Address Book. set Sets the maximum speed ...

Page 109 - . If you want to erase the; maxtimeincall set 180; System Info>Admin Setup>General Setup: Maximum Time in a Call; maxtimeincall

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 101 maxtimeincall <set|get> [{0..99999}] maxtimeincall set [{0..99999}]maxtimeincall setmaxtimeincall get Description This command sets the maximum number of minutes allowed for call length. When that time has expired in...

Page 110 - Use quotation marks around a compound name or strings; Note 2; ViewStation EX: this multipoint option is not available; This command sends the MCU password; mcupassword

ViewStation EX, ViewStation FX, and VS4000 API Guide 102 www.polycom.com mcupassword [{ " password " }] mcupassword Description This command sends the MCU password when the MCU prompts system for an MCU password. The Meeting Password can be configured as the multipoint MCU conference passwor...

Page 111 - This command sets the meeting password.; meetingpassword set EXpasswd; meetingpassword

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 103 meetingpassword <set|get> [ " password " ] meetingpassword set ["password"]meetingpassword setmeetingpassword get Description This command sets the meeting password. set Sets the meeting password when...

Page 112 - ViewStation EX User Guide; mpautoanswer donotdisturb; mpautoanswer

ViewStation EX, ViewStation FX, and VS4000 API Guide 104 www.polycom.com mpautoanswer <yes|no|donotdisturb|get> Description This command sets the Auto Answer Multipoint mode which determines how the system will handle an incoming call in a multipoint videoconference. yes If Auto Answer Multipo...

Page 113 - System Info>Admin Setup>General Setup: Auto Answer Multipoint; In Presentation mode (also called voice-activated; mpmode discussion; mpmode

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 105 User Interface Screen Location System Info>Admin Setup>General Setup: Auto Answer Multipoint --or-- System Info>User Setup: Auto Answer Multipoint mpmode <auto|discussion|presentation| fullscreen|get> Descri...

Page 114 - mute near on; mute

Page 115 - muteautoanswercalls yes; System Info>User Setup: Mute Auto Answer Calls; muteautoanswercalls

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 107 muteautoanswercalls <yes|no|get> Description This command sets the system to Mute Auto Answer Calls mode. When this option is selected, the microphone pod is turned off to prevent the far site from hearing the near s...

Page 116 - Disables the Near End Loop.; nearloop on; netmeetingip

ViewStation EX, ViewStation FX, and VS4000 API Guide 108 www.polycom.com off Disables the Near End Loop. Example nearloop on User Interface Screen Location System Info>Diagnostics>Near End Loop netmeetingip <set|get> ["xxx.xxx.xxx.xxx"] netmeetingip set ["xxx.xxx.xxx.xxx"...

Page 117 - netstats; netstats

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 109 netstats [{0..2}] netstats Description This command is used to get network statistics for each call. 0..2 Range of selectable calls in a multipoint call (maximum number of concurrent calls=3, where 0 is call #1, 1 is call ...

Page 118 - numdigitsdid 7; numdigitsdid

ViewStation EX, ViewStation FX, and VS4000 API Guide 110 www.polycom.com tcp transmit comm protocol rcp receive comm protocol User Interface Screen Location System Info>Diagnostics>Network Stats numdigitsdid <{0..24}|get> numdigitsdid <{0..24}>numdigitsdid get Description This comm...

Page 119 - Range of allowed digits.; numdigitsext 10; numdigitsext

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 111 numdigitsext <{0..24}|get> numdigitsext <{0..24}>numdigitsext get Description This command sets the number of digits in the Number+Extension Gateway number (E.164 dialing). The number of digits in that number i...

Page 120 - numberofmonitors 2; numberofmonitors

ViewStation EX, ViewStation FX, and VS4000 API Guide 112 www.polycom.com numberofmonitors <{1..4}|get> numberofmonitors <{1..4}>numberofmonitors get Description This command sets the number of TV monitors that are connected to the system. 1..4 Sets the number of monitors allowed. Maximum...

Page 121 - outboundcallroute gateway; Maximum length of pause is 65535 seconds.; pause 3; This command sets the PC port speed of the system.; pause

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 113 Example outboundcallroute gateway User Interface Screen Location System Info>Admin Setup>LAN/H.323>H.323>Gatekeeper: Outbound Call Route pause <0..65535> Description This command causes the command interp...

Page 122 - testlan ping; ping

ViewStation EX, ViewStation FX, and VS4000 API Guide 114 www.polycom.com 100 100 Mbps auto duplex. 100hdx 100 Mbps half duplex. 100fdx 100 Mbps full duplex. get Displays the current setting. Example pcport 100fdx User Interface Screen Location System Info>Admin Setup>LAN/H.323>LAN/Intranet&...

Page 123 - pip auto; pip

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 115 pip <on|off|auto|get> Description This command sets the on-screen PIP mode. The PIP feature allows the near site to adjust near-camera views while in a videoconference. on Enables PIP mode.The system shows a PIP wind...

Page 124 - switchnumber; fulldidnumber, switchnumber; preferredalias isdnnumber; Select this field to access the; preset

ViewStation EX, ViewStation FX, and VS4000 API Guide 116 www.polycom.com switchnumber Sends the Gateway Switch Number as the preferred alias. didextnumber Sends the DID Extension Number as the preferred alias. extension Sends the H.323 Extension Number (E.164) as the preferred alias. get Displays th...

Page 125 - Disables register mode.; preset near set 2; if the; primarycallchoice

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 117 This command sets the presets or goes to presets for the near or far camera source. It can also register or unregister the Telnet or RS-232 session to give notification when the user sets or goes to presets. You can set an...

Page 126 - primarycallchoice isdn; primarycamera 1; primarycamera

ViewStation EX, ViewStation FX, and VS4000 API Guide 118 www.polycom.com ip Selects IP as the Primary Call Type Choice. manual No call type is selected. get Displays the current setting ( isdn, ip , or manual ). Example primarycallchoice isdn User Interface Screen Location System Info>Admin Setup...

Page 127 - queuecommands yes; queuecommands

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 119 queuecommands <yes|no|get> Description This command allows the system to queue up commands that cannot be processed during call progress or popup window states (that is, when the system is showing the call progress s...

Page 128 - Disables this option.; from the preceding history list.; repeat

ViewStation EX, ViewStation FX, and VS4000 API Guide 120 www.polycom.com to the GAB, but does not appear in the Global Address Book of other systems. yes Enables this option (register this system). no Disables this option. get Displays the current setting ( yes or no ). Example registerthissystem ye...

Page 129 - You must use; requireacctnumtodial yes; Setup: Require Account Number to Dial; requireacctnumtodial

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 121 requireacctnumtodial <yes|no|get> Description This command enables or disables the Require Account Number to Dial option. It is used to log calls to a specific account so that they can be tracked and billed to the ap...

Page 130 - Sets the room phone number when followed by the; room phone number; roomphonenumber

ViewStation EX, ViewStation FX, and VS4000 API Guide 122 www.polycom.com roomphonenumber <set|get> ["room phone number"] roomphonenumber set ["room phone number"]roomphonenumber setroomphonenumber get Description This command lets you enter the number of the phone that is locat...

Page 131 - Displays the current mode setting (; rs232 flowcontrol hardware

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 123 rs232<mode|flowcontrol|baud|> Subcommands rs232 mode <passthru|control|get>rs232 flowcontrol <none|hardware|get>rs232 baud <1200| 2400|9600|14400|19200|38400| 57600|115200|get> Description This comm...

Page 132 - Goes to the Address Book screen.; run

ViewStation EX, ViewStation FX, and VS4000 API Guide 124 www.polycom.com User Interface Screen Location System Info>Admin Setup>Software/Hardware>RS-232 run < " scriptfilename " > Description This command loads a file from the flash file system and then executes the API comman...

Page 133 - screen sysinfo; secondarycallchoice isdn; secondarycallchoice

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 125 speeddial Goes to the Speed Dial screen. disableui Turns off the user interface. enableui Turns on the user interface. chaircontrol Goes to the main Chair Control screen. sleep Causes the system to go into sleep mode. wake...

Page 134 - serialnum; This command displays the serial number of the system.; sendonlypreferredalias

ViewStation EX, ViewStation FX, and VS4000 API Guide 126 www.polycom.com sendonlypreferredalias <yes|no|get> Description This command enables the option Send Only Preferred Alias. It allows you to select which E.164 alias to send to the gatekeeper. Any change forces a system reboot. yes Enable...

Page 135 - on page; account number; Number that is needed to validate the account; setaccountnumber

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 127 User Interface Screen Location System Info>Admin Setup>Software/Hardware>Software: System Serial Number setaccountnumber < " account number " > Description This command sets the account number that i...

Page 136 - Displays both ISDN and IP numbers in the GAB.; showaddrsingab both; Preferences: Show Addresses in Address Book; This command displays a popup message box in the user interface.; text to display; showpopup

ViewStation EX, ViewStation FX, and VS4000 API Guide 128 www.polycom.com both Displays both ISDN and IP numbers in the GAB. get Displays the current setting ( h320 , h323 , or both ). Example showaddrsingab both User Interface Screen Location System Info>Admin Setup>LAN/H.323>Global Address...

Page 137 - sleep; ViewStation FX/VS4000 User Guide; sleep

Page 138 - slides select presPC; snapshot

ViewStation EX, ViewStation FX, and VS4000 API Guide 130 www.polycom.com list List all loaded presentations (displays names and IP addresses) available for viewing. The names are the names of the PCs from which the presentations are loaded. select < " pres " > Selects slide presentatio...

Page 139 - Unregisters the Telnet or RS-232 session to receive; snapshot 1; snapshotcamera 1; snapshotcamera

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 131 3 Generates a snapshot from the near camera 3 (VCR). 4 Generates a snapshot from the near camera 4 (auxiliary camera). register Registers the Telnet or RS-232 session to receive notifications about snapshots that are sent ...

Page 140 - he remote control to return; snapshottimeout no; snapshottimeout

ViewStation EX, ViewStation FX, and VS4000 API Guide 132 www.polycom.com snapshottimeout <yes|no|get> Description This command enables or disables the Snapshot Timeout option. By default, all slides and snapshots are displayed for a period of four minutes. When the display times out after four...

Page 141 - This command sets the SNMP administrator name.; snmpadmin set; snmpadmin

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 133 snmpadmin <set|get> ["admin name"] snmpadmin set ["admin_name"]snmpadmin setsnmpadmin get Description This command sets the SNMP administrator name. set Sets the administrator name when followed by th...

Page 142 - This command sets the SNMP community name.; snmpcommunity set Public; snmpcommunity

ViewStation EX, ViewStation FX, and VS4000 API Guide 134 www.polycom.com snmpcommunity <set|get> ["community name"] snmpcommunity set ["community name"]snmpcommunity setsnmpcommunity get Description This command sets the SNMP community name. set Sets the SNMP community name whe...

Page 143 - snmpconsoleip

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 135 snmpconsoleip <set|get> ["xxx.xxx.xxx.xxx"] snmpconsoleip set ["xxx.xxx.xxx.xxx"]snmpconsoleip set snmpconsoleip get Description This command sets the SNMP console IP address. set Sets the SNMP consol...

Page 144 - snmplocation set; soundeffectsvolume set 6; soundeffectsvolume

ViewStation EX, ViewStation FX, and VS4000 API Guide 136 www.polycom.com set Sets the SNMP location name when followed by the location name parameter. If you want to erase the current setting, omit the parameter. get Displays the current setting. location name SNMP location name. Note Use quotation ...

Page 145 - stdout on; start; stream start; stdout

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 137 User Interface Screen Location System Info>Admin Setup>Phone/Audio: Sound Effects Volume (select the Sound Effects Volume field. Adjust the volume setting by using the volume control buttons on the remote control). s...

Page 146 - Enables streaming announcement.; streamannounce yes; streamannounce

ViewStation EX, ViewStation FX, and VS4000 API Guide 138 www.polycom.com Note The Call Type icon is only visible on the main user interface screen if you have previously enabled Allow Streaming (System Info>AdminSetup>LAN/H.323>Streaming: Allow Streaming) streamannounce <yes|no|get> D...

Page 147 - stream audio; Sets the stream audio port when followed by the; streamaudioport

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 139 streamaudioport <set|get> [ " stream audio port " ] streamaudioport set ["stream audio port"]streamaudioport setstreamaudioport get Description This command sets the stream audio port. By default, the...

Page 148 - This command enables or disables streaming on the system.; streamenable yes; Sets the multicast IP address when followed by the; streamenable

ViewStation EX, ViewStation FX, and VS4000 API Guide 140 www.polycom.com streamenable <yes|no|get> Description This command enables or disables streaming on the system. yes Enables streaming. no Disables streaming. get Displays the current setting ( yes or no ). Example streamenable yes User I...

Page 149 - ip address; Multicast IP address.; streammulticastip get; Output Sample; streamrouterhops 1; streamrestoredefaults

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 141 get Displays the current setting. ip address Multicast IP address. Example streammulticastip get User Interface Screen Location System Info>Admin Setup>LAN/H.323>Streaming: IP Multicast Address streamrestoredefaul...

Page 150 - number router; Sets the number of routers when followed by the; number router hops; streamrouterhops set 1; streamrouterhops

ViewStation EX, ViewStation FX, and VS4000 API Guide 142 www.polycom.com streamrouterhops <set|get> [ " number router hops " ] streamrouterhops set ["number router hops"]streamrouterhops setstreamrouterhops get Description This command sets the number of routers you want the st...

Page 151 - streamspeed

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 143 streamspeed <192|256|384|512|get> Description This command sets the speed of the video stream . 192 Sets the streaming speed at 192 Kbps. 256 Sets the streaming speed at 256 Kbps. 384 Sets the streaming speed at 384 ...

Page 152 - subnetmask

ViewStation EX, ViewStation FX, and VS4000 API Guide 144 www.polycom.com set Sets the stream video port when followed by the video port parameter. If you want to erase the current setting, omit the parameter. get Displays the current setting. video port Video port number. Example streamvideoport 163...

Page 153 - systembehindnat yes; systembehindnat

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 145 systembehindnat <yes|no|get> Description This command sets the system behind a NAT (Network Address Translation) device. Select this option if your system is behind a NAT device that is not H.323 aware. If your syste...

Page 154 - Sets the system name. It must be followed by the; Displays the current system name.; system name; The name can be up to 34 characters in length.; systemname set MyOwnFX; systemname

ViewStation EX, ViewStation FX, and VS4000 API Guide 146 www.polycom.com systemname <set|get> ["system name"] systemname set ["system name"]systemname get Description This command sets the name of your system. The first character has to be a numeric (a digit) or alphabetical (a...

Page 155 - Sets the t120 name or IP address when followed by the

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 147 t120nameip <set|get> ["name or ip"] t120nameip set ["name or ip"]t120nameip set t120nameip get Description This command sets the t120 data conference name or IP address. The user is prompted for resta...

Page 156 - Displays the current TCP port setting.; tcpports

ViewStation EX, ViewStation FX, and VS4000 API Guide 148 www.polycom.com tcpports <set|get> [{1024..49150}] tcpports set [{1024..49150}]tcpports settcpports get Description This command sets the TCP ports for Quality of Service on your system. set Sets the TCP ports when followed by a value fr...

Page 157 - techsupport; teleareacode

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 149 phone num Phone number at which the user wants to be contacted. In order to obtain rapid assistance, include the area code with your phone number. Note Use quotation marks around a compound name or strings containing space...

Page 158 - Sets the telephone country code when followed by the; telecountrycode set 33; telecountrycode

ViewStation EX, ViewStation FX, and VS4000 API Guide 150 www.polycom.com Note Use quotation marks around a compound name or strings containing spaces (Ex: “united states” or “111 222 333”). Example teleareacode set 703 User Interface Screen Location System Info>Admin Setup>Phone/Audio: Area Co...

Page 159 - This command sets the system’s telephone number.; Sets the telephone number when followed by the; parameter. If you want to erase the; telephone number; System’s telephone number.; telenumber

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 151 telenumber <set|get> ["telephone number"] telenumber set ["telephone number"]telenumber settelenumber get Description This command sets the system’s telephone number. set Sets the telephone number whe...

Page 160 - This command displays miscellaneous DCU information.; testlan arp

ViewStation EX, ViewStation FX, and VS4000 API Guide 152 www.polycom.com testlan arp Description This command prints the ARP (Address Resolution Protocol) table contents. Example testlan arp testlan dcuinfo Description This command displays miscellaneous DCU information. Example testlan dcuinfo Outp...

Page 161 - This command looks up a domain name or an IP address.; name or ip; Domain name or IP address.; testlan dns

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 153 testlan dns <name or ip> Description This command looks up a domain name or an IP address. name or ip Domain name or IP address. Example 1 testlan dns microsoft.com Output to Example 1 testlan: microsoft.com is 207.4...

Page 163 - count

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 155 testlan: waiting 100000us for next message testlan: sent=30, received=0, lost=30, delayed=0, corrupt=0 testlan: waiting 100000us for next message testlan: sent=40, received=0, lost=40, delayed=0, corrupt=0 testlan: waiting...

Page 164 - text to input; ocal time of the managed; textinput

ViewStation EX, ViewStation FX, and VS4000 API Guide 156 www.polycom.com textinput <"text to input"> Description This command inserts text into a user interface edit box that you have already selected using the remote control. text to input Alphanumeric string to be inserted into the s...

Page 165 - typeofservice diffserv; typeofservice

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 157 User Interface Screen Location System Info>Admin Setup>LAN/H.323>Global Management> Setup: Time Difference from GMT typeofservice <ipprecedence|diffserv|get> Description This command selects the type of s...

Page 166 - usefixedports yes; usefixedports

ViewStation EX, ViewStation FX, and VS4000 API Guide 158 www.polycom.com Description This command sets the system’s UDP ports. set Sets the UDP ports when followed by a value from the range {1024..49150} . If you want to erase the current setting, omit the value. get Displays the current UDP port se...

Page 167 - This command selects the gatekeeper mode (; usegatekeeper specify; usegatekeeper

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 159 usegatekeeper <off|specify|auto|get> Description This command selects the gatekeeper mode ( off, specify or auto ). After a change, the user is prompted for system restart. Note A gatekeeper is not required to make I...

Page 168 - usepathnavigator required; usepathnavigator

ViewStation EX, ViewStation FX, and VS4000 API Guide 160 www.polycom.com usepathnavigator <always|never|required| get> Description This command selects the PathNavigator™ mode, if PathNavigator is used with the system. Because PathNavigator uses an MGC, it can handle videoconferences with more...

Page 170 - validateacctnum yes; validateacctnum

ViewStation EX, ViewStation FX, and VS4000 API Guide 162 www.polycom.com validateacctnum <yes|no|get> Description This command sets the validation for the GMS account number that is used when dialing out. When the call connects, the system verifies that the account exists with the Global Manag...

Page 171 - vcbutton play; Enables the option; vcraudioout yes; vcraudioout

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 163 register Registers the Telnet or RS-232 session to receive notifications about Visual Concert FX events. unregister Unregisters the Telnet or RS-232 session to receive notifications about Visual Concert FX events. Example ...

Page 172 - vcrrecordsource auto; version; vcrrecordsource

ViewStation EX, ViewStation FX, and VS4000 API Guide 164 www.polycom.com vcrrecordsource <auto|near|far|get> Description This command sets the VCR record source. auto Enables the VCR to automatically record the current speaker in a point-to-point call. near Enables the VCR to record the near-s...

Page 173 - vgahorizpos right; vgahorizpos

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 165 User Interface Screen Location System Info: Software Version vgahorizpos <left|right|get> Description This command is used to calibrate the VGA input in the horizontal position. left Sets the calibration frame to the...

Page 174 - vgaoffmode nosignal; This command is used to calibrate the VGA input phase.; vgaphase decrease; vgaphase

ViewStation EX, ViewStation FX, and VS4000 API Guide 166 www.polycom.com get Displays the current setting ( black or nosignal ) Example vgaoffmode nosignal User Interface Screen Location System Info>Admin Setup>Video/Cameras>Monitors>Graphics Monitor>FX VGA>Setup: VGA Output with N...

Page 175 - up; Moves the calibration frame up.; vgaresolution

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 167 vgaresolution <800x600|1024x768| 1280x1024|get> Description This command is used to set the system’s VGA output resolution. Select the maximum resolution that your monitor or projector can support. Consult the user m...

Page 176 - vgavertpos down; volume

ViewStation EX, ViewStation FX, and VS4000 API Guide 168 www.polycom.com down Moves the calibration frame down. get Displays the current setting ( up or down ). Example vgavertpos down User Interface Screen Location System Info>Admin Setup>Video/Cameras>VGA Input: Vertical Position This scr...

Page 177 - This command is useful within script files (see the; command on; callcomplete; waitfor callcomplete; waitfor

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 169 User Interface Screen Location Press the Volume UP or DOWN key on the remote control to see the audio level slider appear on screen. waitfor <callcomplete|systemready| receivingcall> Description This command is usefu...

Page 178 - wake; This command sets the WAN IP address.; Sets the WAN IP address when followed by the; Displays the WAN IP address.; wake

ViewStation EX, ViewStation FX, and VS4000 API Guide 170 www.polycom.com wake Description This command wakes the system from sleep mode. To put the system in sleep mode, use the command sleep . Example wake wanipaddress <set|get> ["xxx.xxx.xxx.xxx"] wanipaddress set ["xxx.xxx.xxx.x...

Page 179 - display whoami; whoami

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 171 whoami Description This command displays banner information. Example display whoami Ouput Hi, my name is: SupermanHere is what I know about myself:Serial Number: xxxxxBrand: PolycomSoftware Version: Release 5.0 FX - 14 Mar...

Page 180 - widescreenvideo yes; winsresolution no; winsresolution

ViewStation EX, ViewStation FX, and VS4000 API Guide 172 www.polycom.com Note This option only works between ViewStation EX, ViewStation FX, or VS4000 systems with software version 4.0 and higher. Otherwise, if one of the systems has a software version older than 4.0, the proprietary letter box form...

Page 181 - Displays the WINS server setting.; winsserver

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 173 winsserver <set|get> ["xxx.xxx.xxx.xxx"] winsserver set ["xxx.xxx.xxx.xxx"]winsserver setwinsserver get Description This command sets the WINS server. After a change is made, the system prompts the us...

Page 182 - ISDN BRI Commands; Sets the ISDN area code when followed by the; isdnareacode

ViewStation EX, ViewStation FX, and VS4000 API Guide 174 www.polycom.com ISDN BRI Commands The following commands are specific to the ISDN BRI network interface. isdnareacode <set|get> ["area code"] isdnareacode set ["area code"]isdnareacode setisdnareacode get Description This...

Page 183 - isdncountrycode set 1; isdncountrycode

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 175 isdncountrycode <set|get> ["country code"] isdncountrycode set ["country code"]isdncountrycode setisdncountrycode get Description This command sets the ISDN country code associated with the country wh...

Page 184 - Sets the ISDN prefix when followed by the; isdndialingprefix set 9; isdndialingprefix

ViewStation EX, ViewStation FX, and VS4000 API Guide 176 www.polycom.com isdndialingprefix <set|get> ["isdn prefix"] isdndialingprefix set ["isdn prefix"]isdndialingprefix setisdndialingprefix get Description This command sets the ISDN dialing prefix used to access an outside l...

Page 185 - isdndialspeed set 256 on; isdndialspeed

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 177 isdndialspeed <set|get> <"valid speed"> <on|off> isdndialspeed set <"valid speed"> <on|off>isdndialspeed get <"valid speed"> Description This command enables or d...

Page 186 - isdn number; you want to erase the current setting, omit; isdn; isdnnum

ViewStation EX, ViewStation FX, and VS4000 API Guide 178 www.polycom.com isdnnum <set|get><1b1|1b2|2b1|2b2|3b1| 3b2|4b1|4b2> ["isdn number"] isdnnum set <1b1|1b2|2b1|2b2|3b1|3b2|4b1|4b2> ["isdn number"]isdnnum set <1b1|1b2|2b1|2b2|3b1|3b2|4b1|4b2> isdnnum get ...

Page 187 - may; spid number; want to erase the current setting, omit; spid; spidnum

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 179 spidnum <set|get><1b1|1b2|2b1|2b2|3b1| 3b2|4b1|4b2> ["spid number"] spidnum set <1b1|1b2|2b1|2b2|3b1|3b2|4b1|4b2> ["spid number"]spidnum set <1b1|1b2|2b1|2b2|3b1|3b2|4b1|4b2> spidnum...

Page 188 - ISDN PRI Commands; This command sets the PRI area code.; Sets the PRI area code when followed by the; area code; parameter. If you want to erase the current setting, omit; area code; Numeric string specifying the area code.; priareacode

ViewStation EX, ViewStation FX, and VS4000 API Guide 180 www.polycom.com ISDN PRI Commands The following commands are specific to the ISDN PRI network interface. priareacode <set|get> [ " area code " ] priareacode set ["area code"]priareacode setpriareacode get Description This...

Page 189 - Sets PRI call-by-call when followed by a value from; pricallbycall set 1; pricallbycall

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 181 pricallbycall <set|get> [{0..31}] pricallbycall set [{0..31}]pricallbycall setpricallbycall get Description This command sets the PRI area code. Call-by-call is a number from 1 to 31, which is optionally sent to an u...

Page 190 - prichannel set all on; prichannel

ViewStation EX, ViewStation FX, and VS4000 API Guide 182 www.polycom.com prichannel <set|get> <all|{1..<23|30>}> <on|off> prichannel set all <on|off>prichannel set <{1..23}> <on|off> prichannel set <{1..30}> <on|off> prichannel setprichannel get ...

Page 191 - prichannel set; Example 3; prichannel get 3; Dedicated full PRI T1 or E1 Line:

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 183 Example 2 prichannel set Example 3 prichannel get 3 User Interface Screen Location System Info>Admin Setup>Video Network>IMUX>PRI Network> PRI Status This screen is only accessible if you have a PRI network ...

Page 192 - screen numbers these channels; Sets the internal CSU mode. This is the default.; pricsu external; pricsu

ViewStation EX, ViewStation FX, and VS4000 API Guide 184 www.polycom.com 17-31. But the PRI Status screen numbers these channels contiguously in the range 1-30. Therefore, on the PRI Status screen, channels 1-15 control the status of timeslots 1-15, and channels 16-30 control the status of timeslots...

Page 193 - want to erase the current setting, omit the parameter.; range is; pridialchannels set 3; pridialchannels

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 185 pridialchannels <set|get> <{1..12|15}> pridialchannels set <{1..12}>pridialchannels set <{1..15}>pridialchannels setpridialchannels get Description This command sets the number of PRI channels to di...

Page 194 - prefix; priintlprefix set 011; PRI Setup>Advanced PRI Setup: International Dialing Prefix; priintlprefix

ViewStation EX, ViewStation FX, and VS4000 API Guide 186 www.polycom.com priintlprefix <set|get> [ " prefix " ] priintlprefix set ["prefix"]priintlprefix setpriintlprefix get Description This command sets the PRI international dialing prefix.The international prefix defaults to...

Page 195 - or from; PRI Setup: Line Buildout; prilinebuildout

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 187 prilinebuildout <set|get><0|-7.5|-15|-22.5>| <0-133|134-266|267-399|400-533|534-665> prilinebuildout set <0|-7.5|-15|-22.5>prilinebuildout set <0-133|134-266|267-399| 400-533|534-665>prilinebu...

Page 196 - prilinesignal set esf/b8zs; prilinesignal

ViewStation EX, ViewStation FX, and VS4000 API Guide 188 www.polycom.com prilinesignal <set|get><esf/b8zs|crc4/hdb3| hdb3> prilinesignal set <esf/b8zs|crc4/hdb3|hdb3>prilinesignal get Description This command sets the PRI line signal. set Sets the PRI line signal. It requires a par...

Page 197 - This command sets the PRI video number.; pri number; prinumber

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 189 prinumber <set|get> [ " pri number " ] prinumber set ["pri number"]prinumber setprinumber get Description This command sets the PRI video number. set Sets the PRI video number when followed by the par...

Page 198 - prinumberingplan isdn; prinumberingplan

ViewStation EX, ViewStation FX, and VS4000 API Guide 190 www.polycom.com prinumberingplan <isdn|unknown|get> Description This command sets the PRI numbering plan. isdn With isdn , the numbering plan is identified to the upstream switch as ISDN, and the number type, which is either national or ...

Page 199 - erase the current setting, omit the parameter.; prioutsideline set 9; prioutsideline

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 191 prioutsideline <set|get> [ " outside_line " ] prioutsideline set ["outside_line"]prioutsideline setprioutsideline get Description This command sets the PRI number that is dialed for outside line acces...

Page 200 - is the default. It is the standard; Sets the PRI switch. A parameter from; Displays the current switch protocol.; priswitch set norteldms; PRI Setup: Switch Protocol; priswitch

Page 201 - cts normal; CTS; cts

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 193 V.35/RS-449/RS-530/RS-366 Commands The following commands are specific to the V.35/RS-449/RS-530/ RS-366 network interface. cts <normal|inverted|get> Description This command lets you configure the cts serial interfa...

Page 202 - dcd inverted; dcdfilter on; dcdfilter

ViewStation EX, ViewStation FX, and VS4000 API Guide 194 www.polycom.com inverted Sets the signal to inverted (low voltage is logic 1). get Displays the current setting ( normal or inverted ). Example dcd inverted User Interface Screen Location System Info>Admin Setup>Video Network>Advanced...

Page 203 - dsr get; dsr

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 195 dsr <normal|inverted|get> Description This command lets you configure the dsr serial interface control signal (data set ready). The default setting for this signal is normal . normal Sets the signal to normal (high v...

Page 204 - dsranswer on; dtr get; DTR; dtr

ViewStation EX, ViewStation FX, and VS4000 API Guide 196 www.polycom.com Example dsranswer on User Interface Screen Location System Info>Admin Setup>Video Network>Advanced V.35: DSR>Answer This screen is only accessible if you have a V.35/RS-449/RS-530/RS-366 network interface connected ...

Page 205 - Same as; Turns the audio mode off.

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 197 h331audiomode <g728|g711u|g711a|g722-56| g722-48|off|get> Description This command sets the H.331 audio protocol for transmitting audio in broadcast mode. Broadcast configuration parameters should be set to accommoda...

Page 207 - Standard video protocol used to transmit video.; Broadcast Mode Setup: Video Protocol

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 199 h331videoprotocol <h263|h261|get> Description This command sets the H.331 video protocol for the broadcast transmission. Broadcast configuration parameters should be set to accommodate the lowest common denominator o...

Page 208 - connection to the far

ViewStation EX, ViewStation FX, and VS4000 API Guide 200 www.polycom.com fcif Full Common Interchange Format ( 352 x 288 resolution). get Displays the current setting. Example h331videoformat fcif User Interface Screen Location System Info>Admin Setup>Video Network>Video Network> Broadca...

Page 209 - Displays the current setting for this option (; rt inverted; RT; rt

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 201 rt <normal|inverted|get> Description This command lets you configure the rt serial interface control signal (receive timing: clock). The default setting for this signal is normal . normal Sets the signal to normal (r...

Page 210 - rts normal; RTS; st get; ST; st

ViewStation EX, ViewStation FX, and VS4000 API Guide 202 www.polycom.com Example rts normal User Interface Screen Location System Info>Admin Setup>Video Network>Advanced V.35: RTS This screen is only accessible if you have a V.35/RS-449/RS-530/RS-366 network interface connected to your syst...

Page 211 - Enables broadcast mode.; v35broadcastmode on; RS-366 network interface connected to your system.; v35broadcastmode

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 203 v35broadcastmode <on|off|get> Description This command sets H.331 broadcast mode for transmissions via satellite. on Enables broadcast mode. off Disables broadcast mode. get Displays the current setting ( on or off )...

Page 212 - v35dialingprotocol

ViewStation EX, ViewStation FX, and VS4000 API Guide 204 www.polycom.com v35dialingprotocol <rs366|get> Description This command selects the V.35/RS-449/RS-530/RS-366 dialing protocol. Selecting a dialing protocol is not needed if you are using your DCE to dial the call or if you have a dedica...

Page 213 - nomenclature of the user interface and the command

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 205 nomenclature of the user interface and the command isdnnum (see page 178). set <1b1|1b2> Sets the ISDN video number for a B channel line when followed by a v35 number parameter. If you want to erase the current setti...

Page 214 - lists all

ViewStation EX, ViewStation FX, and VS4000 API Guide 206 www.polycom.com Example v35portsused 1+2 User Interface Screen Location System Info>Admin Setup>Video Network>Video Network: V.35 Ports Used This screen is only accessible if you have a V.35/RS-449/RS-530/RS-366 network interface conn...

Page 215 - value; Displays the current setting for; This command associates the dialing prefix 005 to the speed 112.; Advanced Dialing

ViewStation EX, ViewStation FX, and VS4000 API Guide © Polycom, Inc. 2003 207 value V.35/RS-449/RS-530/RS-366 prefix. The prefix is a function of your DCE. Please consult the DCE user guide for additional information. get < " valid speed " > Displays the current setting for valid speed...

Page 216 - Displays the current profile.; view; Selects; v35profile view; This example assumes

ViewStation EX, ViewStation FX, and VS4000 API Guide 208 www.polycom.com V.35/RS-449/RS-530/RS-366 profiles (equipment/manufacturer) available. Consult your DCE user guide for additional information on setting dialing profiles. get Displays the current profile. view Displays all the settings (speed,...

Page 218 - This command associates the dialing suffix #4#2 to the speed 128.

ViewStation EX, ViewStation FX, and VS4000 API Guide 210 www.polycom.com Example v35suffix set 128 ”#4#2” This command associates the dialing suffix #4#2 to the speed 128. User Interface Screen Location System Info>Admin Setup>Video Network>Video Network> Advanced Dialing This screen is ...

Page 219 - Safety and Legal Notices; Important Safeguards; License Restrictions

© Polycom, Inc. 2003 211 Safety and Legal Notices Important Safeguards Read and understand the following instructions before using the system: • Close supervision is necessary when the system is used by or near children. Do not leave unattended while in use. • Only use electrical extension cords wit...

Page 220 - Warranty; FCC Notice

ViewStation EX, ViewStation FX, and VS4000 API Guide 212 www.polycom.com Warranty Polycom, Inc. warrants its products to be free of defects in materials and factory workmanship for a period of twelve (12) months from date of purchase. This warranty does not apply to damage to products resulting from...

Page 222 - EEA Regulatory Notices

ViewStation EX, ViewStation FX, and VS4000 API Guide 214 www.polycom.com The Ringer Equivalence Number (REN) assigned to each relevant terminal device provides an indication of the maximum number of terminals allowed to be connected to a telephone interface. The termination on an interface may consi...

Page 224 - Underwriters Laboratories Statement

ViewStation EX, ViewStation FX, and VS4000 API Guide 216 www.polycom.com Underwriters Laboratories Statement The system is intended to be powered only by the supplied power supply unit. Special Safety Instructions Follow existing safety instructions and observe all safeguards as directed. Installati...