Page 1 Integrator's Reference Manual for the VSX Series July 2004 Edition 3725-21905-001/A...
Page 2: Patent Information
(e.g. a book or sound recording). Every effort has been made to ensure that the information in this manual is accurate. Polycom, Inc. is not responsible for printing or clerical errors. Information in this document is subject to change without notice.
Page 3: Table Of Contents
Using the API with an RS-232 Interface .................... 2 - 1 Configuring the RS-232 Interface ....................2 - 1 Starting an API Session via an RS-232 Interface ............... 2 - 2 Using the API with a LAN Connection ..................... 2 - 2 © Polycom, Inc.
Page 4 Integrator's Reference Manual for the VSX Series Chapter 3 - System Commands Syntax Conventions ..........................3 - 2 Alphabetical List of Commands ......................3 - 3 API Commands ........................... 3 - 11 Audio Commands ..........................3 - 16 Call Commands ..........................3 - 20 Camera Control Commands ......................
Page 5: Chapter 1 - Cables
PIN 8 12 FEET +/- 3" This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 6: Isdn Cable
50 ft (15 m) VSX 8000 This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 7: Analog Telephone (Pots) Cable
Maximum Approved Length: 100 ft (30 m) This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 8: V.35/Rs-449/Rs-530 Adapter
(15.23 cm) VSX 8000 This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 9: V.35 Cable
VSX 8000 This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 10: V.35 And Rs-366 Serial Cable
34M/RS-366 VSX 8000 This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 11: Rs-449 And Rs-366 Serial Cable
DB-37M/RS-366 DB-25M VSX 8000 This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 12: Rs-530 With Rs-366 Serial Cable
DB-37M/RS-366 DB-25M VSX 8000 This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 13: Video And Camera Cables
25 FEET +/- 2" WIRING DIAGRAM This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 14: Bnc To S-Video Cable
2457-21489-001 Shipped Length: 6 ft (1.8 m) This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 15: Bnc To S-Video Adapter
2457-21490-001 Shipped Length: 1 ft (.33 m) This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 16: Vcr/Dvd Composite Cable
4-pin mini-DIN adapter) This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 17: Vga Cable
VSX 8000 This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 18: Composite Video Cable
100 ft (30 m) ite adapter) This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 19: Powercam Plus Primary Cable
Luma Chroma Chroma This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 20: Powercam Primary Cable
DRAIN wire SHIELD This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 21: Powercam Secondary Break-Out Cable
DRAIN wire SHIELD This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 22: Powercam Secondary Control Cable (Vsx 8000)
IR RETURN SHIELD SHIELD This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 23: Powercam Secondary Control Cable (Vsx 7000)
2457-21713-001 Shipped Length: 25 ft (7.6 m) This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 24: S-Video To Rca Adapter
1517-08822-002 Shipped Length: 2 in This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 25: Audio Cables
TWISTED PAIR SPIRAL SHIELD This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 26 TWISTED PAIR SPIRAL SHIELD This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 27: Audio Cable
25 FEET +/- 3" WIRING DIAGRAM This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 28: Vortex Cable
P9-3 SHIELD (DRAIN WIRE) This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 29: Vsx To Vtx Cable
VSX 8000 50 ft (15 m) This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 30: Visual Concert To Vsx Cable
Maximum Approved Length: This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 31: Serial (Rs-232) Cables
RS-232 Cable, 10 ft This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 32 Integrator's Reference Manual for the VSX Series RS-232 Cable, 50 ft This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 33: Cable (Vsx 8000)
Length: 100 ft (30 m) This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 34: Rs-232 Adapter
TXD/RXD ALL OTHERS N/C This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 35: Null Modem Cable
2457-21714-001 Shipped Length: 25 ft (7.6 m) This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 36: Null Modem Adapter
9 PIN MALE D-SUB CONNECTOR This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 37: Content Sharing Cables
Shipped Length: 6 ft (1.8 m) connectors on both ends This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 38: Imageshare Ii To Pc Cable
SLEEVE WHITE SHIELD This drawing is provided for design reference only. Polycom claims no responsibility or liability for the quality, performance and/or reliability of cables based on this reference drawing. Cables are available from Polycom that meet the appropriate manufacturing tolerances, quality and performance parameters.
Page 39: Chapter 2 - Using The Api
Using the API This section describes the API commands for software version 7.0. The VSX Series Application Programming Interface (API) is a set of commands for advanced users who want to automate a VSX system. You can use the API by connecting a computer’s RS-232 (serial) port to the VSX system.
Page 40: Starting An Api Session Via An Rs-232 Interface
Integrator's Reference Manual for the VSX Series The RS-232 port on the VSX system supports two modes: Control and Pass-Thru. In Control Mode, a device (for example, a PC) connected to the RS-232 port can control the system using the Remote Control API.
Page 41: Chapter 3 - System Commands
Call Commands Camera Control Commands Diagnostics and Statistics Commands IP Commands ISDN Commands Peripherals Commands Polycom Tools Commands Security and Permissions Commands Video Commands For a list of all the commands in alphabetical order, see the Alphabetical List of Commands...
Page 42: Syntax Conventions
Integrator's Reference Manual for the VSX Series Syntax Conventions The following conventions are used for the API commands. All of the commands are case sensitive Convention Meaning <param> Required parameter. Multiple parameters are separated by the pipe (“|”) character. <param1|param2>...
Page 43: Alphabetical List Of Commands
3-44 Diagnostics calldetailreport command on page 3-22 Call callencryption command on page 3-108 Security and Permissions, Call callpreference command on page 3-22 Call callstate command on page 3-45 Diagnostics and Statistics, Call © Polycom, Inc. 3 - 3...
Page 44 Integrator's Reference Manual for the VSX Series Command Category camera command on page 3-39 Camera Control cameradirection command on page 3-40 Camera Control chaircontrol command on page 3-24 Call colorbar command on page 3-45 Diagnostics and Statistics colorscheme command on page 3-46...
Page 45 3-47 Diagnostics and Statistics gmscity command on page 3-94 Polycom Tools gmscontactemail command on page 3-94 Polycom Tools gmscontactfax command on page 3-94 Polycom Tools gmscontactnumber command on Polycom Tools page 3-95 © Polycom, Inc. 3 - 5...
Page 46 Integrator's Reference Manual for the VSX Series Command Category gmscontactperson command on Polycom Tools page 3-95 gmscountry command on page 3-95 Polycom Tools gmsstate command on page 3-96 Polycom Tools gmstechsupport command on page 3-96 Polycom Tools gmsurl command on page 3-96...
Page 47 3-50 Diagnostics and Statistics command on page 3-112 Call, Video popupinfo command on page 3-100 Polycom Tools preset command on page 3-41 Camera Control priareacode command on page 3-72 ISDN © Polycom, Inc. 3 - 7...
Page 48 Integrator's Reference Manual for the VSX Series Command Category pricallbycall command on page 3-72 ISDN prichannel command on page 3-73 ISDN pricsu command on page 3-74 ISDN pridialchannels command on page 3-74 ISDN priintlprefix command on page 3-74 ISDN prilinebuildout...
Page 49 Diagnostics and Statistics teleareacode command on page 3-36 Call telecountrycode command on page 3-37 Call telenumber command on page 3-37 Call testlan command on page 3-52 Diagnostics and Statistics textinput command on page 3-104 Polycom Tools © Polycom, Inc. 3 - 9...
Page 50 Integrator's Reference Manual for the VSX Series Command Category timediffgmt command on page 3-104 Polycom Tools traceroute command on page 3-104 Polycom Tools typeofservice command on page 3-67 udpports command on page 3-67 usefixedports command on page 3-67 usegatekeeper command on page 3-67...
Page 51: Api Commands
->!1 gatewaynumber set 123456789 gatewaynumber 123456789 restart system for changes to take effect. restart now? <y,n> ->!2 hangup video hanging up video call ->!h hangup video hanging up video call © Polycom, Inc. 3 - 11...
Page 52 Integrator's Reference Manual for the VSX Series Command Syntax Description Example ! (continued) ->!hi history gatewaynumber set 123456789 hangup video history gatewaynumber set 123456789 hangup video hangup video history ->!gat gatewaynumber set 123456789 gatewaynumber 123456789 restart system for changes to take effect.
Page 53 If you do not enable this • no: Disables this option. option, the system has access to the GDS, but the IP address • get: Returns the current setting (yes does not appear in the Global or no). Directory. © Polycom, Inc. 3 - 13...
Page 54 Integrator's Reference Manual for the VSX Series Command Syntax Description Example repeat repeat <{1..n}> Allows you to repeat a specified The following is a command from the history list. sample history list Where: For more information about the containing the •...
Page 55 IP Video Number: 216.54.150.47 ISDN Video Number: MP Enabled: g H323 Enabled: True FTP Enabled: True HTTP Enabled: True SNMP Enabled: True NIC Slot 1 SW Ver: 6.03 NIC Slot 1 Boot Ver: 0.02 © Polycom, Inc. 3 - 15...
Page 56: Audio Commands
Integrator's Reference Manual for the VSX Series Audio Commands Command Syntax Description Example audiotrans- audiotransmitlevel Sets or gets the audio volume audiotransmitlev <up|down|set|get|register|unregist mitlevel transmitted to the far site. Used el up er> [-20..30] when a control system needs to...
Page 57 • off: Turns the midrange speaker off. System > Admin Settings > • get: Returns the current setting (on Audio (page 3): Midrange or off). Speaker Note: This option is only avail- able when stereo audio is disabled. © Polycom, Inc. 3 - 17...
Page 58 Integrator's Reference Manual for the VSX Series Command Syntax Description Example mute mute <register|unregister|near|far> Sets the near or far site mute mute near on mode. Also sets the system to mute near <on|off|toggle|get> register or unregister mode. In mute far get...
Page 59 Requires a volume setting from Audio (page 3): Master Audio {0..50}. Volume • up: Increases the audio volume by 1. • down: Decreases the audio volume by 1. • get: Returns the current volume level. © Polycom, Inc. 3 - 19...
Page 60: Call Commands
Integrator's Reference Manual for the VSX Series Call Commands abk entries are entries stored on the VSX system. gabk entries are entries stored on the GDS. On the user interface screens, the Address Book and Global Address Book features are referred to as Directory and Global Directory.
Page 61 Allow Streaming answer answer video Answers incoming video calls. answer video Where: • video: Answers incoming video calls when the Auto Answer Point to Point or Auto Answer Multipoint option is set to No. © Polycom, Inc. 3 - 21...
Page 62 Integrator's Reference Manual for the VSX Series Command Syntax Description Example autoanswer autoanswer Sets the Auto Answer Point to autoanswer <yes|no|donotdisturb|get> Point mode, which determines donotdisturb how the system will handle an Where: incoming call in a point-to-point • yes: Allows any incoming call to be video conference.
Page 63 [RINGING] cs: call[0] chan[0] dialstr[IP:192.16 8.1.103] state [RINGING] cs: call[0] chan[0] dialstr[IP:192.16 8.1.103] state [CONNECTED] cs: call[0] chan[0] dialstr[IP:192.16 8.1.103] state [COMPLETE] active: call[0] speed[128] cleared: call[0] line[0] bchan[0] cause[16] dialstr[IP:192.16 8.1.103] ended: call[0] © Polycom, Inc. 3 - 23...
Page 64 Integrator's Reference Manual for the VSX Series Command Syntax Description Example chaircontrol chaircontrol Used for various chair control chaircontrol <rel_chair|req_chair|req_floor|req functions while the system is in req_term_name 2 _term_name|req_vas|view|view_ a multipoint call. broadcaster|list|set_password|set User interface screen location: _broadcaster|set_term_name| When in a multipoint call, press hangup_term|end_conf><register|...
Page 65 • set: Sets the number of channels to System > Admin Settings > dial. Network > ISDN • get: Returns the current setting. • 1..N: is number of ISDN lines. N is 8 for QBRI, 23 and 30 for the PRI. © Polycom, Inc. 3 - 25...
Page 66 Integrator's Reference Manual for the VSX Series Command Syntax Description Example diffservau- diffservaudio <set|get> Lets you enable the DiffServ diffservaudio set dio, option and specify a priority diffservaudio set <{0..63}> diffserv- level for audio, far-end camera diffservfecc <set|get> fecc, control (FECC), and video, diffservfecc set <{0..63}>...
Page 67 “call” parameter is not used. • {1..3}: Selects which call in a multipoint call to hang up. The number corresponds to the order in which endpoints were connected to the call. © Polycom, Inc. 3 - 27...
Page 68 Integrator's Reference Manual for the VSX Series Command Syntax Description Example ipdialspeed ipdialspeed <set|get><“valid Sets or gets the valid IP dialing ipdialspeed get speed”><on|off> speed, and enables or disables the specified speed. returns: Where: User interface screen location: ipdialspeed 168 •...
Page 69 • set: Sets the maximum speed for international calls when followed by a valid speed value. • get: Returns the current valid speed. • “valid speed”: Valid speeds are: 2x64, 128, 256, 384, 512, 768, 1024, and 1472 kbps. © Polycom, Inc. 3 - 29...
Page 70 Integrator's Reference Manual for the VSX Series Command Syntax Description Example maxgabin- maxgabinternetcallspeed Sets or gets the maximum maxgabinternetcal <set|get><“valid speed”> ternetcallsp speed for Internet (IP/H.323) lspeed set 384 calls made from the Global Where: Directory. • set: Sets the maximum speed for Internet calls when followed by a valid speed value.
Page 71 • donotdisturb: The user is not notified of incoming calls. The sites that placed the calls receive a Far Site Busy (H.320) or Call Rejected (H.323) code. • get: Returns the status of the option (yes, no, or donotdisturb). © Polycom, Inc. 3 - 31...
Page 72 Integrator's Reference Manual for the VSX Series Command Syntax Description Example mpmode mpmode Sets or gets the multipoint mpmode discussion <auto|discussion|presentation|full conference viewing mode for the screen|get> system in a multipoint call. The multipoint mode can be set to Where: auto, discussion, presentation, •...
Page 73 Telephone screen of the user • clear: Clears any dialstring from the interface. text box on the Telephone screen. User interface screen location: Telephone > Flash button and Clear button © Polycom, Inc. 3 - 33...
Page 74 Integrator's Reference Manual for the VSX Series Command Syntax Description Example pip <on|off|auto|swap|get> Sets the on-screen PIP mode. pip auto The PIP feature allows the near Where: site to adjust near-camera views • on: Enables PIP mode. The while in a video conference.
Page 75 System > Admin Settings > telephone (not the VSX system) in General Settings > Location: the room. Use quotation marks Room Telephone Number around the number if it contains spaces. For example: “512 555 1212”. © Polycom, Inc. 3 - 35...
Page 76 Integrator's Reference Manual for the VSX Series Command Syntax Description Example setaccount- setaccountnumber <“account”> Sets the account number that is setaccountnumber number required for dialing out. The 1234 Where: account number is saved in the “account”: • Number that is needed...
Page 77 User interface screen location: System > Admin Settings > Global Services > Account Validation: Validate Account Number Note: This option is only avail- able if the Required Account Number to Dial is enabled. © Polycom, Inc. 3 - 37...
Page 78 Integrator's Reference Manual for the VSX Series Command Syntax Description Example vcbutton vcbutton Simulates the Visual Concert vcbutton play <play|stop|get|register|unregister VSX play and stop buttons. It > can also register or unregister to receive notification of Visual Where: Concert VSX events.
Page 79: Camera Control Commands
<near|far> move stop command is sent. discrete: Selects discrete movement mode. The camera will move a small amount in the direction specified and then stop. No stop command is required. © Polycom, Inc. 3 - 39...
Page 80 Integrator's Reference Manual for the VSX Series Command Syntax Description Example camera left: Starts moving the camera to (continued) the left. right: Starts moving the camera to the right. up: Starts moving the camera up. down: Starts moving the camera down.
Page 81 • get: Returns the number of the mary camera. camera currently designated as the User interface screen location: primary camera. System > Admin Settings > Cameras: Primary Camera © Polycom, Inc. 3 - 41...
Page 82: Diagnostics And Statistics Commands
Integrator's Reference Manual for the VSX Series Diagnostics and Statistics Commands Command Syntax Description Example advnetstats advnetstats [{0..2}] Gets advanced network statis- advnetstats 1 tics for a call. Where: returns: User interface screen location: • 0..2: Calls in a multipoint call, where call:1 tar:24k System >...
Page 83 (H.320 calls only) Transmit video jitter (H.323 calls only) tmlpr Transmit MLP rate (H.320 calls only) Receive video jitter (H.323 calls only) rmlpr Receive MLP rate (H.320 calls only) Data conference rsid Remote system id © Polycom, Inc. 3 - 43...
Page 84 Integrator's Reference Manual for the VSX Series Command Syntax Description Example audiometer audiometer Displays levels and peak of audiometer farin <micpod|farin|linein|visualconcert audio inputs. This command might return something |vcr|aux|off> queries and prints the audio like this: levels 10 times per second.
Page 85 Where: User interface screen location: • on: Turns on the color bar test System > Diagnostics > Video pattern. • off: Turns off the color bar test pattern. © Polycom, Inc. 3 - 45...
Page 86 Integrator's Reference Manual for the VSX Series Command Syntax Description Example color- colorscheme <1|2|3|4|5> Customizes the look of the colorscheme 4 scheme VSX system with different color Where: schemes. • 1, 2, 3, 4, 5: Sets the system color User interface screen location: scheme.
Page 87 3-45. 0.82] User interface screen location: state[connected] System > Diagnostics > Call cs: call[1] Statistics inactive cs: call[2] inactive © Polycom, Inc. 3 - 47...
Page 88 Integrator's Reference Manual for the VSX Series Command Syntax Description Example lanstat lanstat Returns local area network Example 1 <min|misc|reset|sec|tmin|total> statistics. lanstat min 1 lanstat min [“time”] returns information lanstat tmin [“time”] similar to this: Where: lanstat: LAN • sec: Returns the accumulating total...
Page 89 • off: Disables the Near End Loop. perform a near-end loop test during a call, the far site sees a loop of itself. User interface screen location: System > Diagnostics > Net- work: Near End Loop © Polycom, Inc. 3 - 49...
Page 90 Integrator's Reference Manual for the VSX Series Command Syntax Description Example netstats netstats [{0..2}] Returns network statistics for netstats 2 each call. Where: returns information User interface screen location: similar to this: • 0..2: Calls in a multipoint call, where System >...
Page 91 Info button or Help button and string in quotation marks if it select Support includes spaces. Example: “512 555 Note: The Support icon is visi- 1212” ble only when the system is registered with the Polycom Global Management System. © Polycom, Inc. 3 - 51...
Page 92 Integrator's Reference Manual for the VSX Series Command Syntax Description Example testlan testlan <arp|dcuinfo|dns|echo|ping> Allows you to retrieve Example 1 information about the LAN, or testlan arp testlan arp test network connectivity. testlan dcuinfo returns information testlan dns similar to this: <“dnsname”|”ipaddress”>...
Page 93 • “localport”: Port numbers to use. received=30, lost=0, delayed=0, corrupt=0 testlan: sent=40, received=40, lost=0, delayed=0, corrupt=0 testlan: sent=50, received=50, lost=0, delayed=0, corrupt=0 testlan: sent=60, received=60, lost=0, delayed=0, corrupt=0 testlan: sent=70, received=70, lost=0, delayed=0, corrupt=0 © Polycom, Inc. 3 - 53...
Page 94 Integrator's Reference Manual for the VSX Series Command Syntax Description Example testlan testlan: sent=80, (continued) received=0, lost=80, delayed=0, corrupt=0 testlan: waiting 100000us for next message testlan: sent=90, received=0, lost=90, delayed=0, corrupt=0 testlan: waiting 100000us for next message testlan: sent=100, received=0,...
Page 95 EORATE>464 K</VIDEORATE><VID EORATEUSED>199 K</VIDEORATEUSED> <VIDEOFRAMERATE>3 0.2</VIDEOFRAMERA TE><VIDEOPACKETLO SS>0</VIDEOPACKET LOSS><VIDEOJITTER >3 mS</VIDEOJITTER>< AUDIOPACKETLOSS>0 </AUDIOPACKETLOSS ><AUDIOJITTER>0 mS</AUDIOJITTER>< LSDPROTOCOL>---</ LSDPROTOCOL><LSDR ATE>---</LSDRATE> <MLPPROTOCOL>---< /MLPPROTOCOL><MLP RATE>---</MLPRATE ></TRANSMIT><RECE IVE><AUDIORATE>48 K</AUDIORATE><VID EORATE>464 K</VIDEORATE><VID EORATEUSED>114 K</VIDEORATEUSED> <VIDEOFRAMERATE>2 9.8</VIDEOFRAMERA TE><VIDEOPACKETLO SS>0</VIDEOPACKET LOSS><VIDEOJITTER >5 © Polycom, Inc. 3 - 55...
Page 96 Integrator's Reference Manual for the VSX Series Command Syntax Description Example xmladvnet- mS</VIDEOJIT- stats TER><AUDIOPACKETL (continued) OSS>0</AUDIOPACK- ETLOSS><AUDIOJITT ER>3 mS</AUDIOJIT- TER><LSDPROTOCOL> ---</LSDPROTO- COL><LSDRATE>---< /LSDRATE> <MLPPROTOCOL>---< /MLPPROTOCOL><MLP RATE>---</MLPRATE ></RECEIVE><VIDEO FECERRORS>0</VIDE OFECERRORS><ENCRY PTION>Disabled</E NCRYPTION></CONNE CTION></ADVANCED> xmlnetstats xmlnetstats [{0..2}] Gets network statistics in xml for xmlnetstats might each call.
Page 97 %</PERCENTPACKETL (continued) OSS><VIDEOPROTOCO L>H.264</VIDEOPRO TOCOL><VIDEOANNEX >---</VIDEOANNEX> <VIDEOFORMAT>SIF< /VIDEOFORMAT><AUD IOPROTOCOL>Siren1 4</AUDIOPROTOCOL> </TRANSMIT><RECEI VE><CALLSPEED>512 K</CALLSPEED><B2C ALLSPEED>---</B2C ALLSPEED><TOTPACK ETLOSS>0</TOTPACK ETLOSS><PERCENTPA CKETLOSS>0.0 %</PERCENTPACKETL OSS><VIDEOPROTOCO L>H.264</VIDEOPRO TOCOL><VIDEOANNEX >---</VIDEOANNEX> <VIDEOFORMAT>SIF< /VIDEOFORMAT><AUD IOPROTOCOL>Siren1 4</AUDIOPROTOCOL> </RECEIVE><ERRORS >---</ERRORS><B2E RRORS>---</B2ERRO RS><SYNC>---</SYN C><B2SYNC>---</B2 SYNC></CONNECTION ></NETWORK> © Polycom, Inc. 3 - 57...
Page 98: Ip Commands
Integrator's Reference Manual for the VSX Series IP Commands Command Syntax Description Example defaultgate- defaultgateway <set|get> Sets the default gateway. This defaultgateway [“ipaddress”] setting can only be changed if set 192.168.1.5 DHCP is turned off. After Where: making a change, the user is •...
Page 99 “ipaddress”. option on the same page must • get: Returns the current setting. be set to Auto or Specify for the • “e.164name”: IP address of the Gatekeeper IP Address to be gatekeeper. available. © Polycom, Inc. 3 - 59...
Page 100 Integrator's Reference Manual for the VSX Series Command Syntax Description Example gatewa- gatewayareacode <set|get> Sets the gateway area code. gatewayareacode [“areacode”] yareacode set 512 User interface screen location: gateway area code Where: System > Admin Settings > Network > IP > H.323 Settings •...
Page 101 1600, 1624, 1664, 1680, 1728, 1736, 32x56, 28x64, 1848, 1856, 1904, and 1920 kbps. • “value”: Prefix (code) used for a particular call speed. Consult your gateway instruction manual to determine which codes are appropriate. © Polycom, Inc. 3 - 61...
Page 102 Integrator's Reference Manual for the VSX Series Command Syntax Description Example gateway- gatewaysetup Lists all available speeds and gateway setup setup values at once. returns: User interface screen location: System > Admin Settings > Network > IP > H.323 Settings...
Page 103 If the system name does not conform to these rules, the invalid characters are removed from the system name. If the resulting string is empty, the default LAN host name is Admin. © Polycom, Inc. 3 - 63...
Page 104 Integrator's Reference Manual for the VSX Series Command Syntax Description Example ipaddress ipaddress <set|get> [“ipaddress”] Sets the LAN IP address of the ipaddress set VSX system. Use this command 192.168.1.111 Where: when you need to allocate a • set: Sets the LAN IP address to the static IP address to your system.
Page 105 Network > IP > H.323 Settings (page 4): Number of Digits in DID Number Note: For this option to be avail- able, the Gateway Number Type on the same page must be set to Direct Inward Dial. © Polycom, Inc. 3 - 65...
Page 106 Integrator's Reference Manual for the VSX Series Command Syntax Description Example numdigit- numdigitsext <{0..99}|get> Sets the number of digits in the numdigitsext 10 sext Number+Extension Gateway Where: number (E.164 dialing). The • {0..99}: The number of digits in the number of digits in that number...
Page 107 • get: Returns the current setting (off, specify, or auto). Note: A gatekeeper is not required to make IP-to-IP LAN calls. In these situ- ations, select the off option. © Polycom, Inc. 3 - 67...
Page 108 Integrator's Reference Manual for the VSX Series Command Syntax Description Example wanipad- wanipaddress <set|get> Sets the WAN IP address. wanipaddress set dress wanipaddress set [“ipaddress”] 192.168.1.122 User interface screen location: Where: System > Admin Settings > Network > IP > Firewall: •...
Page 109: Isdn Commands
User interface screen location: • inverted: Sets the signal to inverted System > Admin Settings > (low voltage is logic 1). Network > • get: Returns the current setting V.35/RS-449/RS-530 (page 3): (normal or inverted). © Polycom, Inc. 3 - 69...
Page 110 Integrator's Reference Manual for the VSX Series Command Syntax Description Example dcdfilter dcdfilter <on|off|get> Lets you configure the filter of dcdfilter on the dcd serial interface control Where: signal (data carrier detect). • on: Enables the dcd filter. When this filter is enabled, dcd •...
Page 111 ISDN multipoint_at&t_5_ess switch protocols is loaded. ni-1 User interface screen location: System > Admin Settings > nortel_dms-100 Network > ISDN: ISDN Switch standard_etsi_euro-isdn Protocols ts-031 ntt_ins64 • get: Returns the current switch protocol. © Polycom, Inc. 3 - 71...
Page 112 Integrator's Reference Manual for the VSX Series Command Syntax Description Example priareacode priareacode <set|get> ["area code"] Sets or gets the PRI area code. priareacode set User interface screen location: Where: System > Admin Settings > • set: Sets the PRI area code when Network >...
Page 113 1-15, 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. © Polycom, Inc. 3 - 73...
Page 114 Integrator's Reference Manual for the VSX Series Command Syntax Description Example pricsu pricsu <internal|external|get> Sets or gets the PRI CSU mode pricsu external for a T1 interface. By default, the Where: T1 PRI network interface • internal: Sets the internal CSU module is set for internal CSU mode.
Page 115 Network > IDSN (page 3): Line CSUs. Available values are Build Out -7.5 -22.5 • “attenuation in feet”: Output attenuation values in feet. For external CSUs. Available values are: 0-133 134-266 267-399 400-533 534-665 © Polycom, Inc. 3 - 75...
Page 116 Integrator's Reference Manual for the VSX Series Command Syntax Description Example prilinesignal prilinesignal <set|get> Sets or gets the PRI line signal. prilinesignal set <esf/b8zs|crc4/hdb3|hdb3> esf/b8zs User interface screen location: Where: System > Admin Settings > Network > IDSN (page 2): Line •...
Page 117 • get: Returns the current setting. Note: This screen is only acces- sible if you have a PRI network • “outside_line”: Numeric string. interface connected to a This number is provided by your VSX system. network service provider. © Polycom, Inc. 3 - 77...
Page 118 Integrator's Reference Manual for the VSX Series Command Syntax Description Example priswitch priswitch <set|get> <“switch Sets or gets the PRI switch. If priswitch set protocol”> more than one switch protocol is norteldms Where: supported, you must find out from your telephone service •...
Page 119 DCE to dial the call or if you dialing protocol. At this time, RS-366 have a dedicated connection to is the only supported dialing the far site. protocol on the system. • get: Returns the current setting. © Polycom, Inc. 3 - 79...
Page 120 Integrator's Reference Manual for the VSX Series Command Syntax Description Example v35num v35num <set|get> <1b1|1b2> ["v35 Sets or gets the ISDN video v35num set 1b1 number"] numbers assigned to the 5125551212 v35num set <1b1|1b2> ["v35 system. The 1b1 and 1b2 number"]...
Page 121 1728, 28x64, 1856, 1920, all. The parameter “all” lists all the available speeds and their associated dialing prefixes. “value”: • V.35/RS-449/RS-530 prefix, which is a function of your DCE. Consult the DCE user guide for information. © Polycom, Inc. 3 - 81...
Page 122 Integrator's Reference Manual for the VSX Series Command Syntax Description Example v35profile v35profile <“available Sets or gets a profile associated Example 1 profile”|get|view> with dialing through a DCE. It v35profile can also display all the settings Where: adtran_isu512 (speed, prefix or suffix) of the “available profile”:...
Page 123 1728, 28x64, 1856, 1920, all. The parameter “all” lists all the available speeds and their associated dialing prefixes. • “value”: The dialing suffix, which is a function of your DCE. Consult the DCE user guide for information. © Polycom, Inc. 3 - 83...
Page 124: Peripherals Commands
Integrator's Reference Manual for the VSX Series Peripherals Commands Command Syntax Description Example graphics- graphicsmonitor Sets or gets the graphics graphicsmonitor monitor <tv|fxvga|visualcon- monitor to one of three choices: fxvga cert|1|2|vcnx|get> a TV monitor, a VGA monitor, or a Visual Concert VSX monitor.
Page 125 To erase the System > Admin Settings > current setting, omit the parameter. Network > IP > Streaming: • get: Returns the current setting. Audio Port • “stream audio port”: Audio port number. © Polycom, Inc. 3 - 85...
Page 126 Integrator's Reference Manual for the VSX Series Command Syntax Description Example streamena- streamenable <yes|no|get>: Enables or disables streaming streamenable yes on the system. Where: User interface screen location: • yes: Enables streaming. System > Admin Settings > • no: Disables streaming.
Page 127 • unregister: Unregisters the Visual Concert stream. vtxstate vtxstate get Returns the current state of the vtxstate get SoundStation™ VTX 1000 con- Possible return values ference phone. vtxattached vtxattachedonhook vtxattachedoffhoo vtxdetached vtxerror © Polycom, Inc. 3 - 87...
Page 128: Polycom Tools Commands
Integrator's Reference Manual for the VSX Series Polycom Tools Commands Command Syntax Description Example all register all register Simultaneously registers all all register user feedback so that the API Registers changes to any of the reports all user actions. This...
Page 129 Example button button <“name”> Allows the user to send the Example 1 same command as the Polycom Where “name” can be: button up #: Sends the # key to the user interface. remote control to the user This command sends interface.
Page 130 Integrator's Reference Manual for the VSX Series Command Syntax Description Example button putdown: Sends signal indicating that (continued) the remote control has been set down (remote control feet are pushed in). right: Sends the right key to the user interface (right arrow).
Page 131 • no: Enables the display of the IP screen. extension. User interface screen location: • get: Returns the current setting (yes or no). System > Admin Settings > Network > IP > H.323 Settings: Display H.323 Extension © Polycom, Inc. 3 - 91...
Page 132 Integrator's Reference Manual for the VSX Series Command Syntax Description Example display- displayparams Outputs the list of all the system displayparams params settings. returns information similar to this: systemname Jw hostname Jw ipaddress 192.168.1.104 wanipaddress 192.168.1.111 version 7.0 - 31Jul2004 14:12...
Page 133 Global Services > Directory are: a through z (lower and Servers: Password uppercase), -, _, @, /, ;, ,, ., \, 0 through 9. Enclose the string in quotation marks if it includes spaces. © Polycom, Inc. 3 - 93...
Page 134 Integrator's Reference Manual for the VSX Series Command Syntax Description Example gabserverip gabserverip <set|get> [“ipaddress”] Sets the IP address of the gabserverip set Global Directory Server (GDS) gab.polycom.com Where: server. • set: Sets the GDS server’s IP User interface screen location: address when followed by the System >...
Page 135 “countryname” parameter. To erase the current setting, omit “countryname”. • get: Returns the current country setting. • “countryname”: Character string specifying the country. Enclose the string in quotation marks if it includes spaces. Example: “united states” © Polycom, Inc. 3 - 95...
Page 136 Integrator's Reference Manual for the VSX Series Command Syntax Description Example gmsstate gmsstate <set|get> [“state”] Sets the GMS state information. gmsstate set Texas Where: User interface screen location: System > Admin Settings > • set: Sets the GMS state information Global Services >...
Page 137 • no: Removes the system name from System > Admin Settings > the home screen. General Settings > Home • get: Returns the current setting (yes Screen Settings (page 2): or no). System Name © Polycom, Inc. 3 - 97...
Page 138 Integrator's Reference Manual for the VSX Series Command Syntax Description Example language language <set|get> Selects the language that will language set display on the VSX system. language set <“language”> german User interface screen location: Where: System > Admin Settings >...
Page 139 Call Detail Report. • “DNS name or ipaddress”: The DNS name or IP address of the NTP User interface screen location: server. System > Admin Settings > Network > IP > H.323 Settings > NTP Setup © Polycom, Inc. 3 - 99...
Page 140 Integrator's Reference Manual for the VSX Series Command Syntax Description Example popupinfo Registers or unregisters to popupinfo popupinfo <register|unregister> receive popup text and button register Where: choices text. later returns something • register: Registers to receive popup like this if a call fails: information.
Page 141 " showpopup showpopup <“text”> Displays a message box in the showpopup user interface. conference will Where: resume in three • “text”: Message to display to users. " minutes. Enclose the text in quotation marks. © Polycom, Inc. 3 - 101...
Page 142 Integrator's Reference Manual for the VSX Series Command Syntax Description Example snapshot- snapshottimeout <yes|no|get> Enables or disables the snapshottimeout timeout Snapshot Timeout option. By Where: default, all slides and snapshots • yes: Enables the option: the display are displayed for a period of four times out after four minutes and the minutes.
Page 143 • +3, +2, +1, 0, -1, -2, -3: Sets the subwoofer to this level dB. User interface screen location: System > Admin Settings > • get: Returns the current subwoofer Audio (page 3): Subwoofer dB level. Level © Polycom, Inc. 3 - 103...
Page 144 Integrator's Reference Manual for the VSX Series Command Syntax Description Example textinput textinput <"text to input"> Inserts text into a user interface textinput " " edit box that you have already Pacific Room Where: selected using the remote • “text to input”: Alphanumeric string control.
Page 145 VSX Web to now? <y,n> access the system. This makes unauthorized access more difficult. User interface screen location: System > Admin Settings > General Settings > Security (page 2): Web Access Port © Polycom, Inc. 3 - 105...
Page 146 Integrator's Reference Manual for the VSX Series Command Syntax Description Example winsserver winsserver <set|get> winsserver get Sets or gets the WINS server. ["xxx.xxx.xxx.xxx"] After a change is made, the system prompts you for a Where: restart. • set: Sets the WINS server IP User interface screen location: address to "xxx.xxx.xxx.xxx".
Page 147: Security And Permissions Commands
<yes|no|get> presets can be changed. ssetup no Where: • yes: Allows presets to be changed. • no: Does not allow presets to be changed. • get: Returns the current setting (yes or no). © Polycom, Inc. 3 - 107...
Page 148 Integrator's Reference Manual for the VSX Series Command Syntax Description Example allowdialing allowdialing <yes|no|get> Enables or disables the Allow allowdialing get Dialing option. Where: User interface screen location: • yes: Allows users to place calls. System > Admin Settings >...
Page 149 • manual: Specifies that the system is behind a NAT. Requires the WAN address to be assigned using the wanipaddress command on page 3-68. • off: Disables the option. • get: Returns the current setting. © Polycom, Inc. 3 - 109...
Page 150: Video Commands
Integrator's Reference Manual for the VSX Series Video Commands Command Syntax Description Example backlight- backlightcompensation Enables or disables the Back- backlightcompensa <yes|no|get> compensati light Compensation option tion no Where: User interface screen location: System > Admin Settings > • yes: Enables Backlight Cameras: Backlight Compensation.
Page 151 <1|2|get> Sets or gets the number of TV numberofmonitors monitors monitors that are connected to Where: the system. • : Sets the number of monitors allowed. • get: Returns the current setting (1 or © Polycom, Inc. 3 - 111...
Page 152 Integrator's Reference Manual for the VSX Series Command Syntax Description Example pip <on|off|auto|swap|get> Sets the on-screen PIP mode. pip auto The PIP feature allows the near Where: site to adjust near-camera views • on: Enables PIP mode. The while in a video conference.
Page 153: Appendix
75% orange sphere. COMPLETE Is equivalent to a 100% green sphere. Example: ->dial man 384 5551212 ISDN Dialing manual Dialing 5551212 384 none ISDN cs: call[0] chan[0] dialstr[95551212] state[RINGING] © Polycom, Inc. Appendix - 1...
Page 154 Administrator’s Guide for the VSX Series cs: call[0] chan[0] dialstr[95551212] state[CONNECTED] 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]...
Page 156 Administrator’s Guide for the VSX Series Appendix - 4 www.polycom.com/videodocumentation...

This manual is also suitable for:

Vsx 3000 Vsx 7000 Vsx 8000

Polycom VSX Series Integrator's Reference Manual

Chapter 1 - Cables

Chapter 2 - Using the API

Chapter 3 - System Commands

Appendix

Quick Links

Need help?

Questions and answers

Related Manuals for Polycom VSX Series

Summary of Contents for Polycom VSX Series

This manual is also suitable for:

Table of Contents