ViewStation® EX, ViewStation FX, and VS4000 API Guide VS4000 User’s Guide April 2003 Edition Release 5.
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 Explorer™, NetMeeting®, Windows®, and Windows NT® are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.
Contents Contents........................................................................................................... i What’s New in Release 5.0? ............................................................................ 2 Accessing the API Interface ............................................................................. 3 Using Telnet ........................................................................................ 3 Using the RS-232 Interface........................................
ViewStation EX, ViewStation FX, and VS4000 API Guide callstate ............................................................................................... 31 camera ................................................................................................ 32 camera1ptz.......................................................................................... 35 camera4ptz.......................................................................................... 36 cameradirection...................
ViewStation EX, ViewStation FX, and VS4000 API Guide gatewayprefix ...................................................................................... 67 gatewaysetup ...................................................................................... 68 gatewaysuffix ...................................................................................... 69 gendial................................................................................................. 70 generatetone ..........................
ViewStation EX, ViewStation FX, and VS4000 API Guide nearloop .............................................................................................. 107 netmeetingip........................................................................................ 108 netstats................................................................................................ 109 numdigitsdid ........................................................................................ 110 numdigitsext .................
ViewStation EX, ViewStation FX, and VS4000 API Guide streammulticastip ................................................................................ 140 streamrestoredefaults ......................................................................... 141 streamrouterhops ................................................................................ 142 streamspeed ....................................................................................... 143 streamvideoport .................................
ViewStation EX, ViewStation FX, and VS4000 API Guide ISDN BRI Commands ...................................................................................... 174 isdnareacode....................................................................................... 174 isdncountrycode .................................................................................. 175 isdndialingprefix................................................................................... 176 isdndialspeed .......................
ViewStation EX, ViewStation FX, and VS4000 API Guide This document describes the CGI-based ViewStation EX, ViewStation FX, and VS4000 API (Application Programming Interface). This API is a set of commands implemented within the shell. The commands are available for advanced users who want to automate some of the control features of the ViewStation EX, ViewStation FX, and VS4000 systems. This API can be used via a Telnet session or via the RS-232 interface.
ViewStation EX, ViewStation FX, and VS4000 API Guide What’s New in Release 5.0? The following table lists the major changes for Release 5.0. Type of Command system V.35 Command Change allowmixedcalls new command audioqualityg7221 new command camera near move When you are not in a call: All camera near move commands need to be preceded by a button near command.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 24 Note Telneting to port 24 keeps the user from seeing all the debug outputs which can be extensive and inconvenient. 3. Click OK.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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. ViewStation EX and ViewStation FX Connect your PC to the ViewStation EX or FX system as follows: 1. Locate the RS-232 serial cable (DB9-to-8-pin mini-DIN). 2. Connect the 9-pin DB-9 connector to the serial port of your PC. 3.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 to set the baud rate and the modes for the serial port on the back of the system. To access the RS-232 screen on your system, select System Info>Admin Setup>Software/Hardware> RS-232.
ViewStation EX, ViewStation FX, and VS4000 API Guide • 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 information describes operational modes in more detail. • Pass-Thru Mode to Pass-Thru Mode—Two stations set to Pass-Thru Mode behave essentially as a null-modem between their respective externally connected devices.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 ViewStation FX to a terminal or another communications device.
ViewStation EX, ViewStation FX, and VS4000 API Guide RS-232 Serial Cable Pinout and Connections (VS4000) The RS-232 serial cable has a 9-pin DB-9 connector on both ends. It is used to connect the VS4000 to a terminal or another communications device. Pin Number © Polycom, Inc. 2003 Function 1 - DCD Data Carrier Detect 2 - RX Receive 3 - TX Transmit 4 - DTR Data Terminal Ready 5 - GND Ground 6 - DSR Data Set Ready 7 - RTS Ready to Send 8 - CTS Clear to Send 9 - RI This pin is not used.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 (incoming/outgoing calls), either register the terminal session with the listen command or start an outbound call with the dial command.
ViewStation EX, ViewStation FX, and VS4000 API Guide cs: call[0] chan[0] dialstr[95551212] state[BONDING] cs: call[0] chan[0] dialstr[95551212] state[COMPLETE] cs: call[0] chan[1] dialstr[95551212] state[RINGING] cs: call[0] chan[1] dialstr[95551212] state[CONNECTED] cs: call[0] chan[2] dialstr[95551212] state[RINGING] cs: call[0] chan[3] dialstr[95551212] state[RINGING] cs: call[0] chan[2] dialstr[95551212] state[CONNECTED] cs: call[0] chan[3] dialstr[95551212] state[CONNECTED] cs: call[0] chan[4] dialstr
ViewStation EX, ViewStation FX, and VS4000 API Guide -> ->listen video ringing // there is an incoming call, auto answer is on ->cs: call[0] chan[0] dialstr[8005551212] state[RINGING] cs: call[0] chan[0] dialstr[8005551212] state[CONNECTED] cs: call[0] chan[0] dialstr[8005551212] state[BONDING] cs: call[0] chan[0] dialstr[8005551212] state[COMPLETE] cs: call[0] chan[1] dialstr[8005551212] state[RINGING] cs: call[0] chan[1] dialstr[8005551212] state[CONNECTED] cs: call[0] chan[2] dialstr[8005551212] state[R
ViewStation EX, ViewStation FX, and VS4000 API Guide Syntax Summary The following syntactic notation is used for the API shell control commands. Note All defined commands are case sensitive. A required parameter. The text between the angled brackets is one or more parameter(s) that can occur at the specified point in the command. Multiple parameters are listed separated by the “|” character (pipe) which is a notational shortcut for "or.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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. About the “get” Subcommand In most cases, the get subcommand returns the command name and the current setting if one has been set. Example 1 gmscountry get Response gmscountry france The current setting for the command gmscountry is france.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 used command starting with a specific number or letter from the history list. For more information about the history list, refer to history. str Executes the last command that begins with the specified str from the history list. 1..
ViewStation EX, ViewStation FX, and VS4000 API Guide gatewaynumber set 123456789 gatewaynumber 123456789 restart system for changes to take effect. restart now? ->!2 hangup video hanging up video call ->!h hangup video hanging up video call ->!hi history 1 gatewaynumber set 123456789 2 hangup video 3 history 4 gatewaynumber set 123456789 5 hangup video 6 hangup video 7 history ->!gat gatewaynumber set 123456789 gatewaynumber 123456789 restart system for changes to take effect.
ViewStation EX, ViewStation FX, and VS4000 API Guide abk all abk 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 Displays all the records in the Address Book. letter Displays entries beginning with the letter specified from the range {a..z}. range Displays local Address Book entries numbered a through b. Requires a parameter from {a..b}. a..
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 parameter. The system must have an admin password set before this command works. get Displays the current admin password. password Valid characters are: a through z (lower and uppercase), -, _, @, /, ;, ,, ., \, 0 through 9.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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:Polycom_VS4000_5.0 where: © Polycom, Inc.
ViewStation EX, ViewStation FX, and VS4000 API Guide tmlpr Transmit MLP rate (H.320 calls only) rvj rmlpr Receive video jitter (H.323 calls only) Receive MLP rate (H.320 calls only) dc Data conference rsid Remote system id User Interface Screen Location System Info>Diagnostics>Advanced Stats allowabkchanges allowabkchanges Description This command enables or disables the Allow Address Book Changes option.
ViewStation EX, ViewStation FX, and VS4000 API Guide allowdialing allowdialing 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 setting (yes or no).
ViewStation EX, ViewStation FX, and VS4000 API Guide Example allowmixedcalls yes User Interface Screen Location System Info>Admin Setup>Video Network > Call Preferences: Allow H.320 and H.323 Mixed Calls allowremotemon allowremotemon Description This command displays the current state of the Allow Remote Monitoring option. get Displays the current setting (yes or no).
ViewStation EX, ViewStation FX, and VS4000 API Guide Example allowusersetup yes User Interface Screen Location System Info>Admin Setup>General Setup (page 2-Next): Allow User Setup answer answer Description This command answers incoming video or POTS calls. phone Answers incoming POTS calls. video Answers incoming video calls when the Auto Answer Point to Point or Auto Answer Multipoint option is set to No.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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.
ViewStation EX, ViewStation FX, and VS4000 API Guide Example audioqualityg7221 set 256 User Interface Screen Location System Info>Admin Setup>Phone/Audio: Audio Quality autoanswer autoanswer Description This command sets the Auto Answer Point to Point mode which determines how the system will handle an incoming call in a point-to-point video conference. yes If the option Auto Answer Point to Point is set to yes, any incoming call will be connected automatically.
ViewStation EX, ViewStation FX, and VS4000 API Guide autodiscovernat autodiscovernat 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 WAN. no Disables the option. get Displays the current setting (yes or no). Example autodiscovernat yes User Interface Screen Location System Info>Admin Setup>LAN/H.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 backlightcompensation Description This command enables or disables the Backlight Compensation option. yes Enables Backlight Compensation. The camera automatically adjusts for a bright background. no Disables the option.
ViewStation EX, ViewStation FX, and VS4000 API Guide button button <#|*|1|2|3|4|5|6|7|8|9|0|auto| callhangup|camera|delete|directory|down|far| home|info|keyboard|left|lowbattery| menu|mute|near|period|pickedup|pip|preset| putdown|right|select|slides|snapshot|up| volume+|volume-|zoom+|zoom-> Description This command allows the user to send the same command as the Polycom remote control to the user interface. Note that several parameters can be combined in the same command in any order.
ViewStation EX, ViewStation FX, and VS4000 API Guide delete Not implemented. directory Takes the user to the Address Book screen. down Sends the down key to the user interface (down arrow). far Sends the Far key to the user interface. home Takes the user to the main screen. info Sends the Info command to the user interface. keyboard Brings up the on-screen keyboard if the cursor is on a text field. left Sends the left (left arrow) command to the user interface.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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.
ViewStation EX, ViewStation FX, and VS4000 API Guide callstate callstate 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 activities. unregister Disables the register mode. get Displays the selected call state mode (register or unregister).
ViewStation EX, ViewStation FX, and VS4000 API Guide camera camera Subcommands camera near <{1..4}|source|move|stop|getposition| setposition|tracking> camera far <{1..
ViewStation EX, ViewStation FX, and VS4000 API Guide near move left Near camera direction change (start moving left). near move rightNear camera direction change (start moving right). near move up Near camera direction change (start moving up). near move downNear camera direction change (start moving down) near move stop Near camera direction change stops. near move continuous Switches near camera move mode to continuous mode.
ViewStation EX, ViewStation FX, and VS4000 API Guide far subcommands far 1..5 Selects a far camera as the main video source (Camera source 1-5). far source Returns the number of the camera source currently selected. far move zoom+Far camera direction change (start zooming in). far move zoom- Far camera direction change (start zooming out). far move left Far camera direction change (start moving left). far move right Far camera direction change (start moving right).
ViewStation EX, ViewStation FX, and VS4000 API Guide 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+ This command causes the near camera to zoom in. camera1ptz camera1ptz Description This command sets camera source 1 to pan-tilt-zoom mode. This command is specific to the VS4000 system.
ViewStation EX, ViewStation FX, and VS4000 API Guide camera4ptz camera4ptz 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-video or composite mode. yes Enables pan-tilt-zoom mode. no Disables pan-tilt-zoom mode. get Displays the current setting (yes or no).
ViewStation EX, ViewStation FX, and VS4000 API Guide Example cameradirection normal User Interface Screen Location System Info>Admin Setup>Video/Camera>Cameras: Camera Direction camerainput camerainput <1|2|3|4> camerainput 1 camerainput 2 camerainput 3 camerainput 4 Description This command sets video inputs on cameras 1-4 for the VS4000 system only.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 chaircontrol chaircontrol Subcommands chaircontrol
ViewStation EX, ViewStation FX, and VS4000 API Guide rel_chair Releases the chair. req_chair Requests the chair. req_floor Requests the floor. req_term_name Requests the terminal name for the terminal numbered term_no. req_vas Requests voice activated switching. view Views the terminal term_no. view_broadcasterViews the broadcaster. list Lists terminals in the conference. set_broadcaster Requests the terminal term_no to become the broadcaster.
ViewStation EX, ViewStation FX, and VS4000 API Guide colorbar colorbar 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>Color Bar: View Color Bars country country country set country get Description This command selects the country or displays the name of the country.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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>Admin Setup>General Setup: Country dataconferencetype dataconferencetype Description This command sets the data conference type.
ViewStation EX, ViewStation FX, and VS4000 API Guide daylightsavings daylightsavings 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 (yes or no). Example daylightsavings yes User Interface Screen Location System Info>Admin Setup>LAN/H.323>Global Management> Setup: Daylight Savings Time defaultgateway defaultgateway ["xxx.xxx.xxx.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 Info>AdminSetup>LAN/H.323>LAN/Intranet> LAN&Intranet: Default Gateway dhcp dhcp Description This command is used to select or get DHCP options.
ViewStation EX, ViewStation FX, and VS4000 API Guide User Interface Screen Location System Info>Admin Setup>LAN/H.323>LAN/Intranet>LAN &Intranet: DHCP dial dial dial addressbook <"addr book name"> dial auto <“dialstr”> dial manual<"speed"><"dialstr1">["dialstr2"] [] dial phone <"dialstring"> Description This command lets you dial video or audio calls either manually or from the Address Book. addressbook Dials an Address Book entry.
ViewStation EX, ViewStation FX, and VS4000 API Guide h323|h320|ip|isdnType 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 name or strings containing spaces (Ex: “united states” or “111 222 333”).
ViewStation EX, ViewStation FX, and VS4000 API Guide diffserv diffserv <{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 of Service). The priority level value can be between 0 and 63. set Sets the command. A priority level from the range {0..63} is required. 0..63 Priority level range. get Displays the current setting.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 display call Description This command displays call ID, status, speed, and the number to which this system is connected.
ViewStation EX, ViewStation FX, and VS4000 API Guide Ouput Hi, my name is: Jw_System Here is what I know about myself: Serial Number: xxxxx Brand: Polycom Software Version: Release 5.0 FX - 14 Mar 2003 Model: VSFX4 Network Interface: PRI_E1 MP Enabled: Yes H323 Enabled: Yes IP Address: 192.168.1.
ViewStation EX, ViewStation FX, and VS4000 API Guide displayglobaladdresses displayglobaladdresses 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 global addresses. get Displays the current setting (yes or no). Example displayglobaladdresses yes User Interface Screen Location System Info>Admin Setup>LAN/H.
ViewStation EX, ViewStation FX, and VS4000 API Guide User Interface Screen Location System Info>Admin Setup>Video/Cameras>Monitors>TV Monitors: Display Icons in a Call displayipext displayipext Description This command enables or disables the display of the IP extension field. This extension is needed when placing a call through a gateway. When this option is selected, the Extension field is visible in the Video Call screen. yes Enables the display of the IP extension.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 displayparams Description This command outputs the list of all the system settings. Example displayparams Output (partial) systemname Jw hostname Jw ipaddress 192.168.1.104 wanipaddress 192.168.1.111 version Release 5.
ViewStation EX, ViewStation FX, and VS4000 API Guide gmsurl 9 gmsurl 10 gmscontactperson gmscontactnumber gmscontactemail gmscontactfax gmstechsupport gmscity gmsstate gmscountry gabserverip gabpassword displayglobaladdresses no registerthissystem no showaddrsingab both primarycallchoice manual secondarycallchoice none preferredalias extension gatewaynumbertype number+extension outboundcallroute isdn usegatekeep
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 <{1..4}> Sets a DNS server when followed by the parameter xxx.xxx.xxx.xxx. If you want to erase the current setting, omit the parameter. get <{1..4}> Displays the current IP address of the specified server (1..4). 1..
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 e164ext ["e.164name"] e164ext set ["e.164name"] e164ext set e164ext get Description This command is used to specify an H.323 (IP) extension (aka E.164). H.323 extensions are needed for inbound calls going through a Gateway.
ViewStation EX, ViewStation FX, and VS4000 API Guide Response e164ext restart system for changes to take effect. Restart now? User Interface Screen Location System Info>Admin Setup>LAN/H.323>H.323>Gateway: Gateway Number>Extension echocanceller echocanceller Description This command is used to prevent the user from hearing his or her voice loop back from the remote site. This option is enabled by default. Note We strongly recommend that you do not turn off echo cancellation.
ViewStation EX, ViewStation FX, and VS4000 API Guide enablesnapshots enablesnmp 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 setting (on or off).
ViewStation EX, ViewStation FX, and VS4000 API Guide User Interface Screen Location System Info>Admin Setup>LAN/H.323>SNMP: Enable SNMP exit exit Description This command ends an API command session. Example exit farcontrolnearcamera farcontrolnearcamera Description This command sets far control of the near camera, thus allowing remote sites to control the camera on your system. yes Enables the far control option of the near camera. no Disables the far control option of the near camera.
ViewStation EX, ViewStation FX, and VS4000 API Guide farloop farloop 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.
ViewStation EX, ViewStation FX, and VS4000 API Guide Examples farnametimedisplay set farnametimedisplay set 120 User Interface Screen Location System Info>User Setup: Far Site Name Display gabk batch gabk batch <{0..59}> Description This command displays Global Address Book entries in batches. 0..59 Range of batches. A selected batch number displays Global Address Book entries. The size of the batches is determined by the GAB server.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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: “united states” or “111 222 333”). Example gabpassword set gabPass User Interface Screen Location System Info>User Setup>LAN/H.323>Global Address>Server: Server Password gabserverip gabserverip ["xxx.xxx.xxx.
ViewStation EX, ViewStation FX, and VS4000 API Guide User Interface Screen Location System Info>User Setup>LAN/H.323>Global Address>Server: Server IP Address gatekeeperip gatekeeperip ["xxx.xxx.xxx.xxx"] gatekeeperip set ["xxx.xxx.xxx.xxx"] gatekeeperip set gatekeeperip get Description This command sets the IP address of the gatekeeper. When this option is changed, the user is prompted to restart the system. set Sets the gatekeeper IP address when followed by the parameter xxx.xxx.xxx.xxx.
ViewStation EX, ViewStation FX, and VS4000 API Guide gatewayareacode gatewayareacode ["areacode"] gatewayareacode set ["areacode"] gatewayareacode set gatewayareacode get Description This command sets the gateway area code. set Sets the area code when followed by the areacode parameter. If you want to erase the current setting, omit areacode. get Displays the current setting for this option. areacode Numeric string specifying the gateway area code.
ViewStation EX, ViewStation FX, and VS4000 API Guide gatewaycountrycode gatewaycountrycode ["number"] gatewaycountrycode set ["number"] gatewaycountrycode set gatewaycountrycode get Description This command sets the gateway country code. set Sets the gateway country code when followed by the number parameter. If you want to erase the current setting, omit number. get Displays the current setting. number Numeric string specifying the gateway country code.
ViewStation EX, ViewStation FX, and VS4000 API Guide gatewayext gatewayext ["gateway extension"] gatewayext set ["gateway extension"] gatewayext set gatewayext get Description This command sets the gateway extension number. You need to restart the system for changes to take effect. set Sets the gateway extension number when followed by the gateway extension parameter. If you want to erase the current setting, omit gateway extension. get Displays the current setting.
ViewStation EX, ViewStation FX, and VS4000 API Guide gatewaynumber gatewaynumber ["number"] gatewaynumber set ["number"] gatewaynumber set gatewaynumber get Description This command sets the gateway number. set Sets the gateway number when followed by the number parameter. If you want to erase the current setting, omit number. get Displays the current setting. number Numeric string specifying the gateway number.
ViewStation EX, ViewStation FX, and VS4000 API Guide gatewaynumbertype gatewaynumbertype 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 of the full DID that the gateway will be given from the ISDN service provider as the Called Party Line Identifier. This, in turn, will be passed to the gatekeeper for address resolution.
ViewStation EX, ViewStation FX, and VS4000 API Guide gatewayprefix gatewayprefix <"valid speed"> ["value"] gatewayprefix set <"valid speed"> ["value"] gatewayprefix set <"valid speed"> gatewayprefix get <"valid speed"> Description This command sets the gateway prefixes for the corresponding speeds. Some gateways require a number to be prepended (prefix) to the gateway number. The prefix identifies which gateway is used to dial a call at a particular data rate.
ViewStation EX, ViewStation FX, and VS4000 API Guide Example gatewayprefix set 168 90 User Interface Screen Location System Info>Admin Setup>LAN/H.323>H.323>Gateway (page 2): Prefix gatewaysetup gatewaysetup Description This command lists all the available speeds at once. Example gatewaysetup Output 56 64 2x56 112 2x64 128 168 192 224 256 etc... #12 #14 #222 #444 #13 #16 #333 #555 68 www.polycom.
ViewStation EX, ViewStation FX, and VS4000 API Guide gatewaysuffix gatewaysuffix <"valid speed"> ["value"] gatewaysuffix set <"valid speed"> ["value"] gatewaysuffix set <"valid speed"> gatewaysuffix get <"valid speed"> Description This command sets the gateway suffix. Some gateways require a number to be appended (suffix) to the gateway number. The suffix identifies which gateway is used to dial a call at a particular data rate.
ViewStation EX, ViewStation FX, and VS4000 API Guide Example gatewaysuffix set 192 11 User Interface Screen Location System Info>Admin Setup>LAN/H.323>H.323>Gateway (page 2): Suffix gendial gendial [{0..9|#|*}] Description This command generates DTMF dialing tones to POTS line. 0..9|#|* Represents valid buttons. Example gendial 2 generatetone generatetone Description This command turns the test tone on or off.
ViewStation EX, ViewStation FX, and VS4000 API Guide get screen 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 CGenToneScreen gmscity gmscity ["city"] gmscity set ["city"] gmscity set gmscity get Description This command sets the GMS city information. set Sets the GMS city name when followed by the city parameter.
ViewStation EX, ViewStation FX, and VS4000 API Guide Example gmscity set Paris User Interface Screen Location System Info>Admin Setup>LAN/H.323>Global Management> Info 1: City gmscontactemail gmscontactemail ["email"] gmscontactemail set ["email"] gmscontactemail set gmscontactemail get Description This command sets the GMS contact E-mail information. set Sets the GMS contact E-mail information when followed by the email parameter. If you want to erase the current setting, omit email.
ViewStation EX, ViewStation FX, and VS4000 API Guide gmscontactfax gmscontactfax ["fax"] gmscontactfax set ["fax"] gmscontactfax set gmscontactfax get Description This command sets the GMS contact fax information. set Sets the GMS contact fax information when followed by the fax parameter. If you want to erase the current setting, omit fax. get Displays the current contact fax information. fax Character string specifying the contact fax.
ViewStation EX, ViewStation FX, and VS4000 API Guide gmscontactnumber gmscontactnumber ["number"] gmscontactnumber set ["number"] gmscontactnumber set gmscontactnumber get Description This command sets the GMS contact number information. set Sets the GMS contact number information when followed by the number parameter. If you want to erase the current setting, omit number. get Displays the current contact number information. number Numeric string specifying the contact number.
ViewStation EX, ViewStation FX, and VS4000 API Guide gmscontactperson gmscontactperson ["person"] gmscontactperson set ["person"] gmscontactperson set gmscontactperson get Description This command sets the GMS contact person information. set Sets the GMS contact person information when followed by the person parameter. If you want to erase the current setting, omit person. get Displays the current contact person information. person Character string specifying the contact person.
ViewStation EX, ViewStation FX, and VS4000 API Guide gmscountry gmscountry ["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 country parameter. If you want to erase the current setting, omit country. get Displays the current country information. country Character string specifying the country information.
ViewStation EX, ViewStation FX, and VS4000 API Guide gmsstate gmsstate ["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 parameter. If you want to erase the current setting, omit the parameter. get Displays the current state information. state Character string specifying the state information.
ViewStation EX, ViewStation FX, and VS4000 API Guide gmstechsupport gmstechsupport ["tech support digits"] gmstechsupport set ["tech support digits"] gmstechsupport set gmstechsupport get Description This command sets the GMS technical support phone number information. set Sets the technical support information when followed by the tech support digits parameter. If you want to erase the current setting, omit tech support digits. get Displays the current tech support phone number information.
ViewStation EX, ViewStation FX, and VS4000 API Guide gmsurl gmsurl <{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 server that manages your system. When you are registered with the GMS, this information is automatically configured. In some instances, you may add GMS URLs manually. This information is provided by your network manager. set <{1..
ViewStation EX, ViewStation FX, and VS4000 API Guide User Interface Screen Location System Info>Admin Setup>LAN/H.323>Global Management> Setup>Select Server URLs... graphicsmonitor graphicsmonitor Description This command sets the graphics monitor. tv Selects the TV monitor as the graphics monitor. The graphics and video are displayed on the TV monitor. The command graphicsmonitor tv is similar to graphicsmonitortv on.
ViewStation EX, ViewStation FX, and VS4000 API Guide graphicsmonitorfxvga graphicsmonitorfxvga 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 VGA monitor or projector connected to the rear panel of the system. The command graphicsmonitorfxvga on is similar to graphicsmonitor fxvga. off Disables the VGA monitor as the graphics monitor.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 Monitor: TV Monitor graphicsmonitorvisualconcert graphicsmonitorvisualconcert Description This command enables or disables Visual Concert FX as the graphics monitor.
ViewStation EX, ViewStation FX, and VS4000 API Guide h323name h323name ["H.323name"] h323name set ["H.323name"] h323name set h323name get Description This command sets the H.323 name. set Sets the H.323 name when followed by the H.323name parameter. If you want to erase the current setting, omit the parameter. get Displays the current setting for this option. H.323name Character string specifying the H.323 name.
ViewStation EX, ViewStation FX, and VS4000 API Guide hangup hangup hangup phone hangup 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 from the range {1..3} is specified. A specified parameter selects which call to hang up. 1..3 The optional parameter selects which call to hang up.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 commands without syntax. string Displays detailed help for commands containing string. syntax Displays the help syntax summary.
ViewStation EX, ViewStation FX, and VS4000 API Guide Output to Example 2 (partial) ! abk adminpassword advnetstats allowabkchanges allowdialing allowmixedcalls allowremotemon allowusersetup answer audioquality audioqualityg7221 autoanswer autodiscovernat hires hires <{2|3}> Description This command sets the high-resolution state for camera 2 or 3. 2|3 Selectable high-resolution cameras. yes Enables high-resolution mode for the selected camera.
ViewStation EX, ViewStation FX, and VS4000 API Guide Output to Example 2 camera 2 hires No User Interface Screen Location System Info>Admin Setup>Video Cameras>Cameras: High Resolution Cameras history history Description This command lists the last commands used in the current session. The maximum number of commands that can be displayed is 64. Example history Sample Output © Polycom, Inc. 2003 1 ipaddress set 192.168.1.
ViewStation EX, ViewStation FX, and VS4000 API Guide hostname hostname ["hostname"] hostname set ["hostname"] hostname set hostname get Description This command sets the LAN host name. This is the name assigned to the system for TCP/IP configuration and it can be used in place of an IP address when dialing IP calls. A LAN host name is required. It cannot be deleted or left blank. When the LAN host name is changed, the system prompts the user for a reboot.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 Example 2 hostname ADMIN User Interface Screen Location System Info>Admin Setup>LAN/H.323>LAN/Intranet>LAN & Intranet: Host Name ipaddress ipaddress ["xxx.xxx.xxx.xxx"] ipaddress set ["xxx.xxx.xxx.
ViewStation EX, ViewStation FX, and VS4000 API Guide xxx.xxx.xxx.xxxIP 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 ipdialspeed <"valid speed"> ipdialspeed <"valid speed"> ipdialspeed get <"valid speed"> Description This command enables or disables the IP dialing speed valid speed.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 Setup>LAN/H.323>H.323>Dialing Speeds ipprecedence ipprecedence <{0..5}> ipprecedence set <{0..
ViewStation EX, ViewStation FX, and VS4000 API Guide ipstat 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, subnet mask, and WINS server. Example ipstat Output to Example hostname MyEX winsresolution no dhcp client ipaddress 192.168.1.111 dns 1 192.168.1.2 dns 2 192.168.1.3 dns 3 192.168.1.4 dns 4 0.0.0.0 defaultgateway 192.168.1.
ViewStation EX, ViewStation FX, and VS4000 API Guide keypadaudioconf keypadaudioconf 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 audio confirmation. no Disables audio confirmation. get Displays the current setting (yes or no).
ViewStation EX, ViewStation FX, and VS4000 API Guide set Sets the command. It requires a parameter from . get Displays the current language on the system. englishus, englishuk, french, german, italian, spanish, japanese, chinese, portuguese, norwegian Supported languages.
ViewStation EX, ViewStation FX, and VS4000 API Guide User Interface Screen Location System Info>Admin Setup>LAN/H.323>LAN/Intranet> Advanced LAN Settings lanstat lanstat lanstat min lanstat min [{0..60}] lanstat misc lanstat reset lanstat sec lanstat tmin lanstat tmin [{0..60}] lanstat total Description This command displays local area network statistics. © Polycom, Inc. 2003 min Displays the last minutes of LAN statistics.
ViewStation EX, ViewStation FX, and VS4000 API Guide 0..60 Maximum number of minutes that can be specified is 60.
ViewStation EX, ViewStation FX, and VS4000 API Guide lanstat: lanstat: lanstat: lanstat: lanstat: lanstat: lanstat: Max tx iterations Max rx iterations Max interrupt iters Total interrupts Max interrupt delay Last interrupt delay end = = = = = = 8 4 3 113137865 441170 214835 listen listen Description This command registers the Telnet or RS-232 session to listen for incoming video calls, POTS phone calls, or system sleep or awake state and, consequently, to give notification when the
ViewStation EX, ViewStation FX, and VS4000 API Guide listen waking up Notification of event: the system is waking up. maxgabinternationalcallspeed maxgabinternationalcallspeed <"valid speed"> maxgabinternationalcallspeed get Description This command sets the maximum speed for international ISDN calls made from the Global Address Book. set Sets the maximum speed for international calls when followed by a valid speed value.
ViewStation EX, ViewStation FX, and VS4000 API Guide maxgabinternetcallspeed maxgabinternetcallspeed <"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 the maximum speed for international calls when followed by a valid speed value. valid speedValid speeds are: 128, 256, 384, 512, 768, 1024, 1472 and Kbps. get Note Displays the current valid speed.
ViewStation EX, ViewStation FX, and VS4000 API Guide maxgabisdncallspeed maxgabisdncallspeed <"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 for ISDN calls when followed by a valid speed value. valid speedValid speeds are: 2x64, 128, 256, 384, 512, 768, 1024, and 1472. get Note Displays the current valid speed. The ViewStation EX system supports speeds up to 768 Kbps.
ViewStation EX, ViewStation FX, and VS4000 API Guide maxtimeincall maxtimeincall [{0..99999}] maxtimeincall set [{0..99999}] maxtimeincall set maxtimeincall get Description This command sets the maximum number of minutes allowed for call length. When that time has expired in a call, you see a message asking you if you want to hang up or stay in the call. If you do not answer within one minute, the call automatically disconnects.
ViewStation EX, ViewStation FX, and VS4000 API Guide mcupassword 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 password. password Alphanumeric string. Valid characters are: 0-9, a-z (lower and upper case), -, _, @, /, ;, ,, ., \. If you want to erase the current setting, omit the parameter.
ViewStation EX, ViewStation FX, and VS4000 API Guide meetingpassword meetingpassword ["password"] meetingpassword set ["password"] meetingpassword set meetingpassword get Description This command sets the meeting password. set Sets the meeting password when followed by the password parameter. If you want to erase the current setting, omit password. get Displays the current setting. password Can be an alphanumeric string.
ViewStation EX, ViewStation FX, and VS4000 API Guide mpautoanswer mpautoanswer 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 Multipoint is set to Yes, any incoming call will be connected automatically. The screen will split into a multipoint call progress screen as the incoming call is answered.
ViewStation EX, ViewStation FX, and VS4000 API Guide User Interface Screen Location System Info>Admin Setup>General Setup: Auto Answer Multipoint --or-- System Info>User Setup: Auto Answer Multipoint mpmode mpmode Description This command sets the multipoint conference mode for the system in a multipoint call. The multipoint mode can be set to auto, discussion, presentation, or fullscreen. By default, it is set to auto.
ViewStation EX, ViewStation FX, and VS4000 API Guide User Interface Screen Location System Info>User Setup: Multipoint Mode mute mute mute near mute far get mute register mute unregister Description This command sets the near or far site mute mode. It can also set the system to register or unregister mode. In register mode, the system sends notification to the RS-232 or Telnet session when the far or near site is muted or unmuted.
ViewStation EX, ViewStation FX, and VS4000 API Guide muteautoanswercalls muteautoanswercalls 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 site when the system is in Auto Answer mode. yes Enables Mute Auto Answer Calls mode. The microphone will be muted when the system receives a call while in Auto Answer mode. no Disables Mute Auto Answer Calls mode.
ViewStation EX, ViewStation FX, and VS4000 API Guide off Disables the Near End Loop. Example nearloop on User Interface Screen Location System Info>Diagnostics>Near End Loop netmeetingip netmeetingip ["xxx.xxx.xxx.xxx"] netmeetingip set ["xxx.xxx.xxx.xxx"] netmeetingip set netmeetingip get Description This command sets the NetMeeting IP address. After a change is made, the system prompts the user for a restart. set Sets the NetMeeting IP address when followed by the xxx.xxx.xxx.
ViewStation EX, ViewStation FX, and VS4000 API Guide netstats 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 #2, and 2 is call #3). Select a number from this range to specify a remote site call for which you want to obtain network statistics.
ViewStation EX, ViewStation FX, and VS4000 API Guide tcp transmit comm protocol rcp receive comm protocol User Interface Screen Location System Info>Diagnostics>Network Stats numdigitsdid numdigitsdid <{0..24}|get> numdigitsdid <{0..24}> numdigitsdid get Description This command sets the number of digits in the DID Gateway number (E.164 dialing).
ViewStation EX, ViewStation FX, and VS4000 API Guide numdigitsext 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 is that portion of the full Number+Extension number that the Gateway will be given from the ISDN service provider as the Called Party Line Identifier. This, in turn, will be passed to the Gatekeeper for address resolution. 0..
ViewStation EX, ViewStation FX, and VS4000 API Guide numberofmonitors 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 number is 4 for ViewStation FX and VS4000 systems, and 2 for ViewStation EX systems. get Displays the current setting (1, 2, 3, or 4).
ViewStation EX, ViewStation FX, and VS4000 API Guide Example outboundcallroute gateway User Interface Screen Location System Info>Admin Setup>LAN/H.323>H.323>Gatekeeper: Outbound Call Route pause pause <0..65535> Description This command causes the command interpreter to pause before executing the next command. Pauses are useful when commands are retrieved from a script file. 0..65535 Maximum length of pause is 65535 seconds.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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> Advanced LAN Settings ping ping [count] Description This command pings the IP address of a device to check if it can be reached. This command is similar to the command testlan ping on page 155.
ViewStation EX, ViewStation FX, and VS4000 API Guide pip pip 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 window which remains in the lower right corner of the TV screen until the video call is completed. off Disables PIP mode.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 the current setting (isdnnumber, fulldidnumber, switchnumber, didextnumber, or extension). Example preferredalias isdnnumber User Interface Screen Location System Info>Admin Setup>LAN/H.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 and store up to ten preset camera positions. These ten camera presets can be distributed across the far camera and up to four near-site cameras. near set Sets a near camera preset number. Requires a parameter from {0..9}.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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>Video Network>Call Preferences: Primary Call Type Choice primarycamera primarycamera <1|2|3|4|get> Description This command sets the primary camera. It selects the camera that is used when you power on the system.
ViewStation EX, ViewStation FX, and VS4000 API Guide queuecommands queuecommands 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 screen or is displaying a popup window). Once those states have cleared, the commands can be executed. Note Certain commands can still be executed while the system is in a call progress or popup window state.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 yes User Interface Screen Location System Info>Admin Setup>LAN/H.323>Global Address>Server: Register this System When Powered On repeat repeat <{1..
ViewStation EX, ViewStation FX, and VS4000 API Guide requireacctnumtodial requireacctnumtodial 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 appropriate departments. When this option is selected, you cannot make a call without first entering an account number. This account number is saved in the GMS server database along with information specific to the call.
ViewStation EX, ViewStation FX, and VS4000 API Guide roomphonenumber roomphonenumber ["room phone number"] roomphonenumber set ["room phone number"] roomphonenumber set roomphonenumber get Description This command lets you enter the number of the phone that is located in the same room as the system. set Sets the room phone number when followed by the room phone number parameter. If you want to erase the current setting, omit the parameter. get Displays the current setting.
ViewStation EX, ViewStation FX, and VS4000 API Guide rs232 rs232 Subcommands rs232 mode rs232 flowcontrol rs232 baud <1200| 2400|9600|14400|19200|38400| 57600|115200|get> Description This command configures and monitors the RS-232 port. For more detailed information about the RS-232 interface, see “Using the RS-232 Interface,” on page 3 of this manual. mode passthru Sets the RS-232 port to passthru mode.
ViewStation EX, ViewStation FX, and VS4000 API Guide User Interface Screen Location System Info>Admin Setup>Software/Hardware>RS-232 run run <"scriptfilename"> Description This command loads a file from the flash file system and then executes the API commands contained in it. Each command needs to be placed on a single line with a as a terminator. scriptfilename Name of the script file containing the API commands to be executed.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 Wakes up the system from sleep mode. Example screen sysinfo secondarycallchoice secondarycallchoice Description This command sets the Global Address Book (GAB) Secondary Call Type Choice.
ViewStation EX, ViewStation FX, and VS4000 API Guide sendonlypreferredalias sendonlypreferredalias 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 Enables the option. no Disables the option. get Displays the current setting (yes or no). Example sendonlypreferredalias User Interface Screen Location System Info>Admin Setup>LAN/H.
ViewStation EX, ViewStation FX, and VS4000 API Guide User Interface Screen Location System Info>Admin Setup>Software/Hardware>Software: System Serial Number setaccountnumber setaccountnumber <"account number"> Description This command sets the account number that is required for dialing out. The account number is saved in the GMS database and is generally assigned by the GMS administrator. See also the related command requireacctnumtodial on page 121.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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> Preferences: Show Addresses in Address Book showpopup showpopup <"text to display"> Description This command displays a popup message box in the user interface. text to display Alphanumeric text. Must be between quotation marks.
ViewStation EX, ViewStation FX, and VS4000 API Guide sleep sleep Description This command puts the system in sleep mode. To wake the system, use the command wake. Example sleep slides slides slides select <"pres"> Description This command and its subcommands let you select and control a slide presentation. To use the following slides subcommands, you must first load the slide presentation via the Web browser.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 presentation pres from the list by name. pres is generally the name of your computer on the network. This name appears in the pcPresent “Enter your Name” field. password Enters the presentation password. start Displays the first slide.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 or received. unregister Unregisters the Telnet or RS-232 session to receive notifications about snapshots that are sent or received.
ViewStation EX, ViewStation FX, and VS4000 API Guide snapshottimeout snapshottimeout 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 minutes, the system automatically returns to live video.
ViewStation EX, ViewStation FX, and VS4000 API Guide snmpadmin snmpadmin ["admin name"] snmpadmin set ["admin_name"] snmpadmin set snmpadmin get Description This command sets the SNMP administrator name. set Sets the administrator name when followed by the admin name parameter. If you want to erase the current setting, omit admin name. get Displays the current setting. admin name SNMP administrator contact name. Character string.
ViewStation EX, ViewStation FX, and VS4000 API Guide snmpcommunity snmpcommunity ["community name"] snmpcommunity set ["community name"] snmpcommunity set snmpcommunity get Description This command sets the SNMP community name. set Sets the SNMP community name when followed by the community name parameter. If you want to erase the current setting, omit the parameter. get Displays the current setting. community name SNMP community name. Character string.
ViewStation EX, ViewStation FX, and VS4000 API Guide snmpconsoleip snmpconsoleip ["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 console IP address when followed by the xxx.xxx.xxx.xxx parameter. If you want to erase the current setting, omit the parameter. get Displays the current setting. xxx.xxx.xxx.xxxIP address of the console. Example snmpconsoleip set 192.168.1.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 marks around a compound name or strings containing spaces (Ex: “united states” or “111 222 333”). Example snmplocation set "john_EX at United States" User Interface Screen Location System Info>Admin Setup>LAN/H.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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). stdout stdout Description This command redirects the standard output to the port from which you are issuing the stdout command. on Turns on the standard output. off Turns off the standard output.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 streamannounce Description This command enables or disables streaming announcement. When this option is enabled, the names of users logged on to your system are displayed on screen. yes Enables streaming announcement.
ViewStation EX, ViewStation FX, and VS4000 API Guide streamaudioport streamaudioport ["stream audio port"] streamaudioport set ["stream audio port"] streamaudioport set streamaudioport get Description This command sets the stream audio port. By default, the audio port is a fixed port. This may be changed if a user needs to go through the firewall. set Sets the stream audio port when followed by the stream audio port parameter. If you want to erase the current setting, omit the parameter.
ViewStation EX, ViewStation FX, and VS4000 API Guide streamenable streamenable 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 Interface Screen Location System Info>Admin Setup>LAN/H.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 streamrestoredefaults streamrestoredefaults Description This command restores the stream Speed, IP Multicast Address, Number of Router Hops, Audio Port, and Video Port defaults and prints out the values.
ViewStation EX, ViewStation FX, and VS4000 API Guide streamrouterhops streamrouterhops ["number router hops"] streamrouterhops set ["number router hops"] streamrouterhops set streamrouterhops get Description This command sets the number of routers you want the streaming video to pass through. This allows you to control who can see your streaming video. set Sets the number of routers when followed by the number router hops parameter. If you want to erase the current setting, omit the parameter.
ViewStation EX, ViewStation FX, and VS4000 API Guide streamspeed 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 Kbps. 512 Sets the streaming speed at 512 Kbps. get Displays the current setting. Example streamspeed 256 User Interface Screen Location System Info>Admin Setup>LAN/H.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 16386 User Interface Screen Location System Info>Admin Setup>LAN/H.323>Streaming: Video Port subnetmask subnetmask ["xxx.xxx.xxx.xxx"] subnetmask set ["xxx.xxx.xxx.
ViewStation EX, ViewStation FX, and VS4000 API Guide systembehindnat systembehindnat 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 system is behind an H.323-aware NAT device, make sure this option is not selected or your system will not be able to make or receive calls.
ViewStation EX, ViewStation FX, and VS4000 API Guide systemname systemname ["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 letter) character including foreign language characters. The name can be any combination of alphanumeric characters up to 34 characters in length. The system name cannot be blank. set Sets the system name.
ViewStation EX, ViewStation FX, and VS4000 API Guide t120nameip t120nameip ["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 restart if this setting is changed. Note Data conferencing is only available during IP (H.320) calls and must be supported by far-site systems. set Sets the t120 name or IP address when followed by the name or ip parameter.
ViewStation EX, ViewStation FX, and VS4000 API Guide tcpports tcpports [{1024..49150}] tcpports set [{1024..49150}] tcpports set tcpports 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 from the range {1024..49150}. If you want to erase the current setting, omit the value. get Displays the current TCP port setting. 1024..49150Range of available TCP ports.
ViewStation EX, ViewStation FX, and VS4000 API Guide phone numPhone 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 spaces (Ex: “united states” or “111 222 333”).
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 Code telecountrycode telecountrycode ["telephone country code"] telecountrycode set ["telephone country code"] telecountrycode set telecountrycode get Description This command sets the system’s telephone country code.
ViewStation EX, ViewStation FX, and VS4000 API Guide telenumber telenumber ["telephone number"] telenumber set ["telephone number"] telenumber set telenumber get Description This command sets the system’s telephone number. set Sets the telephone number when followed by the telephone number parameter. If you want to erase the current setting, omit the parameter. get Displays the current setting. telephone number System’s telephone number.
ViewStation EX, ViewStation FX, and VS4000 API Guide testlan arp testlan arp Description This command prints the ARP (Address Resolution Protocol) table contents. Example testlan arp testlan dcuinfo testlan dcuinfo Description This command displays miscellaneous DCU information.
ViewStation EX, ViewStation FX, and VS4000 API Guide testlan dns testlan dns 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.46.197.101 Example 2 testlan dns 216.115.108.243 Output to Example 2 testlan: yahoo.com is 216.115.108.
ViewStation EX, ViewStation FX, and VS4000 API Guide from [length|mps|reps|wait|echoport|locaport]. To print an echo message showing only the default settings, omit the parameter. length Message length in bytes. mps Number of messages per second. reps Number of times to repeat the message. wait Number of seconds to wait. echoport Port numbers to use. localport Port numbers to use. Example 1 testlan echo 192.168.1.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 100000us for next message testlan: sent=50, received=0, lost=50, delayed=0, corrupt=0 testlan: waiting 100000us for next message testlan: sent=60, received=0, lost=60, delayed=0, corrupt=0 testlan: waiting 100000us for next message tes
ViewStation EX, ViewStation FX, and VS4000 API Guide textinput 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 Note Alphanumeric string to be inserted into the selected edit box. Use quotation marks around a compound name or strings containing spaces (Ex: “united states” or “111 222 333”).
ViewStation EX, ViewStation FX, and VS4000 API Guide User Interface Screen Location System Info>Admin Setup>LAN/H.323>Global Management> Setup: Time Difference from GMT typeofservice typeofservice Description This command selects the type of service for Quality of Service. ipprecedence Selects IP precedence service. See the command ipprecedence on page 91. diffserv Selects diffServ service. See the command diffserv on page 46.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 setting. 1024..49150Range of available UDP ports. Example udpports set 3230 User Interface Screen Location System Info>Admin Setup>LAN/H.
ViewStation EX, ViewStation FX, and VS4000 API Guide usegatekeeper usegatekeeper 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 IP-to-IP LAN calls. In these situations, select the off option. off Select this option if no gatekeeper is required or if you make IP-to-IP LAN calls. specify Specifies a gatekeeper.
ViewStation EX, ViewStation FX, and VS4000 API Guide usepathnavigator usepathnavigator 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 participants and higher speeds than an embedded MCU. PathNavigator, which supports ad-hoc multipoint videoconferencing, is required to implement Conference on Demand™.
ViewStation EX, ViewStation FX, and VS4000 API Guide User Interface Screen Location System Info>Admin Setup>LAN/H.323>H.323>Gatekeeper: Dial Multipoint Calls from PathNavigator? © Polycom, Inc.
ViewStation EX, ViewStation FX, and VS4000 API Guide validateacctnum validateacctnum 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 Management System (GMS) server. If the account does not exist, the call is disconnected. yes Enables the GMS account number validation option. no Disables the GMS account number validation option.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 vcbutton play vcraudioout vcraudioout Description This command sets the VCR Audio Out Always On option. When this option is enabled, the system can operate with two VCRs, one for recording and one for play.
ViewStation EX, ViewStation FX, and VS4000 API Guide vcrrecordsource vcrrecordsource 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-site presentation. far Enables the VCR to record the far-site presentation. get Displays the current setting (auto, near or far).
ViewStation EX, ViewStation FX, and VS4000 API Guide User Interface Screen Location System Info: Software Version vgahorizpos vgahorizpos Description This command is used to calibrate the VGA input in the horizontal position. left Sets the calibration frame to the left. right Sets the calibration frame to the right.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 No Graphics vgaphase vgaphase Description This command is used to calibrate the VGA input phase. increase Increases the phase. decrease Decreases the phase. get Displays the current setting (increase or decrease).
ViewStation EX, ViewStation FX, and VS4000 API Guide vgaresolution 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 manual provided with the VGA monitor or projector for performance. 800x600 Sets the resolution to 800 pixels per line and 600 lines per video image.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 screen is only visible if a Visual Concert FX unit is connected to your system. volume volume volume set <{0..
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 waitfor Description This command is useful within script files (see the run command on page 124) to wait for a specific event before executing the next statement. This command causes the API shell to wait until a call being placed either connects or fails.
ViewStation EX, ViewStation FX, and VS4000 API Guide wake wake Description This command wakes the system from sleep mode. To put the system in sleep mode, use the command sleep. Example wake wanipaddress wanipaddress ["xxx.xxx.xxx.xxx"] wanipaddress set ["xxx.xxx.xxx.xxx"] wanipaddress set wanipaddress get Description This command sets the WAN IP address. set Sets the WAN IP address when followed by the xxx.xxx.xxx.xxx parameter. If you want to erase the current setting, omit the parameter.
ViewStation EX, ViewStation FX, and VS4000 API Guide whoami whoami Description This command displays banner information. Example display whoami Ouput Hi, my name is: Superman Here is what I know about myself: Serial Number: xxxxx Brand: Polycom Software Version: Release 5.0 FX - 14 Mar 2003 Model: VSFX4 Network Interface: PRI_T1 MP Enabled: Yes H323 Enabled: Yes IP Address: 192.168.1.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 format is supported. yes Enables wide screen video (60 fields/sec (ITU) at >= 512Kbps. no Disables wide screen video. get Displays the current setting (yes or no).
ViewStation EX, ViewStation FX, and VS4000 API Guide winsserver winsserver ["xxx.xxx.xxx.xxx"] winsserver set ["xxx.xxx.xxx.xxx"] winsserver set winsserver get Description This command sets the WINS server. After a change is made, the system prompts the user for restart. set Sets the WINS server IP address when followed by the xxx.xxx.xxx.xxx parameter. If you want to erase the current setting, omit the parameter. get Displays the WINS server setting. xxx.xxx.xxx.xxx WINS server IP address.
ViewStation EX, ViewStation FX, and VS4000 API Guide ISDN BRI Commands The following commands are specific to the ISDN BRI network interface. isdnareacode isdnareacode ["area code"] isdnareacode set ["area code"] isdnareacode set isdnareacode get Description This command sets the ISDN area code or STD code associated with the area where the system is used. set Sets the ISDN area code when followed by the area code parameter. If you want to erase the current setting, omit area code.
ViewStation EX, ViewStation FX, and VS4000 API Guide isdncountrycode isdncountrycode ["country code"] isdncountrycode set ["country code"] isdncountrycode set isdncountrycode get Description This command sets the ISDN country code associated with the country where the system is used. The system is generally able to automatically determine the country code based on the country you selected during initial system setup. set Sets the ISDN country code when followed by the country code parameter.
ViewStation EX, ViewStation FX, and VS4000 API Guide isdndialingprefix isdndialingprefix ["isdn prefix"] isdndialingprefix set ["isdn prefix"] isdndialingprefix set isdndialingprefix get Description This command sets the ISDN dialing prefix used to access an outside line if the system is behind a PBX. set Sets the ISDN prefix when followed by the isdn prefix parameter. If you want to erase the current setting, omit isdn prefix. get Displays the prefix information. isdn prefix Numeric value.
ViewStation EX, ViewStation FX, and VS4000 API Guide isdndialspeed isdndialspeed <"valid speed"> isdndialspeed set <"valid speed"> isdndialspeed get <"valid speed"> Description This command enables or disables the ISDN dialing speed valid speed. set Sets the command. The parameters valid speed and on or off are required. get Displays the current setting for this option (on or off). The parameter valid speed is required.
ViewStation EX, ViewStation FX, and VS4000 API Guide isdnnum isdnnum <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 <1b1|1b2|2b1|2b2|3b1|3b2|4b1|4b2> Description This command sets the ISDN video number or numbers assigned to the system. set <1b1..4b2> Sets the ISDN video number for a B channel line when followed by the isdn number parameter.
ViewStation EX, ViewStation FX, and VS4000 API Guide spidnum spidnum <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 get <1b1|1b2|2b1|2b2|3b1|3b2|4b1|4b2> Description This command sets the ISDN SPID number or numbers assigned to the system. SPIDs generally apply only in the United States and Canada.
ViewStation EX, ViewStation FX, and VS4000 API Guide ISDN PRI Commands The following commands are specific to the ISDN PRI network interface. priareacode priareacode ["area code"] priareacode set ["area code"] priareacode set priareacode get Description This command sets the PRI area code. set Sets the PRI area code when followed by the area code parameter. If you want to erase the current setting, omit area code. get Displays the current setting.
ViewStation EX, ViewStation FX, and VS4000 API Guide pricallbycall pricallbycall [{0..31}] pricallbycall set [{0..31}] pricallbycall set pricallbycall 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 upstream telephone company switch, if required. For example, specify a value of 6 for a T1 PRI network interface module that is directly connected to an ATT 5ESS switch, which is provisioned with Accunet.
ViewStation EX, ViewStation FX, and VS4000 API Guide prichannel prichannel }> prichannel set all prichannel set <{1..23}> prichannel set <{1..30}> prichannel set prichannel get all prichannel get <{1..23}> prichannel get <{1..30}> Description This command selects the PRI channels that will be active for the PRI line. set Sets the PRI channels to be active when followed by a parameter from
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 interface connected to your ViewStation FX or VS4000 system. Important PRI Channel Information Outgoing Call.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 17-31. pricsu pricsu Description This command sets the PRI CSU mode for a T1 interface. By default, the T1 PRI network interface module is set for internal CSU mode. internal Sets the internal CSU mode.
ViewStation EX, ViewStation FX, and VS4000 API Guide pridialchannels pridialchannels <{1..12|15}> pridialchannels set <{1..12}> pridialchannels set <{1..15}> pridialchannels set pridialchannels get Description This command sets the number of PRI channels to dial in parallel. By default, ISDN channels are dialed three at a time. On PRI systems, you can choose the number of channels to dial in parallel.
ViewStation EX, ViewStation FX, and VS4000 API Guide priintlprefix priintlprefix ["prefix"] priintlprefix set ["prefix"] priintlprefix set priintlprefix get Description This command sets the PRI international dialing prefix.The international prefix defaults to 011 for North America and 00 for European countries. The default depends on the country. set Sets the PRI international dialing prefix when followed by the parameter prefix. If you want to erase the current setting, omit the parameter.
ViewStation EX, ViewStation FX, and VS4000 API Guide prilinebuildout prilinebuildout <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> prilinebuildout get Description This command sets the PRI line buildout for a T1 interface. If you are using an internal CSU, enter the output attenuation in dB. If you are using an external CSU, enter the output attenuation in feet.
ViewStation EX, ViewStation FX, and VS4000 API Guide prilinesignal prilinesignal prilinesignal set prilinesignal get Description This command sets the PRI line signal. set Sets the PRI line signal. It requires a parameter from . get Displays the current PRI line signal setting. esf/b8zs A method of signal encoding used with a T1 interface. This is the only choice for T1.
ViewStation EX, ViewStation FX, and VS4000 API Guide prinumber prinumber ["pri number"] prinumber set ["pri number"] prinumber set prinumber get Description This command sets the PRI video number. set Sets the PRI video number when followed by the parameter pri number. If you want to erase the current setting, omit the parameter. get Displays the current setting. pri number Numeric string. This number is provided by your network service provider.
ViewStation EX, ViewStation FX, and VS4000 API Guide prinumberingplan prinumberingplan 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 international, is determined from the dialed phone number.
ViewStation EX, ViewStation FX, and VS4000 API Guide prioutsideline prioutsideline ["outside_line"] prioutsideline set ["outside_line"] prioutsideline set prioutsideline get Description This command sets the PRI number that is dialed for outside line access. This number is needed if your system is on a PBX. set Sets the outside-line-access PRI number when followed by the parameter outside_line. If you want to erase the current setting, omit the parameter. get Displays the current setting.
ViewStation EX, ViewStation FX, and VS4000 API Guide priswitch priswitch priswitch set priswitch get Description This command sets the PRI switch. If more than one switch protocol is supported, you must find out from your telephone service provider which protocol to select. NET5/CTR4 is the default. It is the standard ETSI protocol derived from ITU Q.931.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 cts Description This command lets you configure the cts serial interface control signal (clear to send). The default setting for this signal is normal. normal Sets the signal to normal (high voltage is logic 1). inverted Sets the signal to inverted (low voltage is logic 1).
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 V.35: DCD This screen is only accessible if you have a V.35/RS-449/RS-530/RS-366 network interface connected to your system.
ViewStation EX, ViewStation FX, and VS4000 API Guide dsr dsr 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 voltage is logic 1). inverted Sets the signal to inverted (low voltage is logic 1). get Displays the current setting (normal or inverted).
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 to your system. dtr dtr Description This command lets you configure the dtr serial interface control signal (data terminal ready). The default setting for this signal is normal.
ViewStation EX, ViewStation FX, and VS4000 API Guide h331audiomode h331audiomode Description This command sets the H.331 audio protocol for transmitting audio in broadcast mode. Broadcast configuration parameters should be set to accommodate the lowest common denominator of the systems which are receiving the broadcast. g728 ITU-T Recommendation for audio encoding using Low Delay Code Excited Linear Prediction (CELP).
ViewStation EX, ViewStation FX, and VS4000 API Guide User Interface Screen Location System Info>Admin Setup>Video Network>Video Network> Broadcast Mode Setup: Audio Mode This screen is only accessible if you have a V.35/RS-449/RS-530/RS-366 network interface connected to your system. h331framerate h331framerate <30|15|10|7.5|get> Description This command sets the H.331 video frame rate for the broadcast transmission.
ViewStation EX, ViewStation FX, and VS4000 API Guide h331videoprotocol h331videoprotocol 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 of the systems which are receiving the broadcast. h263 Video protocol based on an enhanced video algorithm. Only far-end systems that support H.263 can receive H.263. h261 Standard video protocol used to transmit video.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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> Broadcast Mode Setup: Video Format This screen is only accessible if you have a V.35/RS-449/RS-530/RS-366 network interface connected to your system. rs366dialing rs366dialing Description This command sets RS-366 dialing.
ViewStation EX, ViewStation FX, and VS4000 API Guide rt rt 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 (rising edge receives data). inverted Sets the signal to inverted (falling edge receives data). get Displays the current setting for this option (normal or inverted).
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 system. st st Description This command lets you configure the st serial interface control signal (send timing: clock). The default setting for this signal is normal.
ViewStation EX, ViewStation FX, and VS4000 API Guide v35broadcastmode v35broadcastmode 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). Example v35broadcastmode on User Interface Screen Location System Info>Admin Setup>Video Network>Video Network: Broadcast Mode This screen is only accessible if you have a V.
ViewStation EX, ViewStation FX, and VS4000 API Guide v35dialingprotocol v35dialingprotocol 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 dedicated connection to the far site. rs366 Enables RS-366 as the dialing protocol. At this time, RS-366 is the only supported dialing protocol on the system. get Displays the current setting.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 setting, omit the parameter. get <1b1|1b2> Displays the current ISDN video number associated with a B channel of a particular line. 1b1|1b2 B1 and B2 channels: 1b1 designates line 1, B channel 1 (B1). 1b2 designates line 1, B channel 2 (B2).
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 connected to your system. v35prefix v35prefix <"valid speed"> ["value"] v35prefix set <"valid speed"> ["value"] v35prefix set <"valid speed"> v35prefix get <"valid speed"> Description This command sets the V.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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. Note The ViewStation EX system supports speeds up to 768 Kbps. Example v35prefix set 112 ”#005” This command associates the dialing prefix 005 to the speed 112.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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, prefix or suffix) of the current profile. Example 1 v35profile adtran_isu512 Selects adtran_isu512 as the profile. Example 2 v35profile view Output to Example 2 This example assumes adtran_isu512 as the current profile.
ViewStation EX, ViewStation FX, and VS4000 API Guide System Info>Admin Setup>Video Network>Video Network> Advanced Dialing This screen is only accessible if you have a V.35/RS-449/RS-530/ RS-366 network interface connected to your system. v35suffix v35suffix <"valid speed"> ["value"] v35suffix set <"valid speed> ["value"] v35suffix set <"valid speed"> v35suffix get <"valid speed"> Description This command sets the V.35/RS-449/RS-530/RS-366 dialing suffix.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 only accessible if you have a V.35/RS-449/RS-530/RS-366 network interface connected to your system. 210 www.polycom.
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 with a current rating at least equal to that of the system. • Always disconnect the system from power before cleaning and servicing and when not in use. • Do not spray liquids directly onto the system when cleaning.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 accident, misuse, service or modification by anyone other than a Polycom, Inc. authorized service facility/dealer. The warranty is limited to the original purchaser and is not transferable. Any liability of Polycom, Inc.
Safety and Legal Notices Part 68 FCC Rules This equipment complies with Part 68 of the FCC rules. On the label of this equipment is a label that contains, among other information, the FCC registration number and ringer equivalence number (REN) for this equipment. If requested, this information must be provided to the telephone company. This equipment may not be used on a coin service or party line.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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 consist of any combination of devices subject only to the requirement that the sum of the RENs of all the devices does not exceed 5.
Safety and Legal Notices Dichiarazione di conformità: Con la presente Polycom Ltd. dichiara che il ViewStation EX/FX/VS4000 soddisfa i requisiti essenziali e le altre disposizioni pertinenti della direttiva 1999/5/CE. Verklaring van overeenstemming: Hierbij verklaart Polycom Ltd. dat diens ViewStation EX/FX/VS4000 voldoet aan de basisvereisten en andere relevante voorwaarden van EG-richtlijn 1999/5/EG. Declaração de Conformidade: Através da presente, a Polycom Ltd.
ViewStation EX, ViewStation FX, and VS4000 API Guide 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. Installation Instructions Installation must be performed in accordance with all relevant national wiring rules. 216 www.polycom.
