Polycom HDX 9006 Integrator's Manual
  1. Manuals
  2. Brands
  3. Polycom Manuals
  4. Conference System
  5. HDX 9006
  6. Integrator's manual
Polycom HDX 9006 Integrator's Manual

Polycom HDX 9006 Integrator's Manual

Hdx series; hdx 9000 series; hdx 8000 hd series; hdx 7000 hd series; hdx 6000 hd series; hdx 4000 series;
Hide thumbs
1
2
3
Table Of Contents
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
Table of Contents

Advertisement

Quick Links

Download this manual
3.1.7 | May 2015 | 3725-23979-015A
Integrator's Reference Manual
®
®
Polycom
HDX
Systems

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the HDX 9006 and is the answer not in the manual?

Questions and answers

Related Manuals for Polycom HDX 9006

Summary of Contents for Polycom HDX 9006

  • Page 1 3.1.7 | May 2015 | 3725-23979-015A Integrator’s Reference Manual ® ® Polycom Systems...
  • Page 2 As between the parties, Polycom, Inc., retains title to and ownership of all proprietary rights with respect to the software contained within its products. The software is protected by United States copyright laws and international treaty provision.

  • Page 3: About This Guide

    Polycom HDX systems. The API commands in this guide are applicable to the Polycom HDX 9000 series, Polycom HDX 8000 HD series, Polycom HDX 7000 HD series, Polycom HDX 6000 HD series, and Polycom HDX 4000 series systems.

  • Page 4: Table Of Contents

    Polycom Touch Control Power Adapter ........
  • Page 5 HDCI Polycom EagleEye 1080 Camera Cable ....... . . 61...
  • Page 6 Integrator’s Reference Manual for Polycom HDX Systems Contents Vortex Cable ............92 3.5mm Screw Cage Connector .
  • Page 7 Integrator’s Reference Manual for Polycom HDX Systems Contents all unregister ............. 132 allowabkchanges .
  • Page 8 Integrator’s Reference Manual for Polycom HDX Systems Contents colorbar ..............183 configchange (deprecated) .
  • Page 9 Integrator’s Reference Manual for Polycom HDX Systems Contents enablelivemusicmode ............228 enablepvec .
  • Page 10 Integrator’s Reference Manual for Polycom HDX Systems Contents gmsurl ..............282 h239enable .
  • Page 11 Integrator’s Reference Manual for Polycom HDX Systems Contents ldapdirectory ............. 327 ldapntlmdomain .
  • Page 12 Integrator’s Reference Manual for Polycom HDX Systems Contents ocsdirectory ............. . 369 oobcomplete .
  • Page 13 Integrator’s Reference Manual for Polycom HDX Systems Contents setpassword ............. 413 showpopup .
  • Page 14 Integrator’s Reference Manual for Polycom HDX Systems Contents systemsetting country ............457 systemsetting dialingmethod .
  • Page 15 Integrator’s Reference Manual for Polycom HDX Systems Contents systemsetting potsenable ........... 506 systemsetting primarycamera .
  • Page 16 Integrator’s Reference Manual for Polycom HDX Systems Contents v35dialingprotocol ............547 v35num .
  • Page 17 Integrator’s Reference Manual for Polycom HDX Systems Contents Power ............. . . 579 Range/Frequency Response .
  • Page 18 Integrator’s Reference Manual for Polycom HDX Systems Contents LAN, WAN, and IP Commands ..........629 H323 Commands .

  • Page 19: Room Integration

    Room Design and Layout. Room Layout Examples Use the following diagrams as examples for setting up a conference room with Polycom HDX systems. Polycom recommends that you contract an experienced contractor to ensure all the components operate as a single cohesive system.

  • Page 20: Large Conference Room: Option 1

    Integrator’s Reference Manual for Polycom HDX Systems Room Integration Large Conference Room: Option 1 Acoustic Panels Polycom SoundStation® IP 7000 Phone Ceiling Microphone Polycom Touch Control Ceiling Microphone Polycom EagleEye Director 50” 50” Monitor 1 Monitor 2 Polycom HDX Executive Collection...
  • Page 21 Integrator’s Reference Manual for Polycom HDX Systems Room Integration Acoustic Panels Document Camera Polycom SoundStation® IP 7000 Phone Ceiling Microphone Polycom Touch Control Ceiling Microphone Whiteboard Projector with Polycom UC Board™ Sensor Polycom EagleEye 50” Director Single Display Polycom HDX...
  • Page 22 Polycom recommends using a Polycom EagleEye II, Polycom EagleEye III, Polycom EagleEye HD or Polycom EagleEye HD 1080 camera with People on Content. If you are using a Polycom EagleEye 1080 or Polycom EagleEye View camera, activating People on Content automatically reduces the resolution to 720p.

  • Page 23: Polycom Hdx Installation Precautions

    Polycom HDX Systems and in the Knowledge Base on the Polycom web site. Polycom HDX Installation Precautions If you place the Polycom HDX series system in a cart or credenza, ensure that there is proper ventilation for maintaining an ambient temperature of 40°C or lower.
  • Page 24 Integrator’s Reference Manual for Polycom HDX Systems Room Integration 2” 2” Polycom, Inc.

  • Page 25: Integrating Video

    EagleEye View, Polycom EagleEye II, Polycom EagleEye III, Polycom EagleEye Director, Polycom PowerCam™, or PowerCam Plus or camera from Polycom, or to other supported cameras. Refer to the release notes for the software release installed on the Polycom HDX system for a list of supported PTZ cameras.
  • Page 26 ● Power supply. Use only the approved power supply from Polycom (part number 1465-52748-040). Do not exceed 12 Volts at 3 Amps. Verify the polarity of the power supply as shown on the Polycom camera next to the power supply input.
  • Page 27 ● Power supply. Use only the approved power supply from Polycom (part number 1465-52748-040). Do not exceed 12 Volts at 3 Amps. Verify the polarity of the power supply as shown on the Polycom camera next to the power supply input.
  • Page 28 Integrator’s Reference Manual for Polycom HDX Systems Room Integration Polycom recommends this configuration when a custom cable length is required. The BNC and serial cables can be built to custom lengths. DC IN 12V Use Polycom Power Supply Only Part Number: 1465-52733-040 Optional, up to 100 ft Polycom, Inc.
  • Page 29 ● Power supply. Use only the approved power supply from Polycom (part number 1465-52748-040). Do not exceed 12 Volts at 3 Amps. Verify the polarity of the power supply as shown on the Polycom camera next to the power supply input.
  • Page 30 Polycom EagleEye Director as the Main Camera or Second Camera You can connect a Polycom EagleEye Director (part number 7200-82632-xxx, 7200-82631-xxx, or 2200-82559-xxx) to a Polycom HDX 9001, Polycom HDX 9002, or Polycom HDX 9004 system as the main camera using: ●...
  • Page 31 PowerCam as the Main Camera up to 10 ft Away You can connect a PowerCam (part number 2215-50370-001) to a Polycom HDX 9001, Polycom HDX 9002, or Polycom HDX 9004 system as the main camera up to 10 ft away using: ●...
  • Page 32 Room Integration ● 7230-22231-001 (50 ft) ● 7230-22232-001 (100 ft) You can connect a PowerCam (part number 2215-50370-001) to a Polycom HDX 9001, Polycom HDX 9002, or Polycom HDX 9004 system as the second camera using: ● A— PowerCam Break-Out Cable on page 69.
  • Page 33 PowerCam Plus as the Main Camera up to 10 ft Away You can connect a PowerCam Plus (part number 2215-50200-001) to a Polycom HDX 9001, Polycom HDX 9002, or Polycom HDX 9004 system as the main camera up to 10 ft away using: ●...
  • Page 34 PowerCam Plus as the Second Camera up to 10 ft Away You can connect a PowerCam Plus (part number 2215-50200-001) to a Polycom HDX 9001, Polycom HDX 9002, or Polycom HDX 9004 system as the second camera up to 10 ft away using: ●...

  • Page 35: Connecting Sony And Elmo Cameras

    Refer to the release notes for a list of supported Pan/Tilt/Zoom (PTZ) cameras. Sony or ELMO PTZ as the Main or Second Camera To connect a Sony or ELMO PTZ camera to a Polycom HDX 9000 Series system as the main or second camera: You can connect a Sony or ELMO PTZ camera to a Polycom HDX system using: ●...
  • Page 36 (part number 1517-52689-001) for cable A. The VGA/DVI-A adapter is a solid overmolded adapter that connects to the Polycom HDX 9000 Series system side of cable C and adapts from cable C’s VGA connector to a DVI-A connector to plug into the Polycom HDX 9000 Series system.

  • Page 37: Connecting Vaddio And Canon Cameras

    To connect a Vaddio or Canon PTZ camera to a Polycom HDX 9000 Series system as the main or second camera: You can connect a Vaddio 70, Vaddio 100, or Canon (with VISCA cable shoe) PTZ camera to a Polycom HDX system using: ●...
  • Page 38 Integrator’s Reference Manual for Polycom HDX Systems Room Integration ● C—S-Video Cable on page 42. Note: For situations that require extraordinary cable lengths, CAT5 extension kits for camera video, power, and control are available from third-party vendors. Up to 100 ft...

  • Page 39: Integrating Audio And Content

    VCR/DVD Option 2 To hear audio at both the near site and the far site, use a bypass mixer to connect a computer to the Polycom HDX 9001 or Polycom HDX 9002 system as the following figure shows. Polycom, Inc.
  • Page 40 (Polycom HDX 9004, Polycom HDX 9002, and Polycom HDX 9001 systems only). When you connect a computer to video input 4 and audio input 4 on a Polycom HDX 9004 as follows, audio from input 4 is muted unless video input 4 is selected as a video source.

  • Page 41: Connecting A Vortex® Mixer To A Polycom Hdx 9000 Series System

    Integrator’s Reference Manual for Polycom HDX Systems Room Integration When you connect a computer to video input 4 and audio input 4 on a Polycom HDX 9006 system as follows, audio from input 4 is muted unless video input 4 is selected as a video source.

  • Page 42: Connecting A Polycom Soundstructure C-Series Mixer To A Polycom Hdx System

    Integrator’s Reference Manual for Polycom HDX Systems Room Integration Connecting a Polycom SoundStructure C-Series Mixer to a Polycom HDX System Connect a Polycom HDX system to the Polycom SoundStructure C-Series mixer using Polycom HDX Microphone Array Host Cable. Polycom HDX 9000 system:...
  • Page 43 Integrator’s Reference Manual for Polycom HDX Systems Room Integration Polycom HDX 7000 system: PIN 2: TXD PIN 3: RXD PIN 5: GROUND PIN 7: CTS PIN 8: RTS RS-232 REMOTE CONTROL 1 C-LINK2 OBAM REMOTE CONTROL 2 SoundStructure C16 Polycom HDX 6000 system:...
  • Page 44 SoundStructure C-Series documentation on the Polycom web site. You cannot connect both a SoundStructure C-Series mixer and a SoundStation IP 7000 phone to the Polycom HDX 9000 Series system at the same time. • If the EagleEye Director device is connected to a Polycom HDX system that is...

  • Page 45: Cables

    Network Cables CAT 5e LAN Cable This cable connects a Polycom HDX system to the LAN. It has orange RJ-45 connectors on both ends. It meets category 5e requirements and is wired according to EIA/TIA-568B. The maximum approved length for this cable is 100 ft (30 m) on an 802 network.

  • Page 46: Lan Cable

    Integrator’s Reference Manual for Polycom HDX Systems Cables LAN Cable This cable connects a Polycom HDX to the LAN. It has orange RJ-45 connectors on both ends and is used with all systems. The maximum approved length for this cable is 100 ft (30 m). Length...

  • Page 47: Polycom Touch Control Lan Cable

    25 ft (7.62 m) 2457-26994-001 Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your...

  • Page 48: Isdn Cable

    Cables ISDN Cable This cable connects a Polycom HDX system to a BRI or PRI line. It has clear RJ-45 connectors on both ends and is used with all Polycom HDX systems that have ISDN capability. The maximum approved length for this cable is 50 ft (15 m).
  • Page 49 Integrator’s Reference Manual for Polycom HDX Systems Cables Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your...

  • Page 50: Analog Telephone (Pots) Cable

    Integrator’s Reference Manual for Polycom HDX Systems Cables Analog Telephone (POTS) Cable This cable connects a Polycom HDX system to an analog telephone line. It has pink RJ-11 connectors on both ends. The maximum approved length for this cable is 100 ft (30 m). Length...

  • Page 51: V.35/Rs-449/Rs-530 Serial Adapter

    Cables V.35/RS-449/RS-530 Serial Adapter This adapter is used when connecting a Polycom HDX system to other third-party network equipment. It adapts the 68-pin interface to an industry standard 44-pin interface used by some network interface equipment. It is used with Polycom HDX systems that have a V.35/RS-449/RS-530 serial network interface card (NIC) installed.
  • Page 52 Integrator’s Reference Manual for Polycom HDX Systems Cables Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your...

  • Page 53: V.35 Nic Cable

    V.35/RS-449/RS-530 Serial Adapter on page 33 to connect to network equipment that has the HD-44 pin interface. It has HD-44 M connectors on both ends and is used with Polycom HDX systems that have a serial network interface card (NIC) installed.

  • Page 54: V.35 And Rs-366 Serial Cable

    V.35/RS-449/RS-530 Serial Adapter on page 33 to connect to network equipment that has a V.35/RS-366 interface. It is HD-44 M to “Y” Winchester 34M/RS-366 DB-25M and is used with Polycom HDX systems that have a serial network interface card (NIC) installed.

  • Page 55: And Rs-366 Serial Cable

    33 to connect to network equipment that has an RS-449/RS-366 interface. It is HD-44 M to “Y” RS-449 DB-37M/RS-366 DB-25M and is used with Polycom HDX systems that have a serial network interface card (NIC) installed. Length Part Number RoHS Compliant 5 ft (1.65 m)
  • Page 56 Integrator’s Reference Manual for Polycom HDX Systems Cables Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your...

  • Page 57: Rs-530 With Rs-366 Serial Cable

    This cable connects a Polycom HDX system to third-party network equipment. It is used with the V.35/RS-449/RS-530 Serial Adapter on page 33 to connect to network equipment that has an RS-530/RS-366 interface. It is HD-68M to “Y” DB-25M and is used with Polycom HDX systems that have a serial network interface card (NIC) installed. Length...
  • Page 58 Integrator’s Reference Manual for Polycom HDX Systems Cables Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your...

  • Page 59: Polycom Touch Control Power Adapter

    Integrator’s Reference Manual for Polycom HDX Systems Cables Polycom Touch Control Power Adapter This adapter connects the Polycom Touch Control device to the LAN and a power supply (part number 2200-42740-XXX) for rooms that do not have Power over Ethernet (PoE). Length...

  • Page 60: Video And Camera Cables

    Integrator’s Reference Manual for Polycom HDX Systems Cables Video and Camera Cables S-Video Cable These cables connect a Polycom HDX system to a monitor or camera. They have yellow 4-pin mini-DIN connectors on both ends and are used with all Polycom HDX systems. Length Part Number RoHS Compliant 8 ft (2.4 m)

  • Page 61: Bnc To S-Video Cable

    Integrator’s Reference Manual for Polycom HDX Systems Cables BNC to S-Video Cable This cable connects S-Video devices to a Polycom HDX system. It is 4-pin male mini-DIN to dual BNC male. The maximum approved length for this cable is 100 ft (30 m). Length...

  • Page 62: Bnc To S-Video Adapter

    Integrator’s Reference Manual for Polycom HDX Systems Cables BNC to S-Video Adapter This adapter may be required when connecting standard S-Video cables to a Polycom HDX system. It is dual BNC male to 4-pin female mini-DIN. Length Part Number RoHS Compliant 1 ft (.3 m)

  • Page 63: S-Video To Rca Adapter

    This adapter is used when connecting a standard composite video cable (or the video jack on a VCR cable) into an S-Video connector on a Polycom HDX system. It is yellow RCA to 4-pin mini-DIN. This adapter can be used along with the BNC to S-Video cable (part number 2457-21489-200) or BNC to S-Video adapter (part number 2457-21490-200) to connect a composite monitor or VCR to a BNC connector on a Polycom HDX 9000 series system.
  • Page 64 Integrator’s Reference Manual for Polycom HDX Systems Cables Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your...

  • Page 65: Dvi To Vga Monitor Cable

    This cable connects a Polycom HDX system DVI-I output to a VGA monitor. It can also be used to connect a computer to one of the DVI-A video inputs on a Polycom HDX system. It is male DVI-A to male HD-15.

  • Page 66: Hdmi Monitor Cable

    Integrator’s Reference Manual for Polycom HDX Systems Cables HDMI Monitor Cable This cable connects the Polycom HDX system DVI-I output to an HDMI monitor. It is male DVI-D to male HDMI. Length Part Number RoHS Compliant 9 ft 10 in (3 m) 2457-23905-001 Drawings and part numbers are provided for reference only.

  • Page 67: Bnc Monitor Adapter Cable

    Integrator’s Reference Manual for Polycom HDX Systems Cables BNC Monitor Adapter Cable This cable connects the Polycom HDX system DVI-I output to a variety of analog display devices with composite, S-Video, component YPbPr, or RGBHV inputs. It is male DVI-A to five female BNC connectors. Length...

  • Page 68: Polycom Hdx Component Monitor Cable

    Integrator’s Reference Manual for Polycom HDX Systems Cables Polycom HDX Component Monitor Cable This cable connects a Polycom HDX system DVI-I output to a monitor with component connections. It is male DVI-A to three RCA. Length Part Number RoHS Compliant 6 ft (1.8 m)

  • Page 69: Polycom Hdx Component Video Cable

    Integrator’s Reference Manual for Polycom HDX Systems Cables Polycom HDX Component Video Cable This cable connects a Polycom HDX system to a video playback device with component connections. It is three RCA to three male BNC. Length Part Number RoHS Compliant 25 ft (7.6 m)

  • Page 70: Dvi-D Monitor Cable

    Integrator’s Reference Manual for Polycom HDX Systems Cables DVI-D Monitor Cable This cable connects a Polycom HDX system DVI-I output to a DVI-D monitor. It is male DVI-D on both ends. Length Part Number RoHS Compliant 4 ft 6 in (1.5 m)

  • Page 71: Component A/V Monitor Cable

    Cables Component A/V Monitor Cable This cable connects a Polycom HDX system DVI-I video output and stereo audio output to a monitor with component video and stereo audio connections. It is male DVI-A and dual male RCA to five RCA.

  • Page 72: Hdci Analog Camera Cable

    Cables HDCI Analog Camera Cable This cable connects a Polycom HDX system to a Polycom EagleEye HD, Polycom EagleEye II, Polycom EagleEye III, or Polycom EagleEye Director. This cable can be connected to the EagleEye View camera, but does not support audio. It has male HDCI connectors on both ends. The over-mold connectors of the 2457-27453-001 and 2457-27454-001 cables are black.

  • Page 73: Polycom Hdx Hdci Polycom Eagleeye Director Cable

    Integrator’s Reference Manual for Polycom HDX Systems Cables Polycom HDX HDCI Polycom EagleEye Director Cable This cable connects a Polycom EagleEye II or Polycom EagleEye III camera to the Polycom EagleEye Director base. It has male HDCI connectors on both ends. Length...
  • Page 74 Vertical Mic Top Vertical Mic Center Horizontal Mic Left Horizontal Mic Right Horizontal Mic Left Center Horizontal Mic Right Center Horizontal Mic Center For information about positioning the camera, refer to the Administrator’s Guide for Polycom HDX Systems. Polycom, Inc.

  • Page 75: Hdci Camera Break-Out Cable

    Integrator’s Reference Manual for Polycom HDX Systems Cables HDCI Camera Break-Out Cable This cable breaks out the HDCI camera cable video and control signals to standard interfaces. This cable can be connected to the EagleEye View camera, but does not support audio. The five BNC connectors can be used to carry composite video, S-Video, or analog component YPbPr video.
  • Page 76 Integrator’s Reference Manual for Polycom HDX Systems Cables Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your...

  • Page 77: Hdci Powercam Plus Adapter Cable

    1 ft (0.3 m) 2457-23481-001 Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your...

  • Page 78: Hdci Visca Adapter Cable

    HDCI VISCA Adapter Cable This cable connects a Polycom HDX system HDCI video input to SD cameras with VISCA control that use a DB-9 serial connector. It is HDCI to 4-pin mini-DIN and DB-9. Standard S-Video and DB-9 serial cables are required to connect this cable to the camera.

  • Page 79: Hdci Polycom Eagleeye 1080 Camera Cable

    Cables HDCI Polycom EagleEye 1080 Camera Cable This cable connects a Polycom system HDCI video input to the Polycom EagleEye 1080, Sony EVI-HD1 PTZ, or Sony BRC-H700 PTZ cameras. It is HDCI to 8-pin mini-DIN and HD-15. The maximum approved length for this cable is 100 ft (30 m).
  • Page 80 Integrator’s Reference Manual for Polycom HDX Systems Cables Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your...

  • Page 81: Hdci Polycom Eagleeye View Camera Cable

    Cables HDCI Polycom EagleEye View Camera Cable This cable connects a Polycom HDX system HDCI video input to a Polycom EagleEye View camera. It has male HDCI connectors on both ends. The over-mold connectors of the 2457-09729-001 cable are brown.
  • Page 82 Integrator’s Reference Manual for Polycom HDX Systems Cables Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your...

  • Page 83: Hdci Sony Visca Adapter Cable

    Cables HDCI Sony VISCA Adapter Cable This cable connects a Polycom HDX system HDCI video input to a camera using Sony 8-pin mini-DIN VISCA and S-Video. It is HDCI to 8-pin mini-DIN and S-Video. Standard S-Video and Sony VISCA cables are required to connect this cable to the camera.

  • Page 84: Vcr/Dvd Composite Cable

    VCR/DVD Composite Cable This cable connects a Polycom HDX system to a VCR or DVD player. It has triple RCA connectors on both ends. The Polycom HDX system requires a female RCA to male BNC adapter for the yellow video RCA...

  • Page 85: Composite Video Cable

    This cable connects a Polycom HDX system to a monitor or camera. It has single yellow RCA connectors on both ends The Polycom HDX system requires a female RCA to male BNC adapter in order to connect to composite input or output. The maximum approved length for this cable is 100 ft (30 m).

  • Page 86: Powercam Primary Camera Cable

    Integrator’s Reference Manual for Polycom HDX Systems Cables PowerCam Primary Camera Cable This cable connects the Polycom HDX system video input 1 to a Polycom PowerCam camera up to 10 ft away when used with the HDCI PowerCam Plus Adapter Cable on page 59.

  • Page 87: Powercam Break-Out Cable

    Cables PowerCam Break-Out Cable This cable connects S-Video and control cables and a power supply to a Polycom PowerCam camera. This combination is required when using the PowerCam as the primary camera more than 10 ft away from the system, or as the secondary camera. It is 8-pin mini-DIN to 3-way breakout block.

  • Page 88: Powercam Plus/Visca Control Cable

    IR RETURN SHIELD SHIELD Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your...

  • Page 89: Powercam Plus Primary Cable

    Integrator’s Reference Manual for Polycom HDX Systems Cables PowerCam Plus Primary Cable This cable connects a Polycom HDX system to a Polycom PowerCam Plus camera using the HDCI PowerCam Plus Adapter Cable on page 59. It has 4-pin mini-DIN and DB-15 connectors on both ends.

  • Page 90: 8-Pin Mini-Din To Db-9

    Cables 8-pin mini-DIN to DB-9 This cable connects Polycom HDX system serial port inputs to a non-Polycom camera using a VISCA 8-pin DIN connector, or to a Polycom PowerCam break-out cable with a PowerCam camera. It is 8-pin mini-DIN to DB-9. RTS/CTS and IR are not supported on this cable.

  • Page 91: Serial To Visca Cable

    9.8 ft (3 m) 2457-63444-001 Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your...

  • Page 92: People+Content Cable

    25 ft (7.62 m) 2457-28665-001 Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your...

  • Page 93: Audio Cables

    Polycom HDX Microphone Array Host Cable For more information about supported microphone configurations, refer to the Administrator’s Guide for Polycom HDX Systems. This cable connects a Polycom HDX system to the Polycom SoundStructure C-Series mixer. It is unkeyed male RJ-45 on both ends. Length...
  • Page 94 To build a custom crossover cable for this purpose, you should use shielded CAT5 or better cable. Each end of the onle should have a shielded RJ-45 plug connector that connects to a Polycom HDX microphone array host device. The maximum supported cable length is 100 feet.

  • Page 95: Polycom Hdx Microphone Array Cable

    Polycom HDX Microphone Array Cable For more information about supported microphone configurations, refer to the Administrator’s Guide for Polycom HDX Systems. This cable connects two Polycom HDX microphone arrays. This cable can also be used with the Polycom HDX Microphone Array Cable Adapter on page 83to connect a Polycom HDX system to a Polycom HDX microphone array or to a SoundStation IP 7000 phone.
  • Page 96 10 ft (3 m) 2457-24011-001 Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your...

  • Page 97: Isdn Cable

    Cables ISDN Cable This cable connects a Polycom HDX system to a BRI or PRI line. It has clear RJ-45 connectors on both ends and is used with all Polycom HDX systems that have ISDN capability. The maximum approved length for this cable is 50 ft (15 m).
  • Page 98 Integrator’s Reference Manual for Polycom HDX Systems Cables Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your...

  • Page 99: Analog Telephone (Pots) Cable

    Integrator’s Reference Manual for Polycom HDX Systems Cables Analog Telephone (POTS) Cable This cable connects a Polycom HDX system to an analog telephone line. It has pink RJ-11 connectors on both ends. The maximum approved length for this cable is 100 ft (30 m). Length...

  • Page 100: Polycom Ceiling Microphone Drop Cable

    2 ft (.6 m) 2457-26761-024 Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your...

  • Page 101: Polycom Hdx Microphone Array Cable Adapter

    Part Number RoHS Compliant 18 in (0.5 m) 2457-23716-001 The following diagram shows microphone connection options for Polycom HDX 9000 Series systems, using cables available from Polycom. Polycom HDX Microphone Array Cable Adapter Polycom HDX Microphone Array Cables Do not connect Polycom microphone cables or devices to the Ethernet port, and do not connect an Ethernet cable or device to the Polycom microphone input.

  • Page 102: Polycom Hdx Ceiling Microphone Adaptor Cable

    Integrator’s Reference Manual for Polycom HDX Systems Cables Polycom HDX Ceiling Microphone Adaptor Cable This cable connects a Polycom HDX system to the Polycom microphone array. It is male Walta to RJ-45. Length Part Number RoHS Compliant 18 in (0.5 m) 2457-25646-001 18.00 IN +/-.125"...

  • Page 103: Polycom Hdx Microphone Array Crossover Cable

    Polycom HDX Microphone Array Crossover Cable For more information about supported microphone configurations, refer to the Administrator’s Guide for Polycom HDX Systems. This cable connects any two Polycom HDX microphone arrays that use RJ-45 sockets. Length Part Number RoHS Compliant 25 ft (7.6 m)
  • Page 104 Integrator’s Reference Manual for Polycom HDX Systems Cables Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your...

  • Page 105: Custom Cabling For Polycom Hdx Microphone Arrays

    Cables Custom Cabling for Polycom HDX Microphone Arrays You can create a custom-length cable that connects a Polycom HDX system to a Polycom HDX microphone array or SoundStation IP 7000 phone. Start with the microphone cable (part number 2457-23216-001), and cut off the P1 end.
  • Page 106 CAT5 cable. The cable is terminated on one end to either a shielded CAT5 keystone jack or, if using a shielded panel coupler, a shielded RJ-45 plug connector. The other end terminates to a shielded RJ-45 plug that connects to the Polycom HDX system. Polycom, Inc.
  • Page 107 RJ-45 panel coupler kit (L-com ECF504-SC5E or equivalent) P2- RJ-45 shielded plug, Tyco 5-569552 or equivalent The Polycom RJ-45 connector pinout is custom. For best performance, follow the wiring tables shown in this document. If standard Ethernet cables are used, signal integrity cannot be guaranteed and degraded performance may occur, especially at longer lengths.

  • Page 108: Audio Adapter Cable

    Integrator’s Reference Manual for Polycom HDX Systems Cables Audio Adapter Cable This cable adapts the Polycom HDX system Phoenix audio connectors to standard RCA audio cables, such as the Audio Cable on page 91. It is dual male Phoenix to dual female RCA connectors (red/white).

  • Page 109: Audio Cable

    Integrator’s Reference Manual for Polycom HDX Systems Cables Audio Cable This cable connects a Polycom HDX system to an external audio system. It is used with the Audio Adapter Cable on page 90. It has dual RCA connectors (red/white) on both ends. The maximum approved length for this cable is 100 ft (30 m).

  • Page 110: Vortex Cable

    Integrator’s Reference Manual for Polycom HDX Systems Cables Vortex Cable This cable connects Polycom HDX system to a Polycom Vortex mixer. It has four mini-Phoenix connectors and one DB-9 connector on each end. Length Part Number RoHS Compliant 6 ft (1.8 m) 2457-21978-200 1829.0 +/- 50...
  • Page 111 Integrator’s Reference Manual for Polycom HDX Systems Cables Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your...

  • Page 112: 3.5Mm Screw Cage Connector

    3.5mm Screw Cage Connector This 3-pin connector connects audio input and output to the Polycom HDX system. It also connects the IR sensor input on a Polycom HDX system to an external IR receiver, such as Xantech models 780-80, 780-90, 480-00, and 490-90.

  • Page 113: Subwoofer Volume Attenuator

    Cables Subwoofer Volume Attenuator This attenuator plugs into the Volume Control RJ-11 port on the subwoofer that comes with the Polycom stereo speaker kit (2200-21969-120 and 2200-21969-240). The attenuator is required for proper operation of the acoustic echo cancellation. It has an RJ-11 connector.
  • Page 114 Integrator’s Reference Manual for Polycom HDX Systems Cables Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your...

  • Page 115: Polycom Eagleeye Director Audio Feedback Phoenix To

    Polycom EagleEye Director Audio Feedback Phoenix to Phoenix Cable This cable connects a Polycom HDX 9000 series system or Polycom SoundStructure C-Series Mixer to the Polycom EagleEye Director and the room audio playback system. It is dual male Phoenix connectors (for HDX systems or SoundStructure C-Series Mixer) to dual male Phoenix connectors (for the EagleEye Director with dual female Phoenix connectors (for the room audio playback system).

  • Page 116: Polycom Eagleeye Director Audio Feedback Phoenix To

    This cable connects a Polycom HDX 6000, HDX 7000 or HDX 8000 system or Polycom SoundStructure C-Series Mixer to the Polycom EagleEye Director and the room audio playback system. It is dual male Phoenix connectors (for HDX systems or SoundStructure C-Series Mixer) to dual male RCA connectors (for the EagleEye Director) with dual female RCA connectors (for the room audio playback system).
  • Page 117 Integrator’s Reference Manual for Polycom HDX Systems Cables Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your...

  • Page 118: Serial Cables

    Serial Cables Straight-Through Serial Cable This cable connects a Polycom HDX system to a serial device. It has a DB-9 connector on each end. The maximum approved length for this cable is 100 ft (30 m). Polycom does not recommend using this straight-through serial cable for RS-232 communication from a computer, Crestron system, or AMX device.
  • Page 119 Not used Most devices that connect to the serial port to control the Polycom HDX system through the API only require pins 2, 3, and 5. For more information and to verify the proper cabling, refer to the documentation for your control system.

  • Page 120: Null Modem Adapter

    Cables Null Modem Adapter This adapter is used when connecting Polycom HDX system to a serial device that transmits on pin 3 such as Crestron Pro2 processor. It is a male to female DB-9 adapter plug. Do not use this adapter with an AMX device. AMX systems support both RS-232 and RS-422.

  • Page 121: Using The Api

    Polycom HDX 9000, Polycom HDX 8000, Polycom HDX 7000, or Polycom HDX 4000 series system. You can also use Telnet over the LAN to use the API with Polycom HDX 9000, Polycom HDX 8000, Polycom HDX 7000, Polycom HDX 6000, and Polycom HDX 4000 series systems.

  • Page 122: Starting An Api Session Using An Rs-232 Interface

    ● Vortex Mixer To connect a computer to a Polycom HDX 9006 system: To connect a computer to a Polycom HDX 9001, Polycom HDX 9002 or Polycom HDX 9004 system: IOIOIO To connect a computer to a Polycom HDX 8000 or HDX 7000 series system:...

  • Page 123: Using The Api With The Maximum Security Profile Enabled

    Integrator’s Reference Manual for Polycom HDX Systems Using the API After you have verified that the Polycom HDX system and your computer or control system are both configured appropriately, set up both devices as follows: 1 Power off the computer or control system and the Polycom HDX system.

  • Page 124: Using The Api With A Lan Connection

    590. Using the API with a LAN Connection If you have a computer connected to the LAN, you can send API commands to the Polycom HDX system through telnet port 24. 1 On the computer, open a command line interface.

  • Page 125: Video Test Numbers

    Polycom system. Knowledge Base Refer to the Knowledge Base at support.polycom.com. This tool allows you to search for user guides, release notes, and other forms of product documentation. You can also search for troubleshooting information and technical briefs. Use this web site when you need to access Polycom product documentation or tips.

  • Page 126: System Commands

    Quotation marks indicate strings to be supplied by the user. You do not need to enclose the value in quotes unless it contains a space. Although the API command parser may accept the minimum number of characters in a command that makes it unique, you should always use the full command string. Polycom, Inc.

  • Page 127: Availability Of Commands

    For more information about provisioned settings, refer to your provisioning service administrator.” Commands that are not listed in this chapter are not supported by Polycom. Commands might change or be removed at any time. Polycom discourages integrators from using unpublished commands.

  • Page 128: Command Response Syntax

    Integrator’s Reference Manual for Polycom HDX Systems System Commands camera near 1 <CR>API command returns camera near 1<CR><LF>API acknowledgement notification:vidsourcechange:near:1:Main:people<CR><LF> API registration response When your system is registered for notifications, always use the API registration response for status. Command Response Syntax When you send a command, the system returns responses using the syntax described in the following sections, where <CR>...

  • Page 129: Commands That Restart The System

    ● resetsystem Additional Tips ● The Polycom HDX system does not provide flow control. If the connection is lost through restarting the system or other means, you must re-establish the connection. ● The API processes one command at a time.
  • Page 130 ● It is only required that you send registration and notification API commands once, because the registrations become written into Flash memory and are retained even upon restarting the system. ● Polycom recommends putting registrations in the initialization or startup of Crestron and AMX systems.
  • Page 131 Integrator’s Reference Manual for Polycom HDX Systems System Commands Executes a previously used command from the history list, starting with a specific number or letter. Syntax !“string” !{1..64} Parameter Description “string” Specifies the most recent command from the history list that begins with this string.
  • Page 132 Integrator’s Reference Manual for Polycom HDX Systems System Commands 2 hangup video 3 h323name get 4 gatewaynumber set 123456789 5 hangup video 6 h323name get See Also For information about the history list, refer to the history command on page 291.

  • Page 133: Abk (Deprecated)

    Integrator’s Reference Manual for Polycom HDX Systems System Commands abk (deprecated) Returns local directory (address book) entries. This command has been deprecated. Polycom recommends using the addrbook command on page 118. Syntax abk all abk batch {0..59} abk batch search “pattern” “count”...
  • Page 134 - _ / ; @ , . \ 0 through 9 a through z Polycom HDX systems search on the Display Name. Individual words within the Display Name, or GDS Guestbook, are determined through the use of delimiters. Supported delimiter characters are: "...
  • Page 135 Integrator’s Reference Manual for Polycom HDX Systems System Commands ● abk batch search Polycom 3 returns abk 0. Polycom HDXDemo 1 spd:384 num:1.700.5551212 abk 1. Polycom HDXDemo 2 spd:384 num:192.168.1.101 abk 2. Polycom HDXDemo 3 spd:384 num:192.168.1.102 abk batch search Polycom 3 done ●...

  • Page 136: Addrbook

    Integrator’s Reference Manual for Polycom HDX Systems System Commands addrbook Returns local directory (address book) entries. Syntax Commands for local directory addrbook all addrbook batch {0..59} addrbook batch search “pattern” “count” addrbook batch define “start_no” “stop_no” addrbook letter {a..z} addrbook range “start_no” “stop_no”...
  • Page 137 - _ / ; @ , . \ 0 through 9 a through z Polycom HDX systems search on the Display Name. Individual words within the Display Name, or GDS Guestbook, are determined through the use of delimiters. Supported delimiter characters are: "...
  • Page 138 Integrator’s Reference Manual for Polycom HDX Systems System Commands Parameter Description size Returns the size of the result set that will be returned by the command. The size parameter can be used with the names and the names search commands.
  • Page 139 Integrator’s Reference Manual for Polycom HDX Systems System Commands Parameter Description group_name A local address book group name. address Obtains the address information for a specified entry. If the entry is an ITP system, the results will include the addresses for all codecs. If codecs support multiple protocols, the different addresses will be returned on separate lines.
  • Page 140 (e.g., h323:user@gatekeeper.foo.com). Feedback Examples ● addrbook all returns addrbook 0. “Polycom HDX Demo 1” isdn_spd:384 isdn_num:1.700.5551212 isdn_ext: addrbook 1. “Polycom HDX Demo 2” h323_spd:384 h323_num:192.168.1.101 h323_ext:7878 addrbook 2. “Polycom HDX Demo 3” sip_spd:384 sip_num:polycomhdx@polycom.com...
  • Page 141 8. name:"Polycom Austin Stereo" sys_label:"" type:video addrbook names 9. name:"Polycom Austin HD" sys_label:"" type:video addrbook names 10. name:"Polycom Austin USA IP" sys_label:"" type:video addrbook names 11. name:"Polycom Japan" sys_label:"" type:video addrbook names 12. name:"Scott CMAD IP" sys_label:"" type:video addrbook names 13.
  • Page 142 Integrator’s Reference Manual for Polycom HDX Systems System Commands addrbook search 1. name:"Polycom Austin Stereo" sys_label:"" type:video addrbook search 2. name:"Polycom Austin USA IP" sys_label:"" type:video addrbook search search p all 0 2 done ● addrbook group "Monday Staff Mtg"...

  • Page 143: Addressdisplayedingab

    Integrator’s Reference Manual for Polycom HDX Systems System Commands addressdisplayedingab Specifies whether to display the system address in the global directory. Syntax addressdisplayedingab get addressdisplayedingab private addressdisplayedingab public Parameter Description Returns the current setting. private Specifies not to display the system address in the global directory.

  • Page 144: Advnetstats

    Integrator’s Reference Manual for Polycom HDX Systems System Commands advnetstats Gets advanced network statistics for a call connection. Syntax advnetstats [{0..n}] Parameter Description {0..n} Specifies a connection in a multipoint call, where n is the maximum number of connections supported by the system.
  • Page 145 Integrator’s Reference Manual for Polycom HDX Systems System Commands rsid=Remote system id ccaps=Content capability, where possible responses include “9” (H.239), “E” (enterprise dual streams), “N” (none), and “P” (content over the people stream) See Also To return network statistics for a call, use the nearloop command on page 357.

  • Page 146: Alertusertone

    Integrator’s Reference Manual for Polycom HDX Systems System Commands alertusertone Sets or gets the tone used for user alerts. Syntax alertusertone <get|1|2|3|4> Parameter Description Returns the current setting. 1|2|3|4 Sets the user alert to the corresponding tone. Feedback Examples ● alertusertone 1...

  • Page 147: Alertvideotone

    Integrator’s Reference Manual for Polycom HDX Systems System Commands alertvideotone Sets the tone used for incoming video calls. Syntax alertvideotone <get|1|2|3|4|5|6|7|8|9|10> Parameter Description Returns the current setting. 1|2|3|4|5|6|7|8|9|1 Sets the incoming video alert to the corresponding tone. Feedback Examples ● alertvideotone 1...

  • Page 148: All Register

    Integrator’s Reference Manual for Polycom HDX Systems System Commands all register Registers for most commonly-used user registration events. Syntax all register Feedback Examples ● all register returns callstate registered camera registered chaircontrol registered linestate registered mute registered pip registered popupinfo registered...
  • Page 149 The all register command does not return local camera movements if the camera is moved using the remote control, the web interface, or the Polycom Touch Control virtual remote. Polycom recommends you use this command in place of the...

  • Page 150: All Unregister

    ● Status of point-to-point or multipoint calls ● Status of physical ISDN/IP connection to codec ● PIP state ● Chair control ● System information Polycom recommends you use this command in place of the unregisterall (deprecated) command on page 540. Polycom, Inc.

  • Page 151: Allowabkchanges

    Integrator’s Reference Manual for Polycom HDX Systems System Commands allowabkchanges Sets or gets the Allow Directory Changes setting. Syntax allowabkchanges <get|yes|no> Parameter Description Returns the current setting. Enables the Allow Directory Changes setting. Disables the Allow Directory Changes setting. Feedback Examples ●...

  • Page 152: Allowcamerapresetssetup

    Integrator’s Reference Manual for Polycom HDX Systems System Commands allowcamerapresetssetup Sets or gets whether users are allowed to change camera presets. Syntax allowcamerapresetssetup <get|yes|no> Parameter Description Returns the current setting. Allows users to change camera presets. Prevents users from changing camera presets.

  • Page 153: Allowdialing

    Integrator’s Reference Manual for Polycom HDX Systems System Commands allowdialing Sets or gets the ability to dial out from the system. Syntax allowdialing <get|yes|no> Parameter Description Returns the current setting. Allows users to place calls. Disables dialing so that the system can only receive calls.

  • Page 154: Allowmixedcalls

    Integrator’s Reference Manual for Polycom HDX Systems System Commands allowmixedcalls Sets or gets the ability to place and receive mixed protocol multipoint calls (IP and ISDN). It allows the administrator to disable this ability for security reasons. Syntax allowmixedcalls <get|yes|no>...

  • Page 155: Allowusersetup

    Integrator’s Reference Manual for Polycom HDX Systems System Commands allowusersetup Adds or removes the User Settings icon on the System screen, which allows users to access the User Settings screen. Syntax allowusersetup <get|yes|no> Parameter Description Returns the current setting. Enables the User Settings icon.

  • Page 156: Amxdd

    Integrator’s Reference Manual for Polycom HDX Systems System Commands amxdd Sets or gets the AMX Device Discovery beacon. Syntax amxdd get amxdd <on|off> Parameter Description Returns the current setting. Turns on the AMX Device Discovery beacon. Turns off the AMX Device Discovery beacon.

  • Page 157: Answer

    Integrator’s Reference Manual for Polycom HDX Systems System Commands answer Answers incoming video or phone calls (analog voice or ISDN voice). Syntax answer <video|phone> Parameter Description video Answers incoming video calls when Auto Answer Point-to-Point Video or Auto Answer Multipoint Video is set to No.

  • Page 158: Areacode

    Integrator’s Reference Manual for Polycom HDX Systems System Commands areacode Sets or gets the area code for all ISDN lines. This command is only applicable if you have a network interface connected to your system. Syntax areacode get areacode set “areacode”...

  • Page 159: Audiometer

    Integrator’s Reference Manual for Polycom HDX Systems System Commands audiometer Queries and displays audio levels, once per second. Syntax audiometer <micleft|micright|lineinleft|lineinright|lineoutleft|lineoutright| contentinleft|contentinright|vcrinleft|vcrinright|vcroutleft| vcroutright|farendleft|farendright|off> Parameter Description micleft Measures the audio strength of the signal coming from all microphones assigned to the “left” microphone channel.
  • Page 160 Integrator’s Reference Manual for Polycom HDX Systems System Commands Parameter Description farendleft Measures the strength of the signal on the left channels of all far-site audio inputs. Turns off audiometer output. Feedback Examples ● audiometer micleft returns audiometer micleft level peak:-19...

  • Page 161: Audiotransmitlevel

    Integrator’s Reference Manual for Polycom HDX Systems System Commands audiotransmitlevel Sets or gets the audio volume transmitted to the far site, or notification of transmit level changes. Syntax audiotransmitlevel <get|up|down|register|unregister> audiotransmitlevel set {-20..30} Parameter Description Returns the current setting. Sets the volume 1 decibel higher than the current setting.

  • Page 162: Autoanswer

    Integrator’s Reference Manual for Polycom HDX Systems System Commands autoanswer Sets or gets the Auto Answer Point-to-Point Video mode, which determines how the system handles an incoming call in a point-to-point video conference. Syntax autoanswer <get|yes|no|donotdisturb> Parameter Description Allows any incoming video call to be connected automatically.

  • Page 163: Autoshowcontent

    Integrator’s Reference Manual for Polycom HDX Systems System Commands autoshowcontent Specifies whether to send content automatically when a computer is connected to the system. Syntax autoshowcontent <get|on|off> Parameter Description Returns the current setting. Sets the system to send content automatically when a computer is connected to the system.

  • Page 164: Backlightcompensation

    Integrator’s Reference Manual for Polycom HDX Systems System Commands backlightcompensation Sets or gets the Backlight Compensation mode. Syntax backlightcompensation <get|yes|no> Parameter Description Returns the current setting. Enables Backlight Compensation. The camera automatically adjusts for a bright background. Disables the option.

  • Page 165: Basicmode

    Integrator’s Reference Manual for Polycom HDX Systems System Commands basicmode Sets or gets the Diagnostic Mode configuration, a limited operating mode that uses H.261 for video and G.711 for audio. Basic mode provides administrators with a workaround for interoperability issues that cannot be solved using other methods.

  • Page 166: Bri1Enable, Bri2Enable, Bri3Enable, Bri4Enable

    Integrator’s Reference Manual for Polycom HDX Systems System Commands bri1enable, bri2enable, bri3enable, bri4enable Sets or gets the configuration of the specified ISDN BRI line. This command is only applicable if you have a BRI network interface connected to your system.

  • Page 167: Briallenable

    Integrator’s Reference Manual for Polycom HDX Systems System Commands briallenable Sets or gets the configuration of all ISDN BRI lines. This command is only applicable if you have a BRI network interface connected to your system. Syntax briallenable <get|yes|no> Parameter Description Returns the status of all BRI lines—yes if enabled, no if...

  • Page 168: Button

    Integrator’s Reference Manual for Polycom HDX Systems System Commands button Simulates Polycom remote control buttons. Polycom does not recommend using the button commands because they rely on the current organization of the interface. When possible, use another API command instead of the button commands. Syntax button <#|*|0|1|2|3|4|5|6|7|8|9|.>...
  • Page 169 Integrator’s Reference Manual for Polycom HDX Systems System Commands Parameter Description hangup Sends the Hang Up button signal to the user interface. help Sends the Help button signal to the user interface. home Sends the Home button signal to the user interface.
  • Page 170 Integrator’s Reference Manual for Polycom HDX Systems System Commands Parameter Description Sends the up arrow button signal to the user interface. volume- Sends the volume - button signal to the user interface. volume+ Sends the volume + button signal to the user interface.
  • Page 171 Integrator’s Reference Manual for Polycom HDX Systems System Commands ● button left ● button right ● button down Polycom, Inc.

  • Page 172: Calendardomain

    Integrator’s Reference Manual for Polycom HDX Systems System Commands calendardomain Gets and sets the domain used by the calendaring service to log in to the Microsoft® Exchange server. Syntax calendardomain get calendardomain “domain” Parameter Description Returns the domain used by the calendaring service.

  • Page 173: Calendarmeetings

    The times are interpreted to be local times in the time zone the system was configured for. info Retrieves meeting details for scheduled meetings when the Polycom HDX system is registered with the calendaring service. Returns information such as the location, subject and organizer of the meeting. “meetingid”...
  • Page 174 Integrator’s Reference Manual for Polycom HDX Systems System Commands GlhsSjWEZBcAAKzMphJBwA4wicbtr3UEZArAKAk09LtAAACZpKWAADe7hJleQIOS7j2mzRJxk LKAAAA/9PhAAAQ|2010-03-30:09:00|2010-03-30:09:30|Program Review meeting|AAAaAEFsZXguTWFjRG9uYWxkQHBvbHljb20uY29tAVEACIjMne2/ndgARgAAAADr9 GlhsSjWEZBcAAKzMphJBwA4wicbtr3UEZArAKAk09LtAAACZpKWAABZ29fOU0S5Q6xzZ1lzDD NnAABFQAQ3AAAQ|2010-03-30:10:00|2010-03-30:11:00|Customer Care Commitment Meeting calendarmeetings list end ● calendarmeetings list 2010-03-30:08:00 2010-04-01:17:00 returns calendarmeetings list begin meeting|AAAaAEFsZXguTWFjRG9uYWxkQHBvbHljb20uY29tAVEACIjMne2/ndgARgAAAADr9 GlhsSjWEZBcAAKzMphJBwA4wicbtr3UEZArAKAk09LtAAACZpKWAADe7hJleQIOS7j2mzRJxk LKAAADI/G8AAAQ|2010-03-30:08:30|2010-03-30:09:00|Bug Scrub meeting|AAAaAEFsZXguTWFjRG9uYWxkQHBvbHljb20uY29tAVEACIjMne2/ndgARgAAAADr9 GlhsSjWEZBcAAKzMphJBwA4wicbtr3UEZArAKAk09LtAAACZpKWAABZ29fOU0S5Q6xzZ1lzDD NnAABFQARCAAAQ|2010-03-30:11:30|2010-03-30:12:30|HDX/IP7000/Conference Coordination meeting|AAAaAEFsZXguTWFjRG9uYWxkQHBvbHljb20uY29tAVEACIjMne2/ndgARgAAAADr9 GlhsSjWEZBcAAKzMphJBwA4wicbtr3UEZArAKAk09LtAAACZpKWAABZ29fOU0S5Q6xzZ1lzDD...
  • Page 175 If an API client is logged in with user-level credentials and if the Polycom HDX system is configured to hide private meeting information on the web interface, the API hides the information from the API client and shows the subject of the meeting as "Private Meeting";...
  • Page 176 Integrator’s Reference Manual for Polycom HDX Systems System Commands See Also To enable or disable the calendaring service, use the calendarregisterwithserver command on page 161. To configure the Microsoft Exchange server address used by this service use the calendarserver command on page 164.

  • Page 177: Calendarpassword

    Integrator’s Reference Manual for Polycom HDX Systems System Commands calendarpassword Sets the password used by the calendaring service to log in to the Microsoft Exchange server. Syntax calendarpassword “password” Parameter Description The password used by the calendaring service to log in “password”...

  • Page 178: Calendarplaytone

    Integrator’s Reference Manual for Polycom HDX Systems System Commands calendarplaytone Enables or disables the reminder alert tone that plays with the meeting reminder when the Polycom HDX system is registered with the calendaring service. Syntax calendarplaytone get calendarplaytone <yes|no> Parameter Description Gets the current setting for the alert tone.

  • Page 179: Calendarregisterwithserver

    Integrator’s Reference Manual for Polycom HDX Systems System Commands calendarregisterwithserver Enables or disables the calendaring service. Syntax calendarregisterwithserver get calendarregisterwithserver <yes|no> Parameter Description Returns the current server registration status. Enables the calendaring service. Disables the calendaring service. Feedback Examples ● calendarregisterwithserver get...

  • Page 180: Calendarremindertime

    Integrator’s Reference Manual for Polycom HDX Systems System Commands calendarremindertime Gets and sets the reminder time for meetings in the calendar when the system is registered with the calendaring service. Syntax calendarremindertime <get|1|5|10|15|30|none> Parameter Description Gets the current reminder time.

  • Page 181: Calendarresource

    Integrator’s Reference Manual for Polycom HDX Systems System Commands calendarresource Gets and sets the mailbox account being monitored for calendar events. The mailbox account is called a resource. Syntax calendarresource get calendarresource “resource” Parameter Description Returns the resource being monitored for calendar events.

  • Page 182: Calendarserver

    Integrator’s Reference Manual for Polycom HDX Systems System Commands calendarserver Gets or sets the Microsoft Exchange server used by the calendaring service. Syntax calendarserver get calendarserver "server" Parameter Description Gets the current Microsoft Exchange server used by the calendaring service.

  • Page 183: Calendarshowpvtmeetings

    Integrator’s Reference Manual for Polycom HDX Systems System Commands calendarshowpvtmeetings Enables or disables the display of private meetings in the calendar when the system is registered with the calendaring service. Syntax calendarshowpvtmeetings get calendarshowpvtmeetings <yes|no> Parameter Description Gets the current setting for private meeting display.

  • Page 184: Calendarstatus

    Integrator’s Reference Manual for Polycom HDX Systems System Commands calendarstatus Returns the status of the Microsoft Exchange server connection. Syntax calendarstatus get Parameter Description Returns the Microsoft Exchange server connection status. Feedback Examples ● calendarstatus get returns calendarstatus established ● calendarstatus get...

  • Page 185: Calendaruser

    Integrator’s Reference Manual for Polycom HDX Systems System Commands calendaruser Gets or sets the user name the calendaring service uses to log in to the Microsoft Exchange server. Syntax calendaruser get calendaruser “username” Parameter Description Returns the user name being used by the calendaring service.

  • Page 186: Calldetail

    Integrator’s Reference Manual for Polycom HDX Systems System Commands calldetail Displays all call detail records, a specific call detail record, or the call detail range. Syntax calldetail <“Nth_item”|all> calldetail range Parameter Description “Nth_item” Displays the Nth call detail record. Displays all call detail records.

  • Page 187: Calldetailreport

    Integrator’s Reference Manual for Polycom HDX Systems System Commands calldetailreport Sets or gets whether to generate a report of all calls made with the system. Syntax calldetailreport <get|yes|no> Parameter Description Returns the current setting. Turns on call detail reporting. Turns off call detail reporting.

  • Page 188: Callinfo

    Integrator’s Reference Manual for Polycom HDX Systems System Commands callinfo Returns information about the current call. If you are in a multipoint call, this command returns one line for each site in the call. Syntax callinfo all callinfo callid “callid”...

  • Page 189: Callstate

    Integrator’s Reference Manual for Polycom HDX Systems System Commands callstate Sets or gets the call state notification for call state events. Syntax callstate <get|register|unregister> Parameter Description Returns the current setting. register Registers the system to give notification of call activities.

  • Page 190: Callstats

    Integrator’s Reference Manual for Polycom HDX Systems System Commands callstats Returns call summary information. Syntax callstats Feedback Examples ● callstats returns timeinlastcall 0:02:35 totalnumberofcalls 23 totalnumberofipcalls 23 totaltimeipcalls 2:08:44 percentageipcalls 100% totalnumberofisdncalls 0 totaltimeisdncalls 00:00:00 percentageisdncalls 0% Polycom, Inc.

  • Page 191: Camera

    Integrator’s Reference Manual for Polycom HDX Systems System Commands camera Sets or gets the near-site or far-site camera settings. Syntax camera near {1..4} camera far {1..4} camera <near|far> move <left|right|up|down|zoom+|zoom-|stop> camera <near|far> move <continuous|discrete> camera <near|far> source camera <near|far> stop camera near <getposition|setposition “x”...
  • Page 192 -300 <= tilt <= 300 0 <= zoom <= 1023 Notes: The camera PTZ range applies to the Polycom EagleEye HD camera. Different cameras might have different PTZ values. Some D30 cameras might not be able to reach the full range limit.
  • Page 193 Integrator’s Reference Manual for Polycom HDX Systems System Commands Parameter Description tracking statistics Gets EagleEye Director tracking statistics. Tracking statistics measure: • the amount of time tracking is turned off divided by the total call time in the most recent 100 calls lasting more than five minutes.
  • Page 194 Integrator’s Reference Manual for Polycom HDX Systems System Commands Comments If the camera near {1..6} API command is used for an input configured as content, the command becomes a toggle. You must send the command once to send the content source and a second time to stop the content source.

  • Page 195: Cameradirection

    Integrator’s Reference Manual for Polycom HDX Systems System Commands cameradirection Sets or gets the camera pan direction. Syntax cameradirection <get|normal|reversed> Parameter Description Returns the current setting. normal Sets the direction of the camera to normal; the camera moves in the same direction as the left and right arrows on the remote control.

  • Page 196: Camerainput

    Integrator’s Reference Manual for Polycom HDX Systems System Commands camerainput Sets or gets the format for a video source. Syntax camerainput <1|2|3> <get|s-video|composite|component> camerainput <4|5> <get|dvi|vga> Parameter Description <1..4> Specifies the video source. camerainput 5 is available only on the Polycom HDX 9004.

  • Page 197: Chaircontrol

    Integrator’s Reference Manual for Polycom HDX Systems System Commands chaircontrol Sends various chair control commands while the system is in a multipoint call. Syntax chaircontrol end_conf chaircontrol hangup_term “term_no” chaircontrol list chaircontrol rel_chair chaircontrol <register|unregister> chaircontrol req_chair chaircontrol req_floor chaircontrol req_term_name “term_no”...
  • Page 198 Integrator’s Reference Manual for Polycom HDX Systems System Commands Parameter Description set_term_name Sets the name for the specified terminal number. “term_no” “term_name” Stops viewing the specified terminal. stop_view view “term_no” Views the specified terminal. view_broadcaster Views the broadcaster. Feedback Examples ●...

  • Page 199: Clientvalidatepeercert

    Integrator’s Reference Manual for Polycom HDX Systems System Commands clientvalidatepeercert Enables certificate validation by specifying whether the HDX system requires the server to present a valid certificate when the server makes secure connections for services such as provisioning, directory search, and session initiation protocol (SIP) calling.

  • Page 200: Cmdecho

    Integrator’s Reference Manual for Polycom HDX Systems System Commands cmdecho Turns command echoing on or off. Syntax cmdecho <on|off> Parameter Description Turns on command echoing so that everything you type is echoed on the screen. Turns off command echoing so that nothing you type is echoed on the screen.

  • Page 201: Colorbar

    Integrator’s Reference Manual for Polycom HDX Systems System Commands colorbar Turns the video diagnostics color bars on or off. Syntax colorbar <on|off> Parameter Description Turns on the color bar test pattern. Turns off the color bar test pattern. Feedback Examples ●...

  • Page 202: Configchange (Deprecated)

    Integrator’s Reference Manual for Polycom HDX Systems System Commands configchange (deprecated) Sets or gets the notification state for configuration changes. This command has been deprecated. Syntax configchange <get|register|unregister> Parameter Description Returns the current setting. register Registers to receive notifications when configuration variables have changed.

  • Page 203: Configdisplay

    Integrator’s Reference Manual for Polycom HDX Systems System Commands configdisplay Sets or gets the video format, aspect ratio and resolution for Monitor 1 or Monitor 2. Syntax configdisplay [<monitor1|monitor2>] get configdisplay <monitor1|monitor2> <component|vga|dvi|composite|s_video> <4:3|16:9> configdisplay <monitor1|monitor2> <component|vga|dvi|composite|s_video> <4:3|16:9> [<720p|1080i|1080p>] [<50hz720p|60hz720p|50hz1080i|60hz1080i|50hz1080p|60hz1080p>]...
  • Page 204 Integrator’s Reference Manual for Polycom HDX Systems System Commands Parameter Description 60hz720p Sets the resolution to 1280x720p, 60 Hz (NTSC systems-only). For DVI and VGA formats with a 16:9 aspect ratio only. 50hz1080i Sets the resolution to 1920x1080i, 50 Hz (DVI-only, PAL systems-only).

  • Page 205: Configparam

    Integrator’s Reference Manual for Polycom HDX Systems System Commands configparam Sets or gets the video quality setting for the specified video input for motion or sharpness. Syntax configparam <“parameter”> get configparam <“parameter”> set <“value”> Parameter Possible Values Description camera_video_quality motion|sharpness Sets or gets the video quality <1|2|3|4>...

  • Page 206: Configpresentation

    Integrator’s Reference Manual for Polycom HDX Systems System Commands configpresentation Sets or gets the content presentation settings for Monitor 1 or Monitor 2. Syntax configpresentation get configpresentation <monitor1|monitor2> get configpresentation monitor1 <near|far|content|near-or-far| content-or-near|content-or-far|all|none> configpresentation monitor2 <near|far|content|near-or-far| content-or-near|content-or-far|all|none> configpresentation monitor1 "value" monitor2 "value"...
  • Page 207 Integrator’s Reference Manual for Polycom HDX Systems System Commands Feedback Examples ● configpresentation monitor1 get returns configpresentation monitor1:all ● configpresentation monitor2 get returns configpresentation monitor2:near-or-far ● configpresentation monitor2 far returns error: configpresentation not applied since monitor2 is off when Monitor 2 is off...

  • Page 208: Confirmdiradd

    Integrator’s Reference Manual for Polycom HDX Systems System Commands confirmdiradd Sets or gets the configuration for prompting users to add directory entries for the far sites when a call disconnects. Syntax confirmdiradd <get|yes|no> Parameter Description Returns the current setting. When a call disconnects, the user is prompted to create a local directory entry for the far site if it is not already in the directory.

  • Page 209: Confirmdirdel

    Integrator’s Reference Manual for Polycom HDX Systems System Commands confirmdirdel Sets or gets the configuration for requiring users to confirm directory deletions. Syntax confirmdirdel <get|yes|no> Parameter Description Returns the current setting. When deleting an entry from the directory (address book), the user is prompted with “Are you sure you want to delete this entry?”...

  • Page 210: Contentauto

    Integrator’s Reference Manual for Polycom HDX Systems System Commands contentauto Sets or gets the automatic bandwidth adjustment for people and content in point-to-point H.323 calls. Automatic adjustment maintains equal image quality in the two streams. Syntax contentauto <get|on|off> Parameter Description Returns the current setting.

  • Page 211: Contentsplash

    Comments The splash screen displays a Polycom logo on content-only displays when neither the near end nor the far end is sending content, and when the Polycom HDX system is not in sleep mode. By default, the content splash value is set to yes.

  • Page 212: Contentvideoadjustment

    Integrator’s Reference Manual for Polycom HDX Systems System Commands contentvideoadjustment Sets or gets the content video adjustment setting. Syntax contentvideoadjustment <get|normal|stretch|zoom> Parameter Description Returns the current setting. normal Preserves the aspect ratio of the source video. The image is scaled (if necessary) to the largest supported resolution that fits on the display without cropping.

  • Page 213: Country

    Integrator’s Reference Manual for Polycom HDX Systems System Commands country Gets the country setting for the system. Syntax country get Parameter Description Returns the current setting. Feedback Examples ● country get returns country “united states” Polycom, Inc.

  • Page 214: Cts

    Integrator’s Reference Manual for Polycom HDX Systems System Commands Sets or gets the CTS serial interface control signal (clear to send) configuration. This command is only applicable if you have a V.35 network interface connected to your system. Syntax cts <get|normal|inverted|ignore>...

  • Page 215: Daylightsavings

    Integrator’s Reference Manual for Polycom HDX Systems System Commands daylightsavings Sets or gets the daylight saving time setting. When you enable this setting, the system clock automatically changes for daylight saving time. Syntax daylightsavings <get|yes|no> Parameter Description Returns the current setting.

  • Page 216: Dcd

    Integrator’s Reference Manual for Polycom HDX Systems System Commands Sets the configuration for the DCD serial interface control signal (data carrier detect). This command is only applicable if you have a V.35 network interface connected to your system. Syntax dcd <normal|inverted>...

  • Page 217: Dcdfilter

    Integrator’s Reference Manual for Polycom HDX Systems System Commands dcdfilter Sets or gets the filter setting of the DCD serial interface control signal (data carrier detect). This command is only applicable if you have a V.35 network interface connected to your system.

  • Page 218: Defaultgateway

    Integrator’s Reference Manual for Polycom HDX Systems System Commands defaultgateway Sets or gets the default gateway. Syntax defaultgateway get defaultgateway set “xxx.xxx.xxx.xxx” Parameter Description Returns the default gateway IP address. Sets the default gateway when followed by the “xxx.xxx.xxx.xxx” parameter.

  • Page 219: Destunreachabletx

    Integrator’s Reference Manual for Polycom HDX Systems System Commands destunreachabletx Sets or gets the system’s ability to generate a Destination Unreachable ICMP message in response to a packet that cannot be delivered to its destination for reasons other than congestion.

  • Page 220: Dhcp

    Integrator’s Reference Manual for Polycom HDX Systems System Commands dhcp Sets or gets DHCP options. Syntax dhcp <get|off|client> Parameter Description Returns the selected DHCP option. Disables DHCP. client Enables DHCP client, setting the system to obtain an IP address from a server on your network.

  • Page 221: Dial

    Integrator’s Reference Manual for Polycom HDX Systems System Commands dial Dials video or audio calls either manually or from the directory. Syntax dial addressbook “addr book name” dial auto “speed” “dialstr”dial manual <56|64> “dialstr1” “dialstr2” [h320] dial manual “speed” “dialstr1” [“dialstr2”] [h323|h320|ip|isdn|sip] dial phone “dialstring”...
  • Page 222 Integrator’s Reference Manual for Polycom HDX Systems System Commands Parameter Description pots|isdn_phone|sip_spe Specify to dial pots, ISDN or SIP call. akerphone “dialstring” Numeric string specifying the phone number to dial. Enclose the string in quotation marks if it includes spaces. Example: “512 555 1212”...
  • Page 223 Integrator’s Reference Manual for Polycom HDX Systems System Commands notification:callstatus:outgoing:45: Polycom Austin: 192.168.1.101:connected:384:0:videocall Note: The call ID number (45) is an example of the response. The Call ID number depends upon the call type. Comments When searching for feedback from the dial command, expect to see the set of described strings as many times as there are channels in the call.

  • Page 224: Dialchannels

    Integrator’s Reference Manual for Polycom HDX Systems System Commands dialchannels Sets or gets whether to dial ISDN channels in parallel. This command is only applicable if you have an ISDN network interface connected to your system. Syntax dialchannels get dialchannels set n...

  • Page 225: Diffservaudio, Diffservfecc, Diffservvideo

    Integrator’s Reference Manual for Polycom HDX Systems System Commands diffservaudio, diffservfecc, diffservvideo Sets or gets the DiffServ option and specifies a priority level for audio, far-end camera control (FECC) and other call control channels, and video, respectively. The priority level value for each can be between 0 and...

  • Page 226: Directory

    Integrator’s Reference Manual for Polycom HDX Systems System Commands directory Sets or gets whether the Directory button appears on the Home screen. Syntax directory <get|yes|no> Parameter Description Returns the current setting. Displays the Directory button on the Home screen. Removes the Directory button from the Home screen.

  • Page 227: Display (Deprecated)

    Integrator’s Reference Manual for Polycom HDX Systems System Commands display (deprecated) Displays information about the current call or the system. With the implementation of the callinfo command on page whoami command on page 571, this command has been deprecated. Syntax...

  • Page 228: Displayglobaladdresses

    Integrator’s Reference Manual for Polycom HDX Systems System Commands displayglobaladdresses Sets or gets the display of global addresses in the global directory. Syntax displayglobaladdresses <get|yes|no> Parameter Description Returns the current setting. Enables the display of global addresses. Disables the display of global addresses.

  • Page 229: Displaygraphics

    Integrator’s Reference Manual for Polycom HDX Systems System Commands displaygraphics Sets or gets the display of graphic icons while in a call. Syntax displaygraphics <get|yes|no> Parameter Description Returns the current setting. Enables the display of graphic icons. Disables the display of graphic icons.

  • Page 230: Displayipext

    Integrator’s Reference Manual for Polycom HDX Systems System Commands displayipext Sets or gets the display of the IP extension field. This extension is needed when placing a call through a gateway. Syntax displayipext <get|yes|no> Parameter Description Returns the current setting.

  • Page 231: Displayipisdninfo (Deprecated)

    Integrator’s Reference Manual for Polycom HDX Systems System Commands displayipisdninfo (deprecated) Sets or gets the display of IP and ISDN information on the Home screen. This command has been deprecated. Polycom recommends using the ipisdninfo command on page 307. Syntax displayipisdninfo <yes|no|both|ip-only|isdn-only|none|get>...

  • Page 232: Displayparams

    Integrator’s Reference Manual for Polycom HDX Systems System Commands displayparams Outputs a list of system settings. Syntax displayparams Feedback Examples ● displayparams returns systemname Polycom HDXVSX Demo hostname <empty> ipaddress 192.168.1.101 wanipaddress 192.168.1.102 version “release 8.7 - 26jun2007 11:302.5” serialnum 82065205E72ECB1...
  • Page 233 Integrator’s Reference Manual for Polycom HDX Systems System Commands primarycamera 1 backlightcompensation no audioquality get failed audioqualityg7221 get failed telecountrycode <empty> teleareacode <empty> telenumber <empty> roomphonenumber <empty> echocancellerred no echocancellerwhite no muteautoanswer yes vcraudioout no vcrrecordsource content-or-auto midrangespeaker on subwoofer on...

  • Page 234: Dns

    Integrator’s Reference Manual for Polycom HDX Systems System Commands Sets or gets the configuration for up to four DNS servers. Syntax dns get {1..4} dns set {1..4} “xxx.xxx.xxx.xxx” Parameter Description Returns the current IP address of the specified server. A server identification number {1..4} is required.

  • Page 235: Dsr

    Integrator’s Reference Manual for Polycom HDX Systems System Commands Sets or gets the configuration of the DSR serial interface control signal (data set ready). This command is only applicable if you have a V.35 network interface connected to your system.

  • Page 236: Dsranswer

    Integrator’s Reference Manual for Polycom HDX Systems System Commands dsranswer Sets or gets the configuration of the DSR serial interface control signal to indicate an incoming call. This command is only applicable if you have a V.35 network interface connected to your system.

  • Page 237: Dtr

    Integrator’s Reference Manual for Polycom HDX Systems System Commands Sets or gets the configuration of the DTR serial interface control signal (data terminal ready). This command is only applicable if you have a V.35 network interface connected to your system.

  • Page 238: Dualmonitor

    Integrator’s Reference Manual for Polycom HDX Systems System Commands dualmonitor Sets or gets whether video is displayed using dual monitor emulation, or split-screen mode, when using one monitor. Syntax dualmonitor <get|yes|no> Parameter Description Returns the current setting. Enables dual monitor emulation.

  • Page 239: Dynamicbandwidth

    Integrator’s Reference Manual for Polycom HDX Systems System Commands dynamicbandwidth Sets or gets the use of dynamic bandwidth allocation for Quality of Service. Syntax dynamicbandwidth <get|yes|no> Parameter Description Returns the current setting. Enables the dynamic bandwidth option. Disables the dynamic bandwidth option.

  • Page 240: E164Ext

    Integrator’s Reference Manual for Polycom HDX Systems System Commands e164ext Sets or gets an H.323 (IP) extension, also known as an E.164 name. Syntax e164ext get e164ext set “e.164name” Parameter Description Returns the current setting. Sets the E.164 extension when followed by the “e.164name”...

  • Page 241: Echo

    Integrator’s Reference Manual for Polycom HDX Systems System Commands echo Prints “string” back to the API client screen. Syntax echo “string” Parameter Description “string” Text to be printed to the screen. Feedback Examples ● echo End of abk range results...

  • Page 242: Echocanceller

    ● echocanceller get returns echocanceller no echocanceller no Comments This option is enabled by default. Polycom strongly recommends that you do not turn off echo cancellation except when using an external microphone system with its own built-in echo cancellation. Polycom, Inc.

  • Page 243: Echoreply

    Integrator’s Reference Manual for Polycom HDX Systems System Commands echoreply Sets or gets the system’s ability to send an Echo Reply message in response to an Echo Request message sent to an IPv6 or IPv4 multicast/anycast address. Syntax echoreply <get|yes|no>...

  • Page 244: Enablefirewalltraversal

    Integrator’s Reference Manual for Polycom HDX Systems System Commands enablefirewalltraversal Sets or gets the Enable H.460 Firewall Traversal setting. This feature requires an Edgewater session border controller that supports H.460. Syntax enablefirewalltraversal <get|on|off> Parameter Description Returns the current setting. Enables the firewall traversal feature.

  • Page 245: Enablekeyboardnoisereduction

    Integrator’s Reference Manual for Polycom HDX Systems System Commands enablekeyboardnoisereduction Sets or gets the Enable Keyboard Noise Reduction setting. Syntax enablekeyboardnoisereduction <get|yes|no> Parameter Description Returns the current setting. Enables keyboard noise reduction. Disables keyboard noise reduction. Feedback Examples ● enablekeyboardnoisereduction yes...

  • Page 246: Enablelivemusicmode

    Integrator’s Reference Manual for Polycom HDX Systems System Commands enablelivemusicmode Sets or gets the Enable MusicMode setting. Syntax enablelivemusicmode <get|yes|no> Parameter Description Returns the current setting. Enables live music mode. Disables live music mode. Feedback Examples ● enablelivemusicmode yes returns enablelivemusicmode yes ●...

  • Page 247: Enablepvec

    Integrator’s Reference Manual for Polycom HDX Systems System Commands enablepvec Sets or gets the Polycom Video Error Concealment (PVEC) setting on the system. Syntax enablepvec <get|yes|no> Parameter Description Returns the current setting. Enables the PVEC option. Disables the PVEC option.

  • Page 248: Enablersvp

    Integrator’s Reference Manual for Polycom HDX Systems System Commands enablersvp Sets or gets the RSVP (Resource Reservation Protocol) setting on the system, which requests that routers reserve bandwidth along an IP connection path. Syntax enablersvp <get|yes|no> Parameter Description Returns the current setting.

  • Page 249: Enablesnmp

    Integrator’s Reference Manual for Polycom HDX Systems System Commands enablesnmp Sets or gets the SNMP configuration. Syntax enablesnmp <get|yes|no> Parameter Description Returns the current setting. Enables the SNMP option. Disables the SNMP option. Feedback Examples ● enablesnmp yes returns enablesnmp yes ●...

  • Page 250: Encryption

    Integrator’s Reference Manual for Polycom HDX Systems System Commands encryption Sets or gets the AES encryption mode for the system. Syntax encryption <get|yes|no|requiredvideocallsonly|requiredallcalls> Parameter Description Returns the current setting. Use encryption when the far site is capable of encryption. Note: This parameter is called “When Available” in the user interface.
  • Page 251 Integrator’s Reference Manual for Polycom HDX Systems System Commands Comments You cannot use this command while a call is in progress. Using this command while the system is in a call returns an error: command has illegal parameters message. Polycom, Inc.

  • Page 252: Exit

    Integrator’s Reference Manual for Polycom HDX Systems System Commands exit Ends the API command session. Syntax exit Feedback Examples ● exit returns Connection to host lost. Comments This command ends a Telnet session. For serial sessions, this command effectively starts a new session.

  • Page 253: Exportdirectory

    Integrator’s Reference Manual for Polycom HDX Systems System Commands exportdirectory Exports a directory in XML format. Syntax exportdirectory Feedback Example exportdirectory returns exportdirectory started <?xml version="1.0" encoding="UTF-8" ?> <addresses> <entrytype type="entry" name="dawn" filename="dawn" uniqueid="local:26"> <address filename="dawn " langid=" " displayname="dawn "...
  • Page 254 Polycom HDX software. Exporting a directory on one system model and importing the directory on another model is not supported.
  • Page 255 Integrator’s Reference Manual for Polycom HDX Systems System Commands ● Polycom HDX systems running software version 2.6 or later can import directory data exported from systems running 2.6 and earlier versions. ● Polycom HDX systems running software versions earlier than 2.6 cannot import directory data exported by systems running software version 2.6 or later.

  • Page 256: Exportprofile

    Integrator’s Reference Manual for Polycom HDX Systems System Commands exportprofile Exports system and user profile information in a CSV format. The output is available through a telnet or serial port connection. Syntax exportprofile Feedback Example exportprofile started profileversion,0.2 system.info.eulafile,eula system.info.hardwareversion,9 system.info.humanreadablemodel,RealPresence Group 500...
  • Page 257 Polycom HDX software. Exporting a directory on one system model and importing the directory on another model is not supported.

  • Page 258: Exportprofile

    The format of the exported data might change in future software releases and any application attempting to interpret the data could find its ability to do so compromised in later releases of Polycom HDX software. See Also...

  • Page 259: Farcontrolnearcamera

    Integrator’s Reference Manual for Polycom HDX Systems System Commands farcontrolnearcamera Sets or gets far control of the near camera, which allows far sites to control the camera on your system. Syntax farcontrolnearcamera <get|yes|no> Parameter Description Returns the current setting. Allows the far site to control the near camera if the far site has this capability.

  • Page 260: Farnametimedisplay

    Integrator’s Reference Manual for Polycom HDX Systems System Commands farnametimedisplay Sets or gets the length of time the far-site name is displayed on the system. Syntax farnametimedisplay off farnametimedisplay <get|on|15|30|60|120> Parameter Description Disables the far site name display. Returns the current setting.

  • Page 261: Flash

    Integrator’s Reference Manual for Polycom HDX Systems System Commands flash Flashes the analog phone call. Syntax flash [“callid”] flash [“callid”] [“duration”] Parameter Description callid Specifies the callid to flash. duration Specifies the pulse duration in ms. Feedback Examples ● flash 34 5...

  • Page 262: Gabk (Deprecated)

    Integrator’s Reference Manual for Polycom HDX Systems System Commands gabk (deprecated) Returns global directory (address book) entries. This command has been deprecated. Polycom recommends using the gaddrbook command on page 249. Syntax gabk all gabk batch {0..59} gabk batch define “start_no” “stop_no”...
  • Page 263 Valid characters are: - _ / ; @ , . \ 0 through 9, a through z Polycom HDX systems search on the Display Name. Individual words within the Display Name, or GDS Guestbook, are determined through the use of delimiters.
  • Page 264 Integrator’s Reference Manual for Polycom HDX Systems System Commands ● gabk batch search Polycom 2 returns “Polycom HDX Demo 1” isdnspd:384 isdnnum:1.700.5551212 isdnext: “Polycom HDX Demo 2” isdnspd:2x64 isdnnum:1.700.5552323 isdnext: gabk batch search Polycom 2 done ● gabk letter p returns “Polycom HDX Demo 1”...

  • Page 265: Gabpassword

    Integrator’s Reference Manual for Polycom HDX Systems System Commands gabpassword Sets the password to gain access to the Global Directory Server. Syntax gabpassword set [“password”] Parameter Description Sets the GDS password to “password”. To erase the current setting, omit “password”.

  • Page 266: Gabserverip

    Integrator’s Reference Manual for Polycom HDX Systems System Commands gabserverip Sets or gets the IP address of the Global Directory Server. Syntax gabserverip <get|set> Parameter Description Returns the current setting. Sets the GDS server’s IP address when followed by the parameter “xxx.xxx.xxx.xxx”.

  • Page 267: Gaddrbook

    Integrator’s Reference Manual for Polycom HDX Systems System Commands gaddrbook Returns global directory (address book) entries. Syntax Commands for GDS directory: gaddrbook all gaddrbook batch {0..59} gaddrbook batch define “start_no” “stop_no” gaddrbook batch search “pattern” “count” gaddrbook letter {a..z} gaddrbook range “start_no” “stop_no”...
  • Page 268 - _ / ; @ , . \ 0 through 9 a through z Polycom HDX systems search on the Display Name. Individual words within the Display Name, or GDS Guestbook, are determined through the use of delimiters. Supported delimiter characters are: "...
  • Page 269 Integrator’s Reference Manual for Polycom HDX Systems System Commands Parameter Description group Returns a list of the members of a specified group. A multi-codec system will appear as a single row with a sys_id_string field containing multiple sys_id’s. (See the sys_id_string description below.)
  • Page 270 Integrator’s Reference Manual for Polycom HDX Systems System Commands Parameter Description address Obtains the address information for a specified entry. For a multi-codec system, there will be separate lines for each codec, distinguished by the codec’s sys_id. The codecs will be retuned in order, starting with the primary codec.
  • Page 271 "globaladdrmaxh323" is returned. The default is 384. h323_num For LDAP entries Polycom HDX systems currently do not use this field. It is always blank. h323_ext If an LDAP entry has a value for the H.350.1 h323Identityh323-ID attribute (H.323 alias), it will...
  • Page 272 Integrator’s Reference Manual for Polycom HDX Systems System Commands Feedback Examples ● gaddrbook all returns gaddrbook 0. “Polycom HDX Demo 1” isdn_spd:384 isdn_num:1.700.5551212 isdn_ext: gaddrbook 1. “Polycom HDX Demo 2” h323_spd:384 h323_num:192.168.1.101 h323_ext:7878 gaddrbook 2. “Polycom HDX Demo 3” sip_spd:384 sip_num:polycomhdx@polycom.com...
  • Page 273 Integrator’s Reference Manual for Polycom HDX Systems System Commands gaddrbook 3. “Polycom HDX Demo 3” phone_num:1.512.5121212 gaddrbook 19. “Polycom HDX Demo 20” h323_spd:384 h323_num:192.168.1.120 h323_ext: gaddrbook letter p done ● gaddrbook range 0 2 returns gaddrbook 0. “Polycom HDX Demo 1” isdn_spd:384 isdn_num:1.700.5551212 isdn_ext: gaddrbook 1.
  • Page 274 Integrator’s Reference Manual for Polycom HDX Systems System Commands phone_num: type:video gaddrbook system 1. name:"Mark Duckworth" sys_label:"HDX" sys_id:"10006" phone_num:"978.292.5478" type:video gaddrbook system 2. name:"Scott Wilson" sys_label:"HDX" sys_id:"10047" phone_num:"978.292.5347" type:video gaddrbook system 3. name:"Simbalab" sys_label:"HDX" sys_id:"10037#10038#10077" phone_num: type:multicodec gaddrbook system 4. name:"Tanvir Rahman"...
  • Page 275 When the system is registered with the LDAP directory server, only the gaddrbook batch search “pattern” “count” is supported. All other gaddrbook commands return the response command not supported. When the system is registered with the Polycom GDS directory server, all of the gaddrbook commands and parameters are supported.

  • Page 276: Gatekeeperip

    Integrator’s Reference Manual for Polycom HDX Systems System Commands gatekeeperip Sets or gets the IP address of the gatekeeper. Syntax gatekeeperip get gatekeeperip set [“xxx.xxx.xxx.xxx”] Parameter Description Returns the current setting. Sets the gatekeeper IP address when followed by the “xxx.xxx.xxx.xxx”...

  • Page 277: Gatewayareacode

    Integrator’s Reference Manual for Polycom HDX Systems System Commands gatewayareacode Sets or gets the gateway area code. Syntax gatewayareacode get gatewayareacode set [“areacode”] Parameter Description Returns the area code for the gateway. Sets the area code when followed by the “areacode”...

  • Page 278: Gatewaycountrycode

    Integrator’s Reference Manual for Polycom HDX Systems System Commands gatewaycountrycode Sets or gets the gateway country code. Syntax gatewaycountrycode get gatewaycountrycode set [“countrycode”] Parameter Description Returns the current setting. Sets the gateway country code when followed by the “countrycode” parameter. To erase the current setting, omit “countrycode”.

  • Page 279: Gatewayext

    Integrator’s Reference Manual for Polycom HDX Systems System Commands gatewayext Sets or gets the gateway extension number. Syntax gatewayext get gatewayext set [“extension”] Parameter Description Returns the current setting. Sets the gateway extension number when followed by the “extension” parameter. To reset the default value, omit “extension”.

  • Page 280: Gatewaynumber

    Integrator’s Reference Manual for Polycom HDX Systems System Commands gatewaynumber Sets or gets the gateway number. Syntax gatewaynumber get gatewaynumber set [“number”] Parameter Description Returns the current setting. Sets the gateway number when followed by the “number” parameter. To erase the current setting, omit “number”.

  • Page 281: Gatewaynumbertype

    Integrator’s Reference Manual for Polycom HDX Systems System Commands gatewaynumbertype Sets or gets the Gateway Number Type, which can be either Direct Inward Dial (DID) or Number+Extension. Syntax gatewaynumbertype <get|did|number+extension> Parameter Description Returns the current setting. Indicates that the gateway number is a direct inward dial number;...

  • Page 282: Gatewayprefix

    Integrator’s Reference Manual for Polycom HDX Systems System Commands gatewayprefix Sets or gets the gateway prefixes for the corresponding speeds. Syntax gatewayprefix get “valid speed” gatewayprefix set “valid speed” [“value”] Parameter Description When followed by the “valid speed” parameter, returns the current value for this speed.

  • Page 283: Gatewaysetup

    Integrator’s Reference Manual for Polycom HDX Systems System Commands gatewaysetup Lists all available speeds and values at once. Syntax gatewaysetup Feedback Examples ● gatewaysetup returns <empty> <empty> 2x56 #222 #333 #444 #555 2x64 <empty> <empty> and so on. Polycom, Inc.

  • Page 284: Gatewaysuffix

    Integrator’s Reference Manual for Polycom HDX Systems System Commands gatewaysuffix Sets or gets the gateway suffix. Syntax gatewaysuffix get “valid speed” gatewaysuffix set “valid speed” [“value”] Parameter Description Returns the current value for this speed. “valid speed” Valid speeds are: 56, 64, 2x56, 112, 2x64, 128, 168,...

  • Page 285: Gdsdirectory

    Comments Each Polycom system supports a single global directory server at any given time. Therefore, enabling the Polycom GDS directory server automatically disables any other global directory server, such as the LDAP directory server, that is enabled.

  • Page 286: Gendial

    Integrator’s Reference Manual for Polycom HDX Systems System Commands gendial Generates DTMF dialing tones. Syntax gendial <{0..9}|#|*> Parameter Description {0..9} Generates the DTMF tone corresponding to telephone buttons 0-9. Generates the DTMF tone corresponding to a telephone # button. Generates the DTMF tone corresponding to a telephone * button.

  • Page 287: Gendialtonepots (Deprecated)

    Integrator’s Reference Manual for Polycom HDX Systems System Commands gendialtonepots (deprecated) Generates DTMF dialing tones over an analog phone line. This command has been deprecated. Polycom recommends using the gendial command on page 268. Syntax gendialtonepots <{0..9}|#|*> Parameter Description {0..9} Generates the DTMF tone corresponding to telephone buttons 0-9.

  • Page 288: Generatetone

    Integrator’s Reference Manual for Polycom HDX Systems System Commands generatetone Turns the test tone on or off. The tone is used to check the monitor audio cable connections or to monitor the volume level. Syntax generatetone <on|off> Parameter Description Turns on the test tone.

  • Page 289: Get Screen

    Integrator’s Reference Manual for Polycom HDX Systems System Commands get screen Returns the name of the current screen so that the control panel programmer knows which screen the user interface is currently displaying. Syntax get screen Feedback Examples ● get screen...

  • Page 290: Getcallstate

    Integrator’s Reference Manual for Polycom HDX Systems System Commands getcallstate Gets the state of the calls in the current conference. Syntax getcallstate Feedback Examples ● getcallstate returns cs: call[34] speed[384] dialstr[192.168.1.101] state[connected] cs: call[1] inactive cs: call[2] inactive See Also...

  • Page 291: Getconfiguredipaddress

    Integrator’s Reference Manual for Polycom HDX Systems System Commands getconfiguredipaddress Retrieves the currently configured IPv4 address from the system. Syntax getconfiguredipaddress Feedback Examples ● getconfiguredipaddress returns getconfiguredipaddress 1.2.3.4 Comments getconfiguredipaddress returns the currently configured IPv4 address of the system regardless of the status of the LAN connection.

  • Page 292: Gmscity

    Integrator’s Reference Manual for Polycom HDX Systems System Commands gmscity Sets or gets the Polycom Global Management System™ city information. Syntax gmscity get gmscity set [“city”] Parameter Description Returns the current setting. Sets the Global Management System city name when followed by the “city”...

  • Page 293: Gmscontactemail

    Integrator’s Reference Manual for Polycom HDX Systems System Commands gmscontactemail Sets or gets the Global Management System contact email information. Syntax gmscontactemail get gmscontactemail set [“email”] Parameter Description Returns the current contact email address. Sets the Global Management system contact email address when followed by the “email”...

  • Page 294: Gmscontactfax

    Integrator’s Reference Manual for Polycom HDX Systems System Commands gmscontactfax Sets or gets the Global Management System contact fax information. Syntax gmscontactfax get gmscontactfax set [“fax number”] Parameter Description Returns the current contact fax information. Sets the Global Management System contact fax information when followed by the “fax number”...

  • Page 295: Gmscontactnumber

    Integrator’s Reference Manual for Polycom HDX Systems System Commands gmscontactnumber Sets or gets the Global Management System contact number information. Syntax gmscontactnumber get gmscontactnumber set [“number”] Parameter Description Returns the current contact number. Sets the Global Management System contact number when followed by the “number”...

  • Page 296: Gmscontactperson

    Integrator’s Reference Manual for Polycom HDX Systems System Commands gmscontactperson Sets or gets the Global Management System contact person information. Syntax gmscontactperson get gmscontactperson set [“person”] Parameter Description Returns the current contact person information. Sets the Global Management System contact person name when followed by the “person”...

  • Page 297: Gmscountry

    Integrator’s Reference Manual for Polycom HDX Systems System Commands gmscountry Sets or gets the Global Management System country information. Syntax gmscountry get gmscountry set [“countryname”] Parameter Description Returns the current country setting. Sets the Global Management System country information when followed by the “countryname”...

  • Page 298: Gmsstate

    Integrator’s Reference Manual for Polycom HDX Systems System Commands gmsstate Sets or gets the Global Management System state information. Syntax gmsstate get gmsstate set [“state”] Parameter Description Returns the current state information. Sets the Global Management System state information when followed by the “state” parameter. To erase the current setting, omit the “state”...

  • Page 299: Gmstechsupport

    Integrator’s Reference Manual for Polycom HDX Systems System Commands gmstechsupport Sets or gets the Global Management System technical support phone number. Syntax gmstechsupport get gmstechsupport set [“tech_support_digits”] Parameter Description Returns the current tech support phone number information. Sets the technical support information when followed by the “tech_support_digits”...

  • Page 300: Gmsurl

    Integrator’s Reference Manual for Polycom HDX Systems System Commands gmsurl Gets the URL of the Global Management System server that manages your system. This command automatically appends “/pwx/vs_status.asp”. Syntax gmsurl get {1..10} gmsurl get all Parameter Description Returns the current URL information for a selected server.

  • Page 301: H239Enable

    Integrator’s Reference Manual for Polycom HDX Systems System Commands h239enable Sets or gets the H.239 People+Content setting. Syntax h239enable get h239enable <yes|no> Parameter Description Returns the current setting. Enables H.239 People+Content on the system. Disables H.239 People+Content on the system.

  • Page 302: H323Name

    Integrator’s Reference Manual for Polycom HDX Systems System Commands h323name Sets or gets the system’s H.323 name. Syntax h323name get h323name set [“H.323name”] Parameter Description Returns the current setting. Sets the H.323 name when followed by the “H.323name” parameter. To erase this setting, omit the “H.323name”...

  • Page 303: H331Audiomode

    Integrator’s Reference Manual for Polycom HDX Systems System Commands h331audiomode Set or gets the audio protocol sent during H.331 calls. This command is only applicable if you have a V.35 network interface connected to your system. Syntax h331audiomode <get|g729|g728|g711u|g711a|g722-56|g722-48|g7221-16|g7221-24| g7221-32|siren14|siren14stereo|off>...

  • Page 304: H331Dualstream

    Integrator’s Reference Manual for Polycom HDX Systems System Commands h331dualstream Set or gets the dual stream setting used for H.331 calls. This command is only applicable if you have a V.35 network interface connected to your system. Syntax h331dualstream <get|on|off>...

  • Page 305: H331Framerate

    Integrator’s Reference Manual for Polycom HDX Systems System Commands h331framerate Sets or gets the frame rate sent during H.331 calls. This command is only applicable if you have a V.35 network interface connected to your system. Syntax h331framerate <get|30|15|10|7.5> Parameter Description Returns the current setting.

  • Page 306: H331Videoformat

    Integrator’s Reference Manual for Polycom HDX Systems System Commands h331videoformat Sets or gets the video format for H.331 calls. This command is only applicable if you have a V.35 network interface connected to your system. Syntax h331videoformat <get|fcif> Parameter Description Returns the current setting.

  • Page 307: H331Videoprotocol

    Integrator’s Reference Manual for Polycom HDX Systems System Commands h331videoprotocol Sets or gets the H.331 video protocol sent during H.331 calls. This command is only applicable if you have a V.35 network interface connected to your system. Syntax h331videoprotocol <get|h264|h263+|h263|h261>...

  • Page 308: Hangup

    Integrator’s Reference Manual for Polycom HDX Systems System Commands hangup Hangs up the current video or phone call. Syntax hangup phone hangup video [“callid”] hangup all Parameter Description phone Disconnects the current analog phone (audio-only) site. video Disconnects the current video call. If the “callid”...

  • Page 309: History

    Integrator’s Reference Manual for Polycom HDX Systems System Commands history Lists the last commands used in the current session. Syntax history Feedback Examples ● history returns 1 ipaddress set 192.168.1.101 2 hostname set My 3 lanport 100fdx 4 callstate register...

  • Page 310: Homecallquality

    Integrator’s Reference Manual for Polycom HDX Systems System Commands homecallquality Sets or gets whether users are allowed to select the bandwidth for calls from the Place a Call screen. Syntax homecallquality <get|yes|no> Parameter Description Returns the current setting. Displays the Call Quality menu on the home Place a Call screen.

  • Page 311: Homemultipoint (Deprecated)

    Integrator’s Reference Manual for Polycom HDX Systems System Commands homemultipoint (deprecated) Sets or gets whether users are allowed to access the multipoint dialing screen via a Multipoint button on the home screen. This command has been deprecated. Syntax homemultipoint <get|yes|no>...

  • Page 312: Homerecentcalls

    Integrator’s Reference Manual for Polycom HDX Systems System Commands homerecentcalls Sets or gets whether users are allowed to access a list of recent calls made with the system by displaying the Recent Calls button on the Home screen. Syntax homerecentcalls <get|yes|no>...

  • Page 313: Homesystem

    Integrator’s Reference Manual for Polycom HDX Systems System Commands homesystem Sets or gets whether users are allowed to access the System screen by displaying the System button on the Home screen. Syntax homesystem <get|yes|no> Parameter Description Returns the current setting.

  • Page 314: Homesystemname

    Integrator’s Reference Manual for Polycom HDX Systems System Commands homesystemname Sets or gets whether to display the name of the system on the Home screen, above the PIP window. Syntax homesystemname <get|yes|no> Parameter Description Returns the current setting. Displays the system name on the Home screen.

  • Page 315: Hostname

    Integrator’s Reference Manual for Polycom HDX Systems System Commands hostname Sets or gets the LAN host name, which is assigned to the system for TCP/IP configuration and can be used in place of an IP address when dialing IP calls.

  • Page 316: Importdirectory

    Integrator’s Reference Manual for Polycom HDX Systems System Commands importdirectory Imports local directory information in XML format. Syntax importdirectory <import data line 1> <import data line 2> <import data line 3> importcomplete Feedback Example importdirectory <?xml version="1.0" encoding="UTF-8" ?> <addresses>...
  • Page 317 Integrator’s Reference Manual for Polycom HDX Systems System Commands <multisitename meeting_name="test " /> <multisitespeed meeting_speed="auto"/> <multisitename0 site_name_0="dawn "/> <mulitsitetype0 site_type_0="2" type_0="1000"/> <mulitsiteprefcalltype0 pref_call_type_0="H323"/> <multisiteuniqueid0 unique_id_0="local:28"/> <multisitename1 site_name_1="dawn2 "/> <mulitsitetype1 site_type_1="2" type_1="1000"/> <mulitsiteprefcalltype1 pref_call_type_1="H323"/> <multisiteuniqueid1 unique_id_1="local:30"/> <multisitename2 site<?xml version="1.0" encoding="UTF-8" ?>...
  • Page 318 Integrator’s Reference Manual for Polycom HDX Systems System Commands <mulitsitetype0 site_type_0="2" type_0="1000"/> <mulitsiteprefcalltype0 pref_call_type_0="H323"/> <multisiteuniqueid0 unique_id_0="local:28"/> <multisitename1 site_name_1="dawn2 "/> <mulitsitetype1 site_type_1="2" type_1="1000"/> <mulitsiteprefcalltype1 pref_call_type_1="H323"/> <multisiteuniqueid1 unique_id_1="local:30"/> <multisitename2 site_name_2="dawn3 "/> <mulitsitetype2 site_type_2="2" type_2="1000"/> <mulitsiteprefcalltype2 pref_call_type_2="H323"/> <multisiteuniqueid2 unique_id_2="local:29"/> </address> </entrytype> <entrytype type="group"...
  • Page 319 Additional Usage Notes: ● Polycom HDX systems running software version 2.6 or later can import directory data exported from systems running 2.6 and earlier versions. ● Polycom HDX systems running software versions earlier than 2.6 cannot import directory data exported by systems running software version 2.6 or later.

  • Page 320: Importprofile

    Integrator’s Reference Manual for Polycom HDX Systems System Commands importprofile Imports system and user profile information in a CSV format. The input is submitted through the telnet or serial port. Syntax importprofile <import data line 1> <import data line 2>...
  • Page 321 Additional Usage Notes: ● Polycom HDX systems running software version 2.6 or later can import directory data exported from systems running 2.6 and earlier versions. ● Polycom HDX systems running software versions earlier than 2.6 cannot import directory data exported by systems running software version 2.6 or later.
  • Page 322 Integrator’s Reference Manual for Polycom HDX Systems System Commands Polycom, Inc.

  • Page 323: Ipaddress

    Integrator’s Reference Manual for Polycom HDX Systems System Commands ipaddress Sets or gets the LAN IP address (IPv4) of the system. Syntax ipaddress get ipaddress set “xxx.xxx.xxx.xxx” Parameter Description Returns the current setting. Sets the LAN IP address to the “xxx.xxx.xxx.xxx”...

  • Page 324: Ipdialspeed

    ● ipdialspeed get 168 returns ipdialspeed 168 off Comments The Polycom HDX system does not support separate settings for IP and ISDN dialing speeds.When you change a setting using this command, the settings associated with the isdndialspeed command on page also change, and vice versa.

  • Page 325: Ipisdninfo

    Integrator’s Reference Manual for Polycom HDX Systems System Commands ipisdninfo Sets or gets whether the Home screen displays IP information, ISDN information, both, or neither. Syntax ipisdninfo <get|both|ip-only|isdn-only|none> Parameter Description Returns the current setting. both Displays IP and ISDN information on the Home screen.

  • Page 326: Ipprecaudio, Ipprecfecc, Ipprecvideo

    Integrator’s Reference Manual for Polycom HDX Systems System Commands ipprecaudio, ipprecfecc, ipprecvideo Sets or gets the IP Precedence priority level (Type of Service Value) for audio, far-end camera control (FECC) and other call control channels, and video. The value for each can be between 0 and 7.

  • Page 327: Ipv6Addrmode

    Integrator’s Reference Manual for Polycom HDX Systems System Commands ipv6addrmode Sets or gets the ability for the system to act as a client and receive an address, specify an address manually, or completely disable IPv6. Syntax ipv6addrmode <get|client|manual|off> Parameter Description Returns the current setting.

  • Page 328: Ipv6Globaladdress

    Integrator’s Reference Manual for Polycom HDX Systems System Commands ipv6globaladdress Sets or gets the IPv6 link global address. Syntax ipv6globaladdress get ipv6globaladdress set “ipv6 global address” Parameter Description Returns the current setting. Sets the IPv6 global address. ipv6 link global address The local IPv6 global address.

  • Page 329: Ipv6Defaultgateway

    Integrator’s Reference Manual for Polycom HDX Systems System Commands ipv6defaultgateway Sets or gets the IPv6 default gateway. Syntax ipv6defaultgateway get ipv6defaultgateway set “ipv6 link local address” Parameter Description Returns the current setting. Sets the IPv6 default gateway. ipv6 default gateway The local IPv6 default gateway.

  • Page 330: Ipv6Linklocal

    Integrator’s Reference Manual for Polycom HDX Systems System Commands ipv6linklocal Sets or gets the IPv6 link local address. Syntax ipv6linklocal get ipv6linklocal set “ipv6 link local address” Parameter Description Returns the current setting. Sets the IPv6 link local address. The local IPv6 link local address.

  • Page 331: Ipv6Sitelocal

    Integrator’s Reference Manual for Polycom HDX Systems System Commands ipv6sitelocal Sets or gets the IPv6 site local address. Syntax ipv6sitelocal get ipv6sitelocal set “ipv6 site local address” Parameter Description Returns the current setting. Sets the IPv6 site local address. ipv6 site local address The local IPv6 site local address.

  • Page 332: Ipstat

    Integrator’s Reference Manual for Polycom HDX Systems System Commands ipstat Returns the LAN host name, WINS resolution, DHCP, IP address, DNS servers 1-4, default gateway, WINS server, and subnet mask. Syntax ipstat Feedback Examples ● ipstat returns hostname My domainname domain.polycom.com...

  • Page 333: Isdnareacode

    Integrator’s Reference Manual for Polycom HDX Systems System Commands isdnareacode Sets or gets the ISDN area code or STD code associated with the area where the system is used. This command is only applicable if you have an ISDN network interface connected to your system.

  • Page 334: Isdncountrycode

    Integrator’s Reference Manual for Polycom HDX Systems System Commands isdncountrycode Sets or gets the ISDN country code associated with the country where the system is used. This command is only applicable if you have an ISDN network interface connected to your system.

  • Page 335: Isdndialingprefix

    Integrator’s Reference Manual for Polycom HDX Systems System Commands isdndialingprefix Sets or gets the ISDN dialing prefix used to access an outside line if the system is behind a PBX. This command is only applicable if you have an ISDN network interface connected to your system.

  • Page 336: Isdndialspeed

    ● isdndialspeed get 168 returns isdndialspeed 168 off Comments The Polycom HDX system does not support separate settings for ISDN and IP dialing speeds. When you change a setting using this command, the settings associated with the ipdialspeed command on page also change, and vice versa.

  • Page 337: Isdnnum

    Integrator’s Reference Manual for Polycom HDX Systems System Commands isdnnum Sets or gets the ISDN video number or numbers assigned to the system. This command is only applicable if you have an ISDN network interface connected to your system. Syntax isdnnum get <1b1|1b2|2b1|2b2|3b1|3b2|4b1|4b2>...

  • Page 338: Isdnswitch

    Integrator’s Reference Manual for Polycom HDX Systems System Commands isdnswitch Sets or gets the ISDN switch protocol. This command is only applicable if you have an ISDN network interface connected to your system. Syntax isdnswitch get isdnswitch <pt-to-pt_at&t_5_ess|multipoint_at&t_5_ess|ni-1> isdnswitch <nortel_dms-100|standard_etsi_euro-isdn|ts-031|ntt_ins-64>...

  • Page 339: Keypadaudioconf

    Integrator’s Reference Manual for Polycom HDX Systems System Commands keypadaudioconf Sets or gets the keypad audio confirmation. When this option is enabled, an audio response is echoed when a numeric key is pressed on the remote control. Syntax keypadaudioconf <get|yes|no>...

  • Page 340: Language

    Integrator’s Reference Manual for Polycom HDX Systems System Commands language Sets or gets the language that will display on the system. Syntax language <set|get> language set <arabic|chinese|englishuk|englishus|finnish|french|german| hungarian|italian|japanese|korean|norwegian|polish|portuguese| russian|spanish|traditional_chinese> Parameter Description Returns the current language used on the system. Sets the specified language. Requires a language parameter.

  • Page 341: Lanport

    Integrator’s Reference Manual for Polycom HDX Systems System Commands lanport Sets or gets the LAN port settings of the system. Syntax lanport <get|auto|autohdx|autofdx|10hdx|10fdx|100hdx|100fdx|1000hdx|1000fdx> Parameter Description Returns the current setting. auto|autohdx|autofd Sets the LAN speed and duplex mode. This parameter x|10hdx|10fdx| is not allowed while in a call.

  • Page 342: Ldapauthenticationtype

    Integrator’s Reference Manual for Polycom HDX Systems System Commands ldapauthenticationtype Sets or gets the authentication type required to authenticate with an LDAP server. Syntax ldapauthenticationtype get ldapauthenticationtype set <anonymous|basic|ntlm> Parameter Description Returns the current setting. Sets the authentication type of an LDAP server.

  • Page 343: Ldapbasedn

    Integrator’s Reference Manual for Polycom HDX Systems System Commands ldapbasedn Sets or gets the base distinguished name (DN) of an LDAP server. Syntax ldapbasedn get ldapbasedn set [“base dn”] Parameter Description Returns the current setting. Sets the base DN of an LDAP server. To erase the current setting, omit the “base dn”...

  • Page 344: Ldapbinddn

    Integrator’s Reference Manual for Polycom HDX Systems System Commands ldapbinddn Sets or gets the bind DN for LDAP Simple Authentication. Syntax ldapbinddn get ldapbinddn set [“bind dn”] Parameter Description Returns the current setting. Sets the bind DN for LDAP Simple Authentication. To erase the current setting, omit the “bind dn”...

  • Page 345: Ldapdirectory

    Comments Each Polycom system supports a single global directory server at any given time. Therefore, enabling the LDAP directory server automatically disables any other global directory server, such as the Polycom GDS directory server, that is enabled.

  • Page 346: Ldapntlmdomain

    Integrator’s Reference Manual for Polycom HDX Systems System Commands ldapntlmdomain Sets or gets the domain in which authentication takes place in the Active Directory server. Syntax ldapntlmdomain get ldapntlmdomain set [“domain”] Parameter Description Returns the current setting. Sets the domain in which authentication takes place in the Active Directory server.

  • Page 347: Ldappassword

    Integrator’s Reference Manual for Polycom HDX Systems System Commands ldappassword Sets the password for Simple or NT LAN Manager (NTLM) authentication of an LDAP server. Syntax ldappassword set <ntlm|basic> [“password”] Parameter Description Sets the password for Simple or NTLM authentication of an LDAP server.

  • Page 348: Ldapserveraddress

    Integrator’s Reference Manual for Polycom HDX Systems System Commands ldapserveraddress Sets or gets the LDAP server address. Syntax ldapserveraddress get ldapserveraddress set [“address”] Parameter Description Returns the current setting. Sets the IP address or the DNS name of an LDAP server.

  • Page 349: Ldapserverport

    Integrator’s Reference Manual for Polycom HDX Systems System Commands ldapserverport Sets or gets the port number of an LDAP server. Syntax ldapserverport get ldapserverport set [“port number”] Parameter Description Returns the current setting. Sets the port number of an LDAP server. To erase the current setting, omit the “port number”...

  • Page 350: Ldapsslenabled

    Integrator’s Reference Manual for Polycom HDX Systems System Commands ldapsslenabled Sets or gets the Secure Sockets Layer (SSL)/Transport Layer Security (TLS) encryption state for LDAP operations. Syntax ldapsslenabled get ldapsslenabled set [on|off] Parameter Description Returns the current setting. Sets the SSL encryption state for LDAP operations.

  • Page 351: Ldapusername

    Integrator’s Reference Manual for Polycom HDX Systems System Commands ldapusername Sets or gets the user name for NTLM authentication of an LDAP server. Syntax ldapusername get ldapusername set [“user name”] Parameter Description Returns the current setting. Sets the user name for NTLM authentication of an LDAP server.

  • Page 352: Linestate

    Integrator’s Reference Manual for Polycom HDX Systems System Commands linestate Sets or gets API session registration to receive notifications about IP or ISDN line state changes. Syntax linestate get linestate <register|unregister> Parameter Description Returns the current setting. register Registers to receive notification when IP or ISDN line states change.

  • Page 353: Listen

    Integrator’s Reference Manual for Polycom HDX Systems System Commands listen Registers the RS-232 session to listen for incoming video calls, phone calls, or system sleep or awake state and, consequently, to give notification when the registered state occurs. Syntax listen <video|phone|sleep>...

  • Page 354: Localdatetime

    Integrator’s Reference Manual for Polycom HDX Systems System Commands localdatetime Sets or gets whether to display the local date and time on the Home screen. Syntax localdatetime <get|yes|no> Parameter Description Returns the current setting. Displays the local date and time on the Home screen.

  • Page 355: Loginwindowduration

    Integrator’s Reference Manual for Polycom HDX Systems System Commands loginwindowduration Sets or gets the duration of time within which failed logins can lead to account lockout. Syntax loginwindowduration <get|set> Parameter Description Returns the current setting. Sets the time window within which failed logins can lead to account lockout.

  • Page 356: Marqueedisplaytext

    Integrator’s Reference Manual for Polycom HDX Systems System Commands marqueedisplaytext Sets or gets the text to display in the dialing entry field on the Place a Call screen. Syntax marqueedisplaytext get marqueedisplaytext set “text” Parameter Description Returns the current marquee display text.

  • Page 357: Maxgabinternationalcallspeed

    Integrator’s Reference Manual for Polycom HDX Systems System Commands maxgabinternationalcallspeed Sets or gets the maximum speed for international ISDN calls made from the global directory. This command is only applicable if you have an ISDN network interface connected to your system.

  • Page 358: Maxgabinternetcallspeed

    Integrator’s Reference Manual for Polycom HDX Systems System Commands maxgabinternetcallspeed Sets or gets the maximum speed for Internet (IP/H.323) calls made from the global directory. Syntax maxgabinternetcallspeed get maxgabinternetcallspeed set “valid speed” Parameter Description Returns the current valid speed. Sets the maximum speed for Internet calls when followed by a valid speed value.

  • Page 359: Maxgabisdncallspeed

    Integrator’s Reference Manual for Polycom HDX Systems System Commands maxgabisdncallspeed Sets or gets the maximum speed for ISDN (H.320) calls made from the global directory. This command is only applicable if you have an ISDN network interface connected to your system.

  • Page 360: Maxtimeincall

    Integrator’s Reference Manual for Polycom HDX Systems System Commands maxtimeincall Sets or gets the maximum number of minutes allowed for call length. Syntax maxtimeincall get maxtimeincall set [{0..2880}] Parameter Description Returns the current setting. Sets the maximum time for calls when followed by a parameter from {0..2880}.

  • Page 361: Mcupassword

    Integrator’s Reference Manual for Polycom HDX Systems System Commands mcupassword Enters and sends the MCU password to the MCU. Syntax mcupassword [“password”] Parameter Description password Specifies the password to send to the MCU. Polycom, Inc.

  • Page 362: Meetingpassword

    Integrator’s Reference Manual for Polycom HDX Systems System Commands meetingpassword Sets the meeting password. Syntax meetingpassword set [“password”] Parameter Description Sets the meeting password if followed by the password parameter. To erase the current setting, omit the password parameter. “password”...

  • Page 363: Monitor1 (Deprecated)

    Integrator’s Reference Manual for Polycom HDX Systems System Commands monitor1 (deprecated) Sets or gets the aspect ratio for Monitor 1. With the implementation of the configdisplay command on page 185, this command has been deprecated. Syntax monitor1 <get|4:3|16:9|vga> Parameter Description Returns the current setting.

  • Page 364: Monitor1Screensaveroutput

    Integrator’s Reference Manual for Polycom HDX Systems System Commands monitor1screensaveroutput Sets or gets whether to send either black video or "No Signal" to Monitor 1 when the screen saver activates. Syntax monitor1screensaveroutput <get|black|no_signal> Parameter Description Returns the current setting. black Sends black video to Monitor 1 when the system goes to sleep and the screen saver activates.

  • Page 365: Monitor2 (Deprecated)

    Integrator’s Reference Manual for Polycom HDX Systems System Commands monitor2 (deprecated) Sets or gets the aspect ratio for Monitor 2. With the implementation of the configdisplay command on page 185, this command has been deprecated. Syntax monitor2 off monitor2 <get|4:3|16:9>...

  • Page 366: Monitor2Screensaveroutput

    Integrator’s Reference Manual for Polycom HDX Systems System Commands monitor2screensaveroutput Sets or gets whether to send either black video or "No Signal" to Monitor 2 when the screen saver activates. Syntax monitor2screensaveroutput <get|black|no_signal> Parameter Description black Sends black video to Monitor 2 when the system goes to sleep and the screen saver activates.

  • Page 367: Mpautoanswer

    Integrator’s Reference Manual for Polycom HDX Systems System Commands mpautoanswer Sets or gets the Auto Answer Multipoint Video mode, which determines how the system will handle an incoming call in a multipoint video conference. Syntax mpautoanswer <get|yes|no|donotdisturb> Parameter Description Returns the current setting.

  • Page 368: Mpmode

    Integrator’s Reference Manual for Polycom HDX Systems System Commands mpmode Sets or gets the multipoint conference viewing 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.

  • Page 369: Mtumode

    Integrator’s Reference Manual for Polycom HDX Systems System Commands mtumode Sets or gets the MTU mode. The mtumode and mtusize commands allow you to change the Maximum Transmission Unit (MTU) size, to adjust for the best interoperability with the host network. Set mtumode to specify, then use mtusize to specify a value.

  • Page 370: Mtusize

    Integrator’s Reference Manual for Polycom HDX Systems System Commands mtusize Sets or gets the MTU size. The mtumode and mtusize commands allow you to change the Maximum Transmission Unit (MTU) size, to adjust for the best interoperability with the host network. Set mtumode to specify, then use mtusize to specify a value.

  • Page 371: Mute

    Integrator’s Reference Manual for Polycom HDX Systems System Commands mute Sets or gets the near or far site mute settings. Syntax mute <register|unregister> mute near <get|on|off|toggle> mute far get Parameter Description register Registers to receive notification when the mute mode changes.

  • Page 372: Muteautoanswer

    Integrator’s Reference Manual for Polycom HDX Systems System Commands muteautoanswer Sets or gets the Mute Auto Answer Calls mode. When this setting is selected, the microphone is muted to prevent the far site from hearing the near site when the system answers automatically.

  • Page 373: Natconfig

    Integrator’s Reference Manual for Polycom HDX Systems System Commands natconfig Sets or gets the NAT configuration. Syntax natconfig <get|auto|manual|off> Parameter Description Returns the current setting. auto Specifies that the system is behind a NAT; specifies that the system will automatically discover the public (WAN) address.

  • Page 374: Nath323Compatible

    Integrator’s Reference Manual for Polycom HDX Systems System Commands nath323compatible Sets or gets the NAT is H.323 Compatible setting. Syntax nath323compatible <get|yes|no> Parameter Description Returns the current setting. Specifies that NAT is capable of translating H.323 traffic. Specifies that NAT is not capable of translating H.323 traffic.

  • Page 375: Nearloop

    Integrator’s Reference Manual for Polycom HDX Systems System Commands nearloop Activates or deactivates the Near End Loop test. Syntax nearloop <on|off> Parameter Description Activates the Near End Loop, a complete internal test of the system. Deactivates the Near End Loop.

  • Page 376: Netstats

    Integrator’s Reference Manual for Polycom HDX Systems System Commands netstats Returns network statistics for each call. Syntax netstats [{0..n}] Parameter Description {0..n} Call in a multipoint call, where n is the maximum number of calls supported by the system. 0 is the first site connected.

  • Page 377: Nonotify

    Integrator’s Reference Manual for Polycom HDX Systems System Commands nonotify Unregisters the API client to receive status notifications. Syntax nonotify <callstatus|captions|linestatus|mutestatus|screenchanges> nonotify <sysstatus|sysalerts|vidsourcechanges> Parameter Description calendarmeetings Stops the system from receiving meeting reminders. callstatus Stops the system from receiving changes in call status, such as a connection or disconnection.

  • Page 378: Notify

    Integrator’s Reference Manual for Polycom HDX Systems System Commands notify Lists the notification types that are currently being received, or registers to receive status notifications. Syntax notify notify <callstatus|captions|linestatus|mutestatus|screenchanges> notify <sysstatus|sysalerts|vidsourcechanges> notify calendarmeetings Parameter Description notify Lists the notification types that are currently being received, in the following format: registered for <num>...
  • Page 379 Integrator’s Reference Manual for Polycom HDX Systems System Commands Parameter Description sysstatus Registers the system to receive system status notifications, in the following format: notification:sysstatus:<sys parameter name>:<value1>[:<value2>...] sysalerts Registers the system to receive system alerts, in the following format: notification:sysalert:<alert name>:<value1>[:<value2>...]...
  • Page 380 Integrator’s Reference Manual for Polycom HDX Systems System Commands ● notification: calendarmeetings: AAAaAEFsZXguTWFjRG9uYWxkQHBvbHljb20uY29tAVEACIjMne2/ndgARgAAAADr9GlhsSjWE ZBcAAKzMphJBwA4wicbtr3UEZArAKAk09LtAAACZpKWAADe7hJleQIOS7j2mzRJxkLKAAADI/ G8AAAQ:Product Planning:10 Comments The notify callstatus command registers the current API session for call status notifications. The API client receives call status notifications as a call progresses.

  • Page 381: Ntpmode

    Integrator’s Reference Manual for Polycom HDX Systems System Commands ntpmode Sets or gets the mode of the system’s Network Time Protocol (NTP) server. NTP server time is used to ensure synchronized time data in the local Call Detail Report. Syntax ntpmode <get|auto|off|manual>...

  • Page 382: Ntpsecondaryserver

    Integrator’s Reference Manual for Polycom HDX Systems System Commands ntpsecondaryserver Sets or gets a secondary Network Time Protocol (NTP) server using the IP address or DNS name of the server. Syntax ntpsecondaryserver get ntpsecondaryserver set ["xxx.xxx.xxx.xxx"|"server name"] Parameter Description Gets the IP address of the secondary NTP server.

  • Page 383: Ntpserver

    Integrator’s Reference Manual for Polycom HDX Systems System Commands ntpserver Sets or gets an Network Time Protocol (NTP) server, using the IP address or the DNS name of the server. Syntax ntpserver get ntpserver set [“xxx.xxx.xxx.xxx”|“server name”] Parameter Description Gets the IP address of the NTP server.

  • Page 384: Numberofmonitors (Deprecated)

    Integrator’s Reference Manual for Polycom HDX Systems System Commands numberofmonitors (deprecated) Returns the number of display monitors configured. With the implementation of the configdisplay command on page 185, this command has been deprecated. Syntax numberofmonitors get Feedback Examples ● numberofmonitors get...

  • Page 385: Numdigitsdid

    Integrator’s Reference Manual for Polycom HDX Systems System Commands numdigitsdid Sets or gets the number of digits in the DID Gateway number (E.164 dialing). Syntax numdigitsdid <get|{0..24}> Parameter Description Returns the current setting. {0..24} Specifies the number of digits in DID numbers.

  • Page 386: Numdigitsext

    Integrator’s Reference Manual for Polycom HDX Systems System Commands numdigitsext Sets or gets the number of digits in the Number+Extension Gateway number (E.164 dialing). Syntax numdigitsext <get|{0..24}> Parameter Description Returns the current setting. {0..24} The number of digits in the gateway number if...

  • Page 387: Ocsdirectory

    Systems for more information. Each Polycom HDX system supports a single global directory server at any given time. Therefore, enabling the Microsoft Office Communications Server 2007 automatically disables any other enabled global directory server, such as the Polycom GDS or LDAP directory server.
  • Page 388 Integrator’s Reference Manual for Polycom HDX Systems System Commands ● If the Polycom GDS directory server and another directory server (not the Microsoft Office Communications Server 2007 directory server) are defined on the system, the Polycom GDS directory server becomes the default directory server after upgrading the system software.

  • Page 389: Oobcomplete

    Completes the setup wizard and restarts the Polycom HDX system. Syntax oobcomplete Feedback Examples oobcomplete returns oobcomplete Comments The oobcomplete command is processed only when the Polycom HDXsystem is in setup wizard mode. To execute oobcomplete successfully, the Polycom HDX system name must be configured. Polycom, Inc.

  • Page 390: Ocsdirectory

    Refer to the Administrator’s Guide for Polycom HDX Systems for more information. Each Polycom HDX system supports a single global directory server at any given time. Therefore, enabling the Microsoft Office Communications Server 2007 automatically disables any other enabled global directory server, such as the Polycom GDS or LDAP directory server.

  • Page 391: Pause

    Integrator’s Reference Manual for Polycom HDX Systems System Commands pause Pauses the command interpreter before executing the next command. Pauses are useful when commands are retrieved from a script file. Syntax pause {0..65535} Parameter Description {0..65535} Number of seconds to pause.

  • Page 392: Peoplevideoadjustment

    Integrator’s Reference Manual for Polycom HDX Systems System Commands peoplevideoadjustment Sets or gets the people video adjustment setting. Syntax peoplevideoadjustment <get|normal|stretch|zoom> Parameter Description Returns the current setting. normal Preserves the aspect ratio of the source video. The image is scaled (if necessary) to the largest supported resolution that fits on the display without cropping.

  • Page 393: Phone

    Integrator’s Reference Manual for Polycom HDX Systems System Commands phone Flashes the analog phone line. Syntax phone <clear|flash> Parameter Description clear Clears phone number from the text box. flash Sends flash hook to a POTS connection. See Also Use the...

  • Page 394: Pip

    Integrator’s Reference Manual for Polycom HDX Systems System Commands Sets or gets the on-screen PIP mode. The PIP feature allows the near site to adjust near-camera views while in a video conference. Syntax pip <get|on|off|camera|swap|register|unregister|location> pip location <get|0|1|2|3> Parameter Description Returns the current setting.
  • Page 395 Integrator’s Reference Manual for Polycom HDX Systems System Commands ● pip register returns pip registered Polycom, Inc.

  • Page 396: Popupinfo

    Integrator’s Reference Manual for Polycom HDX Systems System Commands popupinfo Registers or unregisters the session to receive popup text and button choices text. Syntax popupinfo <get|register|unregister> Parameter Description register Registers to receive popup information. unregister Unregisters to receive popup information.

  • Page 397: Preset

    Integrator’s Reference Manual for Polycom HDX Systems System Commands preset Sets the presets or goes (moves) to the presets for the near or far camera source. Also registers or unregisters the API session to give notification when the user sets or goes to presets.

  • Page 398: Pricallbycall

    Integrator’s Reference Manual for Polycom HDX Systems System Commands pricallbycall Sets or gets the PRI call-by-call value. This command is only applicable if you have a PRI network interface connected to your system. Syntax pricallbycall get pricallbycall set {0..31} Parameter Description Returns the current setting.

  • Page 399: Prichannel

    Integrator’s Reference Manual for Polycom HDX Systems System Commands prichannel Sets or gets the PRI channels that will be active for the PRI line. This command is only applicable if you have a PRI network interface connected to your system.
  • Page 400 Integrator’s Reference Manual for Polycom HDX Systems System Commands equipment attached to the system. For example, an incoming call arrives on channel 23, then 22, 21, and so on. Dedicated full PRI T1 or E1 Line. All channels should be active for a full T1 or E1 line dedicated to your system.

  • Page 401: Pricsu

    Integrator’s Reference Manual for Polycom HDX Systems System Commands pricsu Sets or gets the PRI CSU mode for a T1 interface. Syntax pricsu <get|internal|external> Parameter Description Returns the current setting. internal Sets the internal CSU mode. This is the default.

  • Page 402: Pridialchannels

    Integrator’s Reference Manual for Polycom HDX Systems System Commands pridialchannels Sets or gets the number of PRI channels to dial in parallel. This command is only applicable if you have a PRI network interface connected to your system. Syntax pridialchannels get pridialchannels set {1..n}...

  • Page 403: Priintlprefix

    Integrator’s Reference Manual for Polycom HDX Systems System Commands priintlprefix Sets or gets the PRI international dialing prefix. Syntax priintlprefix get priintlprefix set ["prefix"] Parameter Description Returns the current setting. Sets the PRI international dialing prefix when followed by the parameter “prefix”. To erase the current setting, omit the parameter.

  • Page 404: Prilinebuildout

    Integrator’s Reference Manual for Polycom HDX Systems System Commands prilinebuildout Sets or gets the PRI line buildout for a T1 interface. Syntax prilinebuildout get prilinebuildout set <0|-7.5|-15|-22.5> prilinebuildout set <0-133|134-266|267-399|400-533|534-665> Parameter Description Returns the current setting. Sets the PRI line buildout. It requires an output “attenuation in dB”...

  • Page 405: Prilinesignal

    Integrator’s Reference Manual for Polycom HDX Systems System Commands prilinesignal Sets or gets the PRI line signal. Syntax prilinesignal get prilinesignal set <esf/b8zs|crc4/hdb3|hdb3> Parameter Description Returns the current PRI line signal setting. Sets the PRI line signal. It requires one of the following...

  • Page 406: Prinumberingplan

    Integrator’s Reference Manual for Polycom HDX Systems System Commands prinumberingplan Sets or gets the PRI numbering plan. This command is only applicable if you have a PRI network interface connected to your system. Syntax prinumberingplan <get|isdn|unknown> Parameter Description Returns the current setting.

  • Page 407: Prioutsideline

    Integrator’s Reference Manual for Polycom HDX Systems System Commands prioutsideline Sets or gets the PRI number that is dialed for outside line access. Syntax prioutsideline get prioutsideline set ["outside_line"] Parameter Description Returns the current setting. Sets the outside-line-access PRI number when followed by the parameter “outside_line”.

  • Page 408: Priswitch

    Integrator’s Reference Manual for Polycom HDX Systems System Commands priswitch Sets or gets the PRI switch. Syntax priswitch get priswitch set <att5ess|att4ess|norteldms|ni2> priswitch set <net5/ctr4|nttins-1500|ts-038> Parameter Description Returns the current switch protocol. Sets the PRI switch. One of the switch protocol parameters is required.

  • Page 409: Reboot

    Integrator’s Reference Manual for Polycom HDX Systems System Commands reboot Restarts the system. Syntax reboot [y|now|n] Parameter Description restarts the system without prompting you. restarts the system without prompting you. Does not restart the system. Feedback Examples ● reboot y does not prompt the user to confirm and restarts the system with no other feedback returned ●...

  • Page 410: Recentcalls

    ● If the call is placed from the Place a Call screen, and the number is in the Polycom HDX system directory, the display name of the directory entry is returned. If the number is not in the Polycom HDX system directory, the IP number is returned as the display name.

  • Page 411: Registerall (Deprecated)

    Integrator’s Reference Manual for Polycom HDX Systems System Commands registerall (deprecated) Alias for the all register command. Syntax registerall Feedback Examples registerall returns callstate registered camera registered chaircontrol registered linestate registered mute registered pip registered popup registered popupinfo registered preset registered...

  • Page 412: Registerthissystem

    Integrator’s Reference Manual for Polycom HDX Systems System Commands registerthissystem Sets or gets the system’s IP address to be registered and displayed in the global directory when the system is powered on. Syntax registerthissystem <get|yes|no> Parameter Description Returns the current setting.

  • Page 413: Remotecontrol

    Integrator’s Reference Manual for Polycom HDX Systems System Commands remotecontrol Set or gets the setting for intercepting signals from the system remote control. Syntax remotecontrol disable <get|all|none> remotecontrol disable “valid button” [“valid button”...] remotecontrol dontintercept <all|none> remotecontrol dontintercept “valid button” [“valid button”...] remotecontrol enable <all|none>...

  • Page 414: Remotemonenable

    Integrator’s Reference Manual for Polycom HDX Systems System Commands remotemonenable Gets the state of remote room and call monitoring. Syntax remotemonenable <get> Feedback Examples ● remotemonenable get returns remotemonenable on ● remotemonenable get returns remotemonenable off Polycom, Inc.

  • Page 415: Requireacctnumtodial

    Integrator’s Reference Manual for Polycom HDX Systems System Commands requireacctnumtodial 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.

  • Page 416: Resetsystem

    Resets all configuration settings to default values. deletelocaldirectory Deletes all local directory entries from the address book. deletecdr Deletes the CDR file from the /opt/polycom/cdr directory after copying the contents of the file to the trace log. deletelogs Deletes the system logs.
  • Page 417 Integrator’s Reference Manual for Polycom HDX Systems System Commands resetsystem deletesystemsettings deletelocaldirectory deletecdr deletelogs deletecertificates Deletes system settings, local directory, cdr, logs and certiricates, dat file, logos, and option keys. Comments Specifying all of the resetsystem parameters except keepoptsandlogos in a single command performs a complete erasure of the system’s flash memory, returning the system to its original, pre-configured state.

  • Page 418: Roomphonenumber

    Integrator’s Reference Manual for Polycom HDX Systems System Commands roomphonenumber Sets or gets the number of the phone that is located in the same room as the system. Syntax roomphonenumber get roomphonenumber set [“number”] Parameter Description Returns the current setting.

  • Page 419: Rs232 Baud, Rs232Port1 Baud

    Integrator’s Reference Manual for Polycom HDX Systems System Commands rs232 baud, rs232port1 baud The rs232 baud command sets or gets the baud rate for the first RS-232 port. For systems with two serial ports, use rs232port1 baud to set the rate for the second serial port.

  • Page 420: Rs232 Mode, Rs232Port1 Mode

    Sets the RS-232 port to Interactive Touch Board mode. board smartboard Sets the RS-232 port to Interactive Touch Board mode (to control a Polycom SMART board device). polycom_annotation Sets the RS-232 port to Polycom Annotation mode. cps|pointmaker Reserved for future applications. Feedback Examples ● rs232 mode control returns rs232 mode control ●...

  • Page 421: Rs366Dialing

    Integrator’s Reference Manual for Polycom HDX Systems System Commands rs366dialing Sets or gets RS-366 dialing. This command is only applicable if you have a V.35 network interface connected to your system. Syntax rs366dialing <get|on|off> Parameter Description Returns the current setting.
  • Page 422 Integrator’s Reference Manual for Polycom HDX Systems System Commands Sets or gets the RT serial interface control signal (receive timing: clock). This command is only applicable if you have a V.35 network interface connected to your system. Syntax rt <get|normal|inverted>...

  • Page 423: Rts

    Integrator’s Reference Manual for Polycom HDX Systems System Commands Sets or gets the RTS serial interface control signal (request to send). This command is only applicable if you have a V.35 network interface connected to your system. Syntax rts <get|normal|inverted>...

  • Page 424: Screen

    Integrator’s Reference Manual for Polycom HDX Systems System Commands screen Returns the name of the current user interface screen on the system, registers or unregisters for screen changes, or goes to a specific user interface screen. Syntax screen screen register get screen [register|unregister] screen “screen_name”...

  • Page 425: Screencontrol

    Integrator’s Reference Manual for Polycom HDX Systems System Commands screencontrol Disables or enables navigation to specified user interface screens of the system. Syntax screencontrol enable <all|none|“screen_name”> screencontrol disable <all|none|“screen_name”> Parameter Description enable Enables navigation to the specified user interface screen(s).

  • Page 426: Serialnum

    Integrator’s Reference Manual for Polycom HDX Systems System Commands serialnum Returns the serial number of the system. Syntax serialnum Feedback Examples ● serialnum returns serialnum 82065205E72EC1 Polycom, Inc.

  • Page 427: Servervalidatepeercert

    Integrator’s Reference Manual for Polycom HDX Systems System Commands servervalidatepeercert Enables certificate validation by specifying whether the HDX system requires a browser to present a valid certificate when it tries to connect to the HDX web interface. Syntax servervalidatepeercert get servervalidatepeercert <yes|no>...

  • Page 428: Session

    Integrator’s Reference Manual for Polycom HDX Systems System Commands session Names or finds an active API session. Syntax session name “session-name” session find “session-name” Parameter Description name Names the current API session. find Finds an active API session for this system.

  • Page 429: Sessionsenabled

    Integrator’s Reference Manual for Polycom HDX Systems System Commands sessionsenabled Sets or gets the ability to monitor for and terminate inactive Polycom HDX web sessions. Syntax sessionsenabled get sessionsenabled <yes|no> Parameter Description Returns the current setting for web sessions monitoring.

  • Page 430: Setaccountnumber

    Integrator’s Reference Manual for Polycom HDX Systems System Commands setaccountnumber Sets the account number when it is required for dialing out. Syntax setaccountnumber “account number” Parameter Description “account number” Number that is needed to validate the account before dialing out. To erase the current setting, omit this parameter.

  • Page 431: Setpassword

    Integrator’s Reference Manual for Polycom HDX Systems System Commands setpassword Sets the admin password for the Polycom HDX system local admin account. Syntax setpassword admin room "currentacctpasswd" "newacctpasswd" Parameter Description admin Specifies the Polycom HDX system local admin account. room Changes the room password.

  • Page 432: Showpopup

    Integrator’s Reference Manual for Polycom HDX Systems System Commands showpopup Displays a message box in the user interface. Syntax showpopup “text to display” Parameter Description “text to display” Message to display to users. Enclose the text in quotation marks if it contains a space.

  • Page 433: Sleep

    Integrator’s Reference Manual for Polycom HDX Systems System Commands sleep Puts the system in sleep mode within 15 seconds and returns sleep. Syntax sleep sleep <register|unregister> Parameter Description sleep Puts the system in sleep mode if not followed by other...

  • Page 434: Sleeptext

    Integrator’s Reference Manual for Polycom HDX Systems System Commands sleeptext Sets or gets the text to be displayed with the logo for 15 seconds as the system goes into sleep mode. Syntax sleeptext get sleeptext set [“text”] Parameter Description Returns the current text.

  • Page 435: Sleeptime

    Integrator’s Reference Manual for Polycom HDX Systems System Commands sleeptime Sets or gets the wait time value before the system goes to sleep and displays the screen saver. Syntax sleeptime <get|0|1|3|15|30|60|120|240|480> Parameter Description Returns the current setting. 0|1|3|15|30|60|120| Sets the number of minutes from last user interaction to 240|480 entering sleep mode.

  • Page 436: Snmpadmin

    Integrator’s Reference Manual for Polycom HDX Systems System Commands snmpadmin Sets or gets the SNMP administrator name. Syntax snmpadmin get snmpadmin set ["admin name"] Parameter Description Returns the current setting. Sets the administrator name when followed by the “admin name” parameter. To erase the current setting, omit “admin name”.

  • Page 437: Snmpcommunity

    Integrator’s Reference Manual for Polycom HDX Systems System Commands snmpcommunity Sets or gets the SNMP community name. Syntax snmpcommunity get snmpcommunity set ["community name"] Parameter Description Returns the current setting. Sets the SNMP community name when followed by the “community name” parameter. To erase the current setting, omit the parameter.

  • Page 438: Snmpconsoleip

    Integrator’s Reference Manual for Polycom HDX Systems System Commands snmpconsoleip Sets or gets the SNMP console IP address. Syntax snmpconsoleip get snmpconsoleip set ["xxx.xxx.xxx.xxx"] Parameter Description Returns the current setting. Sets the SNMP console IP address when followed by the “xxx.xxx.xxx.xxx” parameter. To erase the current setting, omit the parameter.

  • Page 439: Snmplocation

    Integrator’s Reference Manual for Polycom HDX Systems System Commands snmplocation Sets or gets the SNMP location name. Syntax snmplocation get snmplocation ["location name"] Parameter Description Returns the current setting. “location name” SNMP location name. Enclose the location name in quotation marks if it includes spaces. To erase the current setting, omit the parameter.

  • Page 440: Snmpsystemdescription

    Integrator’s Reference Manual for Polycom HDX Systems System Commands snmpsystemdescription Sets or gets the SNMP system description. Syntax snmpsystemdescription get snmpsystemdescription set ["system description"] Parameter Description Returns the current setting. Sets the SNMP system description when followed by the “system description” parameter. To erase the current setting, omit the parameter.

  • Page 441: Snmptrapversion

    Integrator’s Reference Manual for Polycom HDX Systems System Commands snmptrapversion Sets or gets the SNMP trap version. Syntax snmptrapversion get snmptrapversion set <v1|v2c> Parameter Description Returns the current setting. Sets the SNMP trap protocol that the system uses. v1|v2c SNMP trap version 1 or version 2c.

  • Page 442: Soundeffectsvolume

    Integrator’s Reference Manual for Polycom HDX Systems System Commands soundeffectsvolume Sets, gets, or tests the volume level of the ring tone and user alert tone on the system. Syntax soundeffectsvolume get soundeffectsvolume set {0..10} soundeffectsvolume test Parameter Description Returns the current setting along with a test tone from the system at that volume level.

  • Page 443: Speeddial

    Integrator’s Reference Manual for Polycom HDX Systems System Commands speeddial Returns speed dial (Sites) entries. Note that the speed dial commands and responses are nearly identical to the corresponding local address book commands. Syntax speeddial names <all|video|phone> [<range_start>] [<range_end>] speeddial names <all|video|phone> size speeddial group "group_name"...
  • Page 444 Integrator’s Reference Manual for Polycom HDX Systems System Commands Parameter Description group Returns a list of the names of all the sites included in a local directory group in this format: speeddial group {0..n}. name:"site_sys_name" sys_label:"site_sys_label" speeddial group "group_name" [range] done speeddial group size <num_entries>...
  • Page 445 Integrator’s Reference Manual for Polycom HDX Systems System Commands Parameter Description address Obtains the address information for a specified entry. If the entry is an ITP system, the results include the addresses for all codecs. If the codecs support multiple protocols, the different addresses are returned on separate lines.
  • Page 446 Integrator’s Reference Manual for Polycom HDX Systems System Commands Parameter Description sys_name The friendly name for a speed dial entry. It is the name of the person or the room. It is surrounded by quotes if it contains spaces. sys_label If a person/room has more than one system, the result set includes a row for each system.
  • Page 447 If the entry is an ITP system, the results include address information for each codec. If the entry has multiple endpoints of different types, the addresses for each endpoint are returned including a sys_label attribute to distinguish the endpoints. For Polycom RealPresence Resource Manager, sys_label is the type of endpoint, such as HDX or CMA Desktop.
  • Page 448 Integrator’s Reference Manual for Polycom HDX Systems System Commands Sets or gets the st serial interface control signal (send timing: clock) setting. This command is only applicable if you have a V.35 network interface connected to your system. Syntax st <get|normal|inverted>...

  • Page 449: Sslverificationdepth

    Integrator’s Reference Manual for Polycom HDX Systems System Commands sslverificationdepth Specifies how many links a certificate chain can have. Syntax sslverificationdepth get sslverificationdepth set {0..12} Parameter Description Returns the current setting. set {0..12} Sets the number of links a certificate chain can have.

  • Page 450: Subnetmask

    Integrator’s Reference Manual for Polycom HDX Systems System Commands subnetmask Sets or gets the subnet mask of the system. Syntax subnetmask get subnetmask set [“xxx.xxx.xxx.xxx”] Parameter Description Returns the current subnet mask. Sets the subnet mask of the system when followed by the ”xxx.xxx.xxx.xxx”...

  • Page 451: Sysinfo

    Integrator’s Reference Manual for Polycom HDX Systems System Commands sysinfo Sets or gets registration for ISDN, IP, and gatekeeper status notifications. Syntax sysinfo <get|register|unregister> Parameter Description Returns registration status. register Registers the shell session to receive ISDN, IP, and gatekeeper status notifications.

  • Page 452: Systemname

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemname Sets or gets the name of the system. Syntax systemname get systemname set “system name” Parameter Description Returns the current setting. Sets the system name to “system name”. “system name”...

  • Page 453: Systemsetting 320Gatewayenable

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting 320gatewayenable Enables IP-to-ISDN calling through a gateway. Syntax systemsetting 320gatewayenable <true|false> systemsetting get 320gatewayenable Parameter Description true Enables ISDN gateway calls. false Disables ISDN gateway calls. Returns the current setting.

  • Page 454: Systemsetting 323Gatewayenable

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting 323gatewayenable Enables IP-to-IP calling through a gateway. Syntax systemsetting 323gatewayenable <True|False> systemsetting get 323gatewayenable Parameter Description True Enables IP gateway calls. False Disables IP gateway calls. Returns the current setting.

  • Page 455: Systemsetting Bass

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting bass Sets or retrieves the volume level for the low frequencies without changing the master audio volume. Syntax systemsetting bass <-6|-4|-2|0|+2|+4|+6> systemsetting get bass Parameter Description <-6|-4|-2|0|+2|+4|+ Sets the level for the low frequencies.

  • Page 456: Systemsetting Cameraaspectratio

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting cameraaspectratio Specifies the aspect ratio for Camera 1. Syntax systemsetting cameraaspectratio <4:3|16:9> systemsetting get cameraaspectratio Parameter Description Specifies standard screen mode for camera aspect ratio. 16:9 Specifies wide-screen mode for camera aspect ratio.

  • Page 457: Systemsetting Cameraaspectratio1

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting cameraaspectratio1 Specifies the aspect ratio for a camera. The camera affected depends on the Polycom HDX system ● HDX 8000 and HDX 9000 Series: Camera 2 ● HDX 6000 and HDX 7000 Series: Not supported Syntax systemsetting cameraaspectratio1 <4:3|16:9>...

  • Page 458: Systemsetting Cameraaspectratio2

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting cameraaspectratio2 Specifies the aspect ratio for a camera. The camera affected depends on the HDX model: ● HDX 8000 and HDX9000 Series: Camera 3 ● HDX 7000 Series: Camera 2 ●...

  • Page 459: Systemsetting Cameraaspectratio3

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting cameraaspectratio3 Specifies the aspect ratio for a camera. The camera affected depends on the HDX model: ● HDX 8000 and HDX 9000 Series: Camera 4 ● HDX 7000 Series: Camera 3 ●...

  • Page 460: Systemsetting Cameraaspectratio4

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting cameraaspectratio4 Specifies the aspect ratio for Camera 5 on Polycom HDX 9004 systems. Syntax systemsetting cameraaspectratio4 <4:3|16:9> systemsetting get cameraaspectratio4 Parameter Description Specifies standard screen mode for camera aspect ratio.

  • Page 461: Systemsetting Cameracontent

    ● systemsetting cameracontent People returns systemsetting cameracontent People ● systemsetting cameracontent Content returns systemsetting cameracontent Content ● systemsetting get cameracontent returns systemsetting cameracontent Content Comments This command is valid on Polycom HDX 8000 and HDX 9000 systems only. Polycom, Inc.

  • Page 462: Systemsetting Cameracontent1

    ● systemsetting cameracontent1 People returns systemsetting cameracontent1 People ● systemsetting cameracontent1 Content returns systemsetting cameracontent1 Content ● systemsetting get cameracontent1 returns systemsetting cameracontent1 Content Comments This command is valid on Polycom HDX 8000 and HDX 9000 systems only. Polycom, Inc.

  • Page 463: Systemsetting Cameracontent2

    ● systemsetting cameracontent2 People returns systemsetting cameracontent2 People ● systemsetting cameracontent2 Content returns systemsetting cameracontent2 Content ● systemsetting get cameracontent2 returns systemsetting cameracontent2 Content Comments This command is valid on Polycom HDX 8000 and HDX 9000 systems only. Polycom, Inc.

  • Page 464: Systemsetting Cameracontent3

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting cameracontent3 Specifies Camera 4 as a people or content source. Syntax systemsetting cameracontent3 <People|Content> systemsetting get cameracontent3 Parameter Description People Specifies camera as a people source. Content Specifies camera as a content source.

  • Page 465: Systemsetting Cameracontent4

    ● systemsetting cameracontent4 People returns systemsetting cameracontent4 People ● systemsetting cameracontent4 Content returns systemsetting cameracontent4 Content ● systemsetting get cameracontent4 returns systemsetting cameracontent4 Content Comments This command is valid on Polycom HDX 8000 and HDX 9000 systems only. Polycom, Inc.

  • Page 466: Systemsetting Cameraname

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting cameraname Specifies a name for Camera 1. Syntax systemsetting cameraname ["name"] systemsetting get cameraname Parameter Description "name" Specifies name for the camera. Returns the current setting. Feedback Examples ● systemsetting cameraname Instructor...

  • Page 467: Systemsetting Cameraname1

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting cameraname1 Specifies a name for a camera. The camera affected depends on the Polycom HDX system: ● HDX 8000 and HDX 9000 series: Camera 2 ● HDX 6000, and HDX 7000 series: Not supported Syntax systemsetting cameraname1 ["name"]...

  • Page 468: Systemsetting Cameraname2

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting cameraname2 Specifies a name for a camera. The camera affected depends on the Polycom HDX system. ● HDX 8000, HDX 9000 series: Camera 3 ● HDX 7000 Series: Camera 2 ●...

  • Page 469: Systemsetting Cameraname3

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting cameraname3 Specifies a name for a Camera 4. Syntax systemsetting cameraname3 ["name"] systemsetting get cameraname3 Parameter Description "name" Specifies name for the camera. Returns the current setting. Feedback Examples ● systemsetting cameraname3 PC...

  • Page 470: Systemsetting Cameraname4

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting cameraname4 Specifies a name for a Camera 5 on Polycom HDX 9004 systems. Syntax systemsetting cameraname4 ["name"] systemsetting get cameraname4 Parameter Description "name" Specifies name for the camera. Returns the current setting.

  • Page 471: Systemsetting Cameratype

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting cameratype Returns the type of camera detected by the system. Syntax systemsetting get cameratype Parameter Description Returns the current setting. Feedback Examples ● systemsetting get cameratype returns systemsetting cameratype NTSC Comments The camera type is automatically detected and cannot be changed.

  • Page 472: Systemsetting Componentresolution

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting componentresolution Specifies the component output resolution of Monitor 1. Syntax systemsetting componentresolution <720p|1080i|1080p> systemsetting get componentresolution Parameter Description <720p|1080i|1080p> Specifies the component output resolution of Monitor 1. Choices are: 720p--720P HD Video.

  • Page 473: Systemsetting Componentresolution1

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting componentresolution1 Specifies the component output resolution of Monitor 2. Syntax systemsetting componentresolution1 <720p|1080i|1080p> systemsetting get componentresolution1 Parameter Description <720p|1080i|1080p> Specifies the component output resolution of Monitor 2. Choices are: 720p--720P HD Video •...

  • Page 474: Systemsetting Connectionpreference

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting connectionpreference Specifies whether the system uses the Video Dialing Order or the Audio Dialing Order first when placing calls. Syntax systemsetting connectionpreference <VIDEO_THEN_AUDIO|AUDIO_THEN_VIDEO> systemsetting get connectionpreference Parameter Description VIDEO_THEN_AUDIO Sets Video as the preferred call choice before Audio calls.

  • Page 475: Systemsetting Country

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting country Specifies the country in which the Polycom HDX system is located. Syntax systemsetting country <country> systemsetting get country Parameter Description country Specifies the country that the system is located in. Fiji Islands Returns the current setting.
  • Page 476 Integrator’s Reference Manual for Polycom HDX Systems System Commands ● Australia ● Australian Ext. Territories ● Austria ● Azerbaijan ● Bahamas ● Bahrain ● Bangladesh ● Barbados ● Barbuda ● Belarus ● Belgium ● Belize ● Benin Republic ● Bermuda ●...
  • Page 477 Integrator’s Reference Manual for Polycom HDX Systems System Commands ● Congo ● Congo Democratic Republic ● Cook Islands ● Costa Rica ● Croatia ● Cuba ● Curacao ● Cyprus ● Czech Republic ● Denmark ● Diego Garcia ● Djibouti ● Dominica ●...
  • Page 478 Integrator’s Reference Manual for Polycom HDX Systems System Commands ● Greenland ● Grenada ● Guadeloupe ● Guam ● Guantanamo Bay ● Guatemala ● Guinea ● Guinea-Bissau ● Guyana ● Haiti ● Honduras ● Hong Kong ● Hungary ● Iceland ● Inmarsat (Atlantic Ocean West) ●...
  • Page 479 Integrator’s Reference Manual for Polycom HDX Systems System Commands ● Latvia ● Lebanon ● Lesotho ● Liberia ● Libya ● Liechtenstein ● Lithuania ● Luxembourg ● Macao ● Macedonia ● Madagascar ● Malawi ● Malaysia ● Maldives ● Mali ● Malta ●...
  • Page 480 Integrator’s Reference Manual for Polycom HDX Systems System Commands ● New Caledonia ● New Zealand ● Nicaragua ● Niger ● Nigeria ● Niue ● Norfolk Island ● Norway ● Oman ● Pakistan ● Palau ● Palestine ● Panama ● Papua New Guinea ●...
  • Page 481 Integrator’s Reference Manual for Polycom HDX Systems System Commands ● Slovakia ● Slovenia ● Solomon Islands ● Somalia Republic ● South Africa ● Spain ● Sri Lanka ● Sudan ● Suriname ● Swaziland ● Sweden ● Switzerland ● Syria ● Taiwan ●...
  • Page 482 Integrator’s Reference Manual for Polycom HDX Systems System Commands ● Western Samoa ● Yemen ● Zambia ● Zanzibar ● Zimbabwe Polycom, Inc.

  • Page 483: Systemsetting Dialingmethod

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting dialingmethod Specifies the preferred method for dialing various call types. Syntax systemsetting dialingmethod <Auto|Manual> systemsetting get dialingmethod Parameter Description Auto Sets the dialing mode to Auto. Calls use the configured dialing order.

  • Page 484: Systemsetting Displayiconsincall

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting displayiconsincall Specifies whether to display icons on the info bar when the system is in a call. Syntax systemsetting displayiconsincall <True|False> systemsetting get displayiconsincall Parameter Description True Specifies to display the icons on the info bar while in a call.

  • Page 485: Systemsetting Displaylastnumberdialed

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting displaylastnumberdialed Specifies whether to display the last number dialed or clear the dialing field on the Home screen. Syntax systemsetting displaylastnumberdialed <true|false> systemsetting get displaylastnumberdialed Parameter Description true Displays the last number dialed in the dialing field on the Home screen.

  • Page 486: Systemsetting Domainname

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting domainname Sets or retrieves the DNS domain assigned to the system. Syntax systemsetting domainname <domain> systemsetting get domainname Parameter Description domain The domain string with syntax "<subdomain1>.<subdomain2>.<…>.<domaintype>" Maximum length 40 characters.

  • Page 487: Systemsetting Dviresolution

    (RPX 8006 only) 50HZ1920x1080I Sets Monitor 1 resolution to 1920 x 1080I at 50 Hertz (PAL HDX 6000, HDX 7000, HDX 8000, HDX 9006 only) 50HZ1920x1080P Sets Monitor 1 resolution to 1920 x 1080P at 50 Hertz (PAL HDX 6000, 7000, 8000, 9006 only)
  • Page 488 Integrator’s Reference Manual for Polycom HDX Systems System Commands Comments This command only sets the resolution for DVI; it does not change the signal type. Use the systemsetting monitor4screensaveroutput command on page to change the signal type. Polycom, Inc.

  • Page 489: Systemsetting Dviresolution1

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting dviresolution1 Specifies the resolution for the Monitor 2 DVI signal. Syntax systemsetting dviresolution1 <60HZ800x600|72HZ800x600|75HZ800x600|60HZ1024x768|70HZ1024x768|75HZ1024x768 |50HZ1280x720|60HZ1280x720|60HZ1400x1050\50HZ1920x1080I|50HZ1920x1080P|60HZ 1920x1080I|60HZ1920x1080P> systemsetting get dviresolution1 Parameter Description 60HZ800x600 Sets Monitor 2 resolution to 800x600 at 60 Hertz.
  • Page 490 Integrator’s Reference Manual for Polycom HDX Systems System Commands ● systemsetting get dviresolution1 returns systemsetting dviresolution1 60HZ800x600 Comments This command only sets the resolution for DVI; it does not change the signal type. Use the systemsetting monitor4screensaveroutput command on page to change the signal type.

  • Page 491: Systemsetting Dviresolution3

    60HZ800x600 Comments This command only sets the resolution for DVI; it does not change the signal type. Use the systemsetting monitor4screensaveroutput command on page to change the signal type. This command is valid on Polycom 9004 systems only. Polycom, Inc.

  • Page 492: Systemsetting Enablegdsdirectory

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting enablegdsdirectory Sets or returns the GDS Directory server configuration state. Syntax systemsetting enablegdsdirectory <true|false> systemsetting get enablegdsdirectory Parameter Description true Enables GDS directory configuration. false Disables GDS directory configuration. Returns the current setting.

  • Page 493: Systemsetting Enablepolycommics

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting enablepolycommics Specifies whether the Polycom C-Link 2 microphone arrays attached to the system are enabled. Syntax systemsetting enablepolycommics <True|False> systemsetting get enablepolycommics Parameter Description True Enables Polycom microphones. False Disables Polycom microphones.

  • Page 494: Systemsetting Farnamedisplaytime

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting farnamedisplaytime Sets or returns the time to display the far site name on the monitor. Syntax systemsetting farnamedisplaytime <off|on|15|30|60|120> systemsetting get farnamedisplaytime Parameter Description Disables the far site name from being displayed on the monitor during a call.

  • Page 495: Systemsetting Iph323Enable

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting iph323enable Allows the system to make IP calls. Syntax systemsetting iph323enable <True|False> systemsetting get iph323enable Parameter Description True Enables IP call capability. False Disables IP call capability. Returns the current setting.

  • Page 496: Systemsetting Ipmaxincoming

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting ipmaxincoming Sets or returns the bandwidth used when receiving IP calls. Syntax systemsetting ipmaxincoming [speed] systemsetting get ipmaxincoming Parameter Description speed The maximum speed allowed for incoming IP calls. Returns the current setting.

  • Page 497: Systemsetting Isdnh320Enable

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting isdnh320enable Allows the system to make ISDN calls. Syntax systemsetting isdnh320enable <true|false> systemsetting get isdnh320enable Parameter Description true Enables ISDN/H320 capability. false Disables ISDN/H320 capability. Returns the current setting. Feedback Examples ●...

  • Page 498: Systemsetting Isdnmaxincoming

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting isdnmaxincoming Allows you to restrict the bandwidth used when receiving ISDN/H.320 calls. Syntax systemsetting isdnmaxincoming [speed] systemsetting get isdnmaxincoming Parameter Description speed The maximum speed allowed for incoming ISDN/H.320 calls.

  • Page 499: Systemsetting Ldapuserid

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting ldapuserid Sets or returns the LDAP user account name. Syntax systemsetting ldapuserid <"userid"> systemsetting get ldapuserid Parameter Description “userid” Specifies the user account name. Returns the current setting. Feedback Examples ●...

  • Page 500: Systemsetting Lineinlevel

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting lineinlevel Sets or returns the volume level for audio input 1. Syntax systemsetting lineinlevel {0..10} systemsetting get lineinlevel Parameter Description 0..10 Sets the volume level for input 1. Valid range is 0 to 10.

  • Page 501: Systemsetting Lineintype

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting lineintype Sets or returns the signal level coming from the device connected to audio input 1. Syntax systemsetting lineintype <LINE_INPUT|MICROPHONE> systemsetting get lineintype Parameter Description LINE_INPUT Specifies line level for audio input 1.

  • Page 502: Systemsetting Lineoutmode

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting lineoutmode Specifies whether the volume for a device connected to the audio line out connectors is variable or fixed. Syntax systemsetting lineoutmode <fixed|variable> systemsetting get lineoutmode Parameter Description fixed Sets the volume to the audio level specified in the system interface.

  • Page 503: Systemsetting Maxrxbandwidth

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting maxrxbandwidth Specifies the maximum receive line speed between 64 kbps and 4096 kbps. Syntax systemsetting maxrxbandwidth [speed] systemsetting get maxrxbandwidth Parameter Description speed Sets the maximum speed for receiving calls.

  • Page 504: Systemsetting Maxtxbandwidth

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting maxtxbandwidth Specifies the maximum transmit line speed between 64 kbps and 4096 kbps. Syntax systemsetting maxtxbandwidth [speed] systemsetting get maxtxbandwidth Parameter Description speed Sets the maximum speed for placing calls.

  • Page 505: Systemsetting Mediainlevel

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting mediainlevel Specifies the volume level for the media audio input. Syntax systemsetting mediainlevel <auto|0..10> systemsetting get mediainlevel Parameter Description auto Allows the system software to adjust the input level. 0..10 Sets the volume level of the media input to the specified value.

  • Page 506: Systemsetting Model

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting model Returns the model of the HDX system. Syntax systemsetting get model Parameter Description Returns the current setting. Feedback Examples systemsetting get model returns systemsetting model “HDX 8000 HD” Polycom, Inc.

  • Page 507: Systemsetting Modelcameranum1

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting modelcameranum1 Returns the model of the camera attached to the Camera 1 port. Syntax systemsetting get modelcameranum1 Parameter Description Returns the current setting. Feedback Examples ● systemsetting get modelcameranum1 returns systemsetting modelcameranum1 Polycom_Eagle_Eye Polycom, Inc.

  • Page 508: Systemsetting Modelcameranum2

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting modelcameranum2 Returns the model of the camera attached to the camera port. The specific camera port referenced depends on the HDX model: ● HDX 8000 and HDX 9000 Series: Camera 2 ●...

  • Page 509: Systemsetting Modelcameranum3

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting modelcameranum3 Returns the model of the camera attached to the camera port. The specific camera port referenced depends on the HDX model: ● HDX 8000 and HDX 9000 series: Camera 3 ●...

  • Page 510: Systemsetting Modelcameranum4

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting modelcameranum4 Returns the model of the camera attached to the camera port. The specific camera port referenced depends on the HDX model: ● HDX 8000 and HDX 9000 series: Camera 4 ●...

  • Page 511: Systemsetting Modelcameranum5

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting modelcameranum5 Returns the model of the camera attached to camera port 5 on Polycom HDX 9004 systems. Syntax systemsetting get modelcameranum5 Parameter Description Returns the current setting. Feedback Examples systemsetting get modelcameranum5...

  • Page 512: Systemsetting Monitor3Display

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting monitor3display Configures Monitor 3 aspect ratio or turns Monitor 3 off. Syntax systemsetting monitor3display <off|4:3|16:9> systemsetting get monitor3display Parameter Description Select if you do not have a VCR or DVD connected or do not need Monitor 3.

  • Page 513: Systemsetting Monitor4Display

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting monitor4display Configures Monitor 4 aspect ratio or turns Monitor 4 off. Syntax systemsetting monitor4display <off|4:3|16:9> systemsetting getget monitor4display Parameter Description Select if you do not have a fourth monitor. Select if you are using a regular TV monitor.

  • Page 514: Systemsetting Monitor3Screensaveroutput

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting monitor3screensaveroutput Specifies whether black video or no signal is sent to Monitor 3 when the system goes to sleep and the screen saver activates. Syntax systemsetting monitor3screensaveroutput <Black|No_Signal> systemsetting get monitor3screensaveroutput...

  • Page 515: Systemsetting Monitor4Screensaveroutput

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting monitor4screensaveroutput Specifies whether black video or no signal is sent to Monitor 4 when the system goes to sleep and the screen saver activates. Syntax systemsetting monitor4screensaveroutput <Black|No_Signal> systemsetting get monitor4screensaveroutput...

  • Page 516: Systemsetting Monitoroutputsignal

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting monitoroutputsignal Specifies the Monitor 1 video format. Syntax systemsetting monitoroutputsignal <DVI|VGA|Component_YPbPr| S_Video|Composite> systemsetting get monitoroutputsignal Parameter Description Specifies DVI as Monitor 1 video format. Specifies VGA as Monitor 1 video format.

  • Page 517: Systemsetting Monitoroutputsignal1

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting monitoroutputsignal1 Specifies the Monitor 2 video format. Syntax systemsetting monitoroutputsignal1 <DVI|VGA|Component_YPbPr| S_Video|Composite> systemsetting get monitoroutputsignal1 Parameter Description Specifies DVI as Monitor 2 video format. Specifies VGA as Monitor 2 video format.

  • Page 518: Systemsetting Monitoroutputsignal2

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting monitoroutputsignal2 Specifies the Monitor 3 video format. Syntax systemsetting monitoroutputsignal2 <S_Video|Composite> systemsetting get monitoroutputsignal2 Parameter Description S_Video Specifies S-Video as Monitor 3 video format. Composite Specifies composite as Monitor 3 video format.

  • Page 519: Systemsetting Monitoroutputsignal3

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting monitoroutputsignal3 Specifies the Monitor 4 video format. Syntax systemsetting monitoroutputsignal3 <DVI|VGA|Component_YPbPr> systemsetting get monitoroutputsignal3 Parameter Description Specifies DVI as Monitor 4 video format. S_Video Specifies S-Video as Monitor 4 video format.

  • Page 520: Systemsetting Overscanenabled1

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting overscanenabled1 Sets or returns the overscan mode for Monitor 1. Syntax systemsetting overscanenabled1 <true|false> systemsetting get overscanenabled1 Parameter Description true Enables overscan mode. false Disables overscan mode. Returns the current setting.

  • Page 521: Systemsetting Overscanenabled2

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting overscanenabled2 Sets or returns the overscan mode for Monitor 2. Syntax systemsetting overscanenabled2 <true|false> systemsetting get overscanenabled2 Parameter Description true Enables overscan mode. false Disables overscan mode. Returns the current setting.

  • Page 522: Systemsetting Overscanenabled3

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting overscanenabled3 Sets or returns the overscan mode for Monitor 3 Syntax systemsetting overscanenabled3 <true|false> systemsetting get overscanenabled3 Parameter Description true Enables overscan mode. false Disables overscan mode. Returns the current setting.

  • Page 523: Systemsetting Overscanenabled4

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting overscanenabled4 Sets or returns the overscan mode for Monitor 4. Syntax systemsetting overscanenabled4 <true|false> systemsetting get overscanenabled4 Parameter Description true Enables overscan mode. false Disables overscan mode. Returns the current setting.

  • Page 524: Systemsetting Potsenable

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting potsenable Allows the system to make voice-only calls to any phone using an analog phone line. Syntax systemsetting potsenable <true|false> systemsetting get potsenable Parameter Description true Enables voice-only calls from analog phone line.

  • Page 525: Systemsetting Primarycamera

    The primary camera is active when the Polycom HDX system initializes. Its source is automatically set to People. On Polycom HDX 7000 systems, the feedback from this command will return incorrect data if camera 2 or camera 3 is designated as the primary camera. The returned value will be one number higher than the primary camera.

  • Page 526: Systemsetting Remotechannelid

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting remotechannelid Specifies the IR identification channel to which the Polycom HDXsystem responds. Syntax systemsetting remotechannelid {0..15} systemsetting get remotechannelid Parameter Description 0..15 Sets the channel ID to be used with the remote control.

  • Page 527: Systemsetting Securemode

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting securemode Returns the status of whether the system is configured in Security Mode. Syntax systemsetting securemode <true|false> systemsetting get securemode Parameter Description true Security Mode is enabled. false Security Mode is disabled.

  • Page 528: Systemsetting Sipaccountname

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting sipaccountname Sets or returns the SIP user account name. Syntax systemsetting sipaccountname <"sipuser"> systemsetting get sipaccountname Parameter Description “sipuser” Specifies the user account name. Returns the current setting. Feedback Examples ●...

  • Page 529: Systemsetting Sipdebug

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting sipdebug Sets or retrieves the state of SIP debug tracing in the system log. Syntax systemsetting sipdebug <True|False> systemsetting get sipdebug Parameter Description True Enables SIP debug tracing in the system log.

  • Page 530: Systemsetting Sipenable

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting sipenable Enables or disables SIP calling. Syntax systemsetting sipenable <True|False> systemsetting get sipenable Parameter Description True Enables SIP calling. False Disables SIP calling. Returns the current setting. Feedback Examples ● systemsetting sipenable True...

  • Page 531: Systemsetting Sippassword

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting sippassword Sets the SIP server password. Syntax systemsetting sippassword <“password”> Parameter Description “password” Password used to register with SIP server. Feedback Examples ● systemsetting sippassword secret returns systemsetting sippassword secret...

  • Page 532: Systemsetting Sipproxyserver

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting sipproxyserver Sets or retrieves the address of the SIP proxy server. Syntax systemsetting sipproxyserver <address> systemsetting get sipproxyserver Parameter Description address Address of the proxy server. Format can be either an actual IP address or a valid DNS hostname (PQP or FQP).

  • Page 533: Systemsetting Sipregistrarserver

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting sipregistrarserver Sets or retrieves the address of the SIP registrar server. Syntax systemsetting sipregistrarserver <address> systemsetting get sipregistrarserver Parameter Description address Address of the registrar server. Format can be either an actual IP address or a valid DNS hostname (PQP or FQP).

  • Page 534: Systemsetting Siptransportprotocol

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting siptransportprotocol Indicates the protocol the system uses for SIP signaling. Syntax systemsetting siptransportprotocol <Both|TCP|UDP> systemsetting get siptransportprotocol Parameter Description Both Specifies to use both TCP and UDP as the SIP protocol.

  • Page 535: Systemsetting Sipusername

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting sipusername Specifies the system's SIP name. Syntax systemsetting sipusername ["name"] systemsetting get sipusername Parameter Description “name” Specifies to use both TCP and UDP as the SIP protocol. Returns the current setting.

  • Page 536: Systemsetting Stereoenable

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting stereoenable Specifies that Polycom StereoSurround is used for all calls. Syntax systemsetting stereoenable <True|False> systemsetting get stereoenable Parameter Description True Enables Polycom stereo. False Disables Polycom stereo. Returns the current setting.

  • Page 537: Systemsetting Telnetenabled

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting telnetenabled Sets or gets the telnet ports. Syntax systemsetting telnetenabled <on|off|port24only> systemsetting get telnetenabled Parameter Description Returns the current setting. Enables port 23 and port 24. Disables port 23 and port 24.

  • Page 538: Systemsetting Timeelapsed

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting timeelapsed Sets or returns the time in call setting. Syntax systemsetting timeelapsed <off|elapsed|local time> systemsetting get timeelapsed Parameter Description System does not display any times in call. elapsed System displays elapsed time in call.

  • Page 539: Systemsetting Transcodingenabled

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting transcodingenabled Specifies whether the system allows each far-site system to connect at the best possible call rate and audio/video algorithm. Syntax systemsetting transcodingenabled <True|False> systemsetting get transcodingenabled Parameter Description True Enables transcoding.

  • Page 540: Systemsetting Treble

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting treble Sets the volume level for the high frequencies without changing the master audio volume. Syntax systemsetting treble <-6|-4|-2|0|+2|+4|+6> systemsetting get treble Parameter Description <-6|-4|-2|0|+2|+4|+ Sets the level for the high frequencies.

  • Page 541: Systemsetting Userdomain

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting userdomain Sets or returns the user domain part of the credentials used to register to the LDAP Directory Server. Syntax systemsetting userdomain <domain> systemsetting get userdomain Parameter Description domain Any valid windows domain string.

  • Page 542: Systemsetting Vcrdvdinlevel

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting vcrdvdinlevel Sets the volume level for audio input 3. Syntax systemsetting vcrdvdinlevel <Auto|0..10> systemsetting get vcrdvdinlevel Parameter Description Auto Allows the codec software to adjust the input level. 0..10 Sets the volume level of the VCR/DVD input to the specified value.

  • Page 543: Systemsetting Vcrdvdoutlevel

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting vcrdvdoutlevel Sets the volume level for audio output 3. Syntax systemsetting vcrdvdoutlevel {0..10} systemsetting get vcrdvdoutlevel Parameter Description 0..10 Sets the volume level of the VCR/DVD output to the specified value.

  • Page 544: Systemsetting Vgaresolution

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting vgaresolution Specifies the resolution for the Monitor 1 VGA signal. Syntax systemsetting vgaresolution <60HZ1024x768|70HZ1024x768|75HZ1024x768|50HZ1280x720|60HZ1280x720|50HZ1920x1080P|60H Z1920x1080P> systemsetting get vgaresolution Parameter Description 60HZ1024x768 Sets Monitor 1 resolution to 1024 x 768 at 60 Hertz.

  • Page 545: Systemsetting Vgaresolution1

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting vgaresolution1 Specifies the resolution for the Monitor 2 VGA signal. Syntax systemsetting vgaresolution <60HZ800x600|72HZ800x600|75HZ800x600|60HZ1024x768|70HZ1024x768|75HZ1024x768|50HZ1280 x720|60HZ1280x720|50HZ1920x1080P|60HZ1920x1080P> systemsetting get vgaresolution Parameter Description 60HZ800x600 Sets Monitor 2 resolution to 800x600 at 60 Hertz.

  • Page 546: Systemsetting Vgaresolution3

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting vgaresolution3 Specifies the resolution for the Monitor 4 VGA signal. Syntax systemsetting vgaresolution3 <60HZ800x600|72HZ800x600|75HZ800x600|60HZ1024x768|70HZ1024x768|75HZ1024x768|50HZ1280 x720|60HZ1280x720|60HZ1280x1024P> systemsetting get vgaresolution3 Parameter Description 60HZ800x600 Sets Monitor 4 resolution to 800x600 at 60 Hertz.

  • Page 547: Systemsetting Webenabled

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting webenabled Specifies whether to allow remote access to the system using the web interface. Syntax systemsetting webenabled <True|False> systemsetting get webenabled Parameter Description True Enables remote access from the web interface.

  • Page 548: Systemsetting Whitebalancemode

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting whitebalancemode Sets or returns the user white balance mode for a Polycom camera on Camera port 1. Syntax systemsetting whitebalancemode <atw|indoor|outdoor|awc> systemsetting whitebalancemode <3680K|4160K|4640K|5120K> systemsetting get whitebalancemode Parameter Description <atw|indoor|outdoor| atw—Manual one touch white balance...

  • Page 549: Systemsetting Whitebalancemode1

    Integrator’s Reference Manual for Polycom HDX Systems System Commands systemsetting whitebalancemode1 Sets or returns the user white balance mode for a Polycom camera on Camera port 2. Syntax systemsetting whitebalancemode1 <atw|indoor|3680K|4160K|4640K|5120K|outdoor|awc> systemsetting get whitebalancemode1 Parameter Description <atw|indoor|3680K|416 atw—Manual one touch white balance 0K|4640K|5120K|outdo indoor—Indoor lighting...

  • Page 550: Tcpports

    Integrator’s Reference Manual for Polycom HDX Systems System Commands tcpports Sets or gets the TCP ports on the system. Syntax tcpports get tcpports set [{1024..49150}] Parameter Description Sets the TCP ports when followed by a value from the range {1024..49150}. To erase the current setting, omit the value.

  • Page 551: Techsupport

    Example: “408 555 2323” Feedback Examples ● techsupport “408 555 2323” returns techsupport will contact you at 408 555 2323 Comments The Support icon is visible only when the system is registered with the Polycom Global Management System. Polycom, Inc.

  • Page 552: Teleareacode

    Integrator’s Reference Manual for Polycom HDX Systems System Commands teleareacode Sets or gets the system’s area code. Syntax teleareacode get teleareacode set ["telephone_area_code"] Parameter Description Returns the current setting. Sets the system’s area code when followed by the “telephone_area_code” parameter. To erase the current setting, omit the “telephone_area_code”...

  • Page 553: Telenumber

    Integrator’s Reference Manual for Polycom HDX Systems System Commands telenumber Sets or gets the system’s telephone number. Syntax telenumber get telenumber set ["telephone_number"] Parameter Description Returns the current setting. Sets the telephone number when followed by the “telephone number” parameter. To erase the current setting, omit the parameter.

  • Page 554: Telnetechoeol

    Integrator’s Reference Manual for Polycom HDX Systems System Commands telnetechoeol Sets the echo end-of-line (EOL) characters to the default values of either the API echo or the serial port echo. Syntax telnetechoeol <get|crnl|nlcr> Parameter Description Returns the current setting for the end of line echo characters.

  • Page 555: Timediffgmt

    Integrator’s Reference Manual for Polycom HDX Systems System Commands timediffgmt Sets or gets the time difference from where the system is installed and Greenwich Mean Time (GMT). This allows the Global Management System to view the local time of the managed system.

  • Page 556: Typeofservice

    Integrator’s Reference Manual for Polycom HDX Systems System Commands typeofservice Sets or gets the type of service for Quality of Service. Syntax typeofservice <get|ipprecedence|diffserv> Parameter Description Returns the current setting. ipprecedence Selects IP precedence service. diffserv Selects DiffServ service. Feedback Examples ●...

  • Page 557: Udpports

    Integrator’s Reference Manual for Polycom HDX Systems System Commands udpports Sets or gets the UDP ports on the system. Syntax udpports get udpports set [{1024..49150}] Parameter Description Returns the current UDP port setting. Sets the UDP ports when followed by a value from the range {1024..49150}.

  • Page 558: Unregisterall (Deprecated)

    Integrator’s Reference Manual for Polycom HDX Systems System Commands unregisterall (deprecated) Alias for the all unregister command. Syntax unregisterall Feedback Examples ● unregisterall returns callstate unregistered camera unregistered linestate unregistered mute unregistered pip unregistered popup unregistered popupinfo unregistered preset unregistered...

  • Page 559: Usefixedports

    Integrator’s Reference Manual for Polycom HDX Systems System Commands usefixedports Sets or gets the Fixed Ports configuration. Syntax usefixedports <get|yes|no> Parameter Description Returns the current setting. Enables the use of Fixed Ports. Disables the use of Fixed Ports. Feedback Examples ●...

  • Page 560: Usegatekeeper

    Integrator’s Reference Manual for Polycom HDX Systems System Commands usegatekeeper Sets or gets the gatekeeper mode. Syntax usegatekeeper <get|off|specify|auto> Parameter Description Returns the current setting. Note: A gatekeeper is not required to make IP-to-IP LAN calls. In these situations, select the off option.

  • Page 561: Usepathnavigator

    ● usepathnavigator never returns usepathnavigator never ● usepathnavigator required returns usepathnavigator required ● usepathnavigator get returns usepathnavigator required Comments This option is only accessible if the PathNavigator, ReadiManager, or Polycom Resource Manager system is used. Polycom, Inc.
  • Page 562 Integrator’s Reference Manual for Polycom HDX Systems System Commands The PathNavigator uses the Polycom MGC™ and can handle video conferences with more participants and higher speeds than a Polycom HDX system’s internal multipoint capability. The PathNavigator, ReadiManager, and Polycom Resource Manager systems support ad-hoc multipoint video conferencing through the Conference on Demand feature, which allows users to bring multiple endpoints together in a video conference on an unscheduled basis.

  • Page 563: Useroompassword

    Integrator’s Reference Manual for Polycom HDX Systems System Commands useroompassword Sets or gets the Use Room Password for Remote Access setting. Syntax useroompassword get useroompassword <yes|no> Parameter Description Returns the current setting. Configures the system to use a separate room password and remote access password.

  • Page 564: V35Broadcastmode

    Integrator’s Reference Manual for Polycom HDX Systems System Commands v35broadcastmode Sets or gets the V.35 broadcast mode. This command is only applicable if you have a V.35 network interface connected to your system. Syntax v35broadcastmode <get|on|off> Parameter Description Returns the current setting.

  • Page 565: V35Dialingprotocol

    Integrator’s Reference Manual for Polycom HDX Systems System Commands v35dialingprotocol Sets or gets the V.35 dialing protocol. This command is only applicable if you have a V.35 network interface connected to your system. Syntax v35dialingprotocol <get|rs366> Parameter Description Returns the current setting.

  • Page 566: V35Num

    Integrator’s Reference Manual for Polycom HDX Systems System Commands v35num Sets or gets the ISDN video numbers assigned to the system. This command is only applicable if you have a V.35 network interface connected to your system. Syntax v35num get <1b1|1b2>...

  • Page 567: V35Portsused

    Integrator’s Reference Manual for Polycom HDX Systems System Commands v35portsused Sets or gets the number of ports to use on the V.35/RS-449/RS-530 network interface module. Syntax v35portsused <get|1|1+2> Parameter Description Returns the current setting. Selects one port for one-channel calls.

  • Page 568: V35Prefix

    Integrator’s Reference Manual for Polycom HDX Systems System Commands v35prefix Sets or gets the V.35 dialing prefix. It assumes that a profile has already been selected. Syntax v35prefix get “valid speed” v35prefix set “valid speed” [“value”] Parameter Description Returns the current setting for “valid speed”.

  • Page 569: V35Profile

    Integrator’s Reference Manual for Polycom HDX Systems System Commands v35profile Sets or gets a V.35 profile associated with dialing through a DCE. It can also display all the settings (speed, prefix or suffix) of the current profile. Syntax v35profile <get|adtran|adtran_isu512|ascend|ascend_vsx|ascend_max|avaya_mcu| custom_1|fvc.com|initia|lucent_mcu|madge_teleos>...

  • Page 570: V35Suffix

    Integrator’s Reference Manual for Polycom HDX Systems System Commands v35suffix Sets or gets the V.35 dialing suffix. It assumes that a profile has already been selected. Syntax v35suffix get “valid speed” v35suffix set “valid speed” [“value”] Parameter Description Returns the current setting for valid speed.

  • Page 571: Validateacctnum

    Integrator’s Reference Manual for Polycom HDX Systems System Commands validateacctnum Sets or gets the validation for the Global Management System account number that is used when dialing out. Syntax validateacctnum <get|yes|no> Parameter Description Returns the current setting. Enables the Global Management System account number validation option.

  • Page 572: Vcbutton

    Integrator’s Reference Manual for Polycom HDX Systems System Commands vcbutton Controls a content video source. It can also register or unregister the API session to receive notification of content events. Syntax vcbutton play {2..6} vcbutton <get|stop|register|unregister> vcbutton map <get|{2..6}> vcbutton source get...
  • Page 573 Integrator’s Reference Manual for Polycom HDX Systems System Commands ● vcbutton play 4 returns vcbutton play 4 vcbutton play succeeded camera near 4 If registered for notifications: ● vcbutton play 4 returns Control event: vcbutton play Control event: vcbutton source 4...
  • Page 574 Control event: vcbutton stop Comments The vcbutton stop command is global in Polycom HDX software version 2.0 or later. Previously, this command was specific to the content video source to which it was mapped. vcbutton 6 specifies sending ppcip as content. vcbutton map defaults to input 4. vcbutton map is only required if you do not specify the input number when sending vcbutton play.

  • Page 575: Vcraudioout

    Integrator’s Reference Manual for Polycom HDX Systems System Commands vcraudioout Enables, disables, or gets the VCR/DVD Audio Out Always On setting. Syntax vcraudioout <get|yes|no> Parameter Description Returns the current setting. Enables VCR Audio Out Always On. Disables VCR Audio Out Always On.

  • Page 576: Vcrrecordsource

    Integrator’s Reference Manual for Polycom HDX Systems System Commands vcrrecordsource Sets or gets the VCR/DVD record source. Syntax vcrrecordsource get vcrrecordsource <near|far|auto|content|content-or-near| content-or-far|content-or-auto|none> Parameter Description Returns the current setting. near Sets the VCR to record the near-site video source. Sets the VCR to record the far-site video source.

  • Page 577: Version

    Integrator’s Reference Manual for Polycom HDX Systems System Commands version Returns the current system’s version information. Syntax version Feedback Examples ● version returns version “release 2.5 - 30Nov2008 11:30” Polycom, Inc.

  • Page 578: Vgaqualitypreference

    Integrator’s Reference Manual for Polycom HDX Systems System Commands vgaqualitypreference Sets or gets the bandwidth split for people and content video. Syntax vgaqualitypreference get vgaqualitypreference <content|people|both> Parameter Description Returns the current setting. content Sets the VGA quality preference to content video.

  • Page 579: Videocallorder

    Integrator’s Reference Manual for Polycom HDX Systems System Commands videocallorder Sets the video call order of the specified protocol to the specified slot. Syntax videocallorder <isdn|h323|sip|gateway323> <1|2|3|4> Parameter Description isdn Specifies ISDN protocol. h323 Specifies IP protocol. Specifies SIP protocol.

  • Page 580: Voicecallorder

    Integrator’s Reference Manual for Polycom HDX Systems System Commands voicecallorder Sets the voice call order of the specified protocol to the specified slot. Syntax voicecallorder <isdn_phone|pots> <1|2> Parameter Description isdn_phone Specifies ISDN phone line. pots Specifies analog phone line. Sets the order in which the specified method is attempted when a voice call is placed.

  • Page 581: Volume

    Integrator’s Reference Manual for Polycom HDX Systems System Commands volume Sets or gets the call audio volume (not sound effects) on the system or registration for volume changes. Syntax volume <register|unregister> volume <get|up|down|set {0..50}> volume range Parameter Description register Registers to receive notification when the volume changes.

  • Page 582: Vortex

    Integrator’s Reference Manual for Polycom HDX Systems System Commands vortex Sends commands to a Polycom Vortex mixer. Syntax vortex <0|1> mute <on|off> vortex <0|1> forward “vortex_macro” Parameter Description Specifies the serial port to which the Vortex mixer is connected. mute Sets the mute state for the Vortex mixer connected to the specified serial port.

  • Page 583: Waitfor

    Integrator’s Reference Manual for Polycom HDX Systems System Commands waitfor This command is used within script files or control panel programs to wait for a specific event before executing the next statement. It causes the API session to wait until a call being placed either connects or fails, or until system is ready to place a call (such as after a reboot waiting for the ISDN lines to come up).

  • Page 584: Wake

    Integrator’s Reference Manual for Polycom HDX Systems System Commands wake Wakes the system from sleep mode. Syntax wake Feedback Examples ● wake returns wake and wakes the system from sleep mode See Also To put the system in sleep mode, use the sleep command on page 415.

  • Page 585: Wanipaddress

    Integrator’s Reference Manual for Polycom HDX Systems System Commands wanipaddress Sets or gets the WAN IP address. Syntax wanipaddress get wanipaddress set [“xxx.xxx.xxx.xxx”] Parameter Description Sets the WAN IP address when followed by the “xxx.xxx.xxx.xxx” parameter. To erase the current setting, omit the “xxx.xxx.xxx.xxx”...

  • Page 586: Webmonitoring

    Integrator’s Reference Manual for Polycom HDX Systems System Commands webmonitoring Enables or disables the ability to view video from a Polycom HDX system via the web interface. This command is available in serial API sessions only. Syntax webmonitoring “remoteaccesspasswd” <yes|no>...

  • Page 587: Webport

    Integrator’s Reference Manual for Polycom HDX Systems System Commands webport Sets or gets the port to use when accessing the system using the web interface. Syntax webport get webport set “port” Parameter Description Returns the current setting. Sets the web access port to “port”.

  • Page 588: Whitelistenabled

    Integrator’s Reference Manual for Polycom HDX Systems System Commands whitelistenabled Enables or disables the ability to restrict a Polycom HDX system’s access to only those systems with IP addresses that match one of the addresses or patterns specified in the whitelist. Syntax whitelistenabled get whitelistenabled <yes|no>...

  • Page 589: Whoami

    Integrator’s Reference Manual for Polycom HDX Systems System Commands whoami Displays the same initial banner information as when the RS-232/Telnet session was started with the system. Syntax whoami Feedback Examples ● whoami returns Hi, my name is: Polycom HDX Demo...

  • Page 590: Room Requirements

    As such, we cannot count on the typical human mechanisms (the human ears and brain and our ability to locate sound in three-dimensional space) to manage any acoustic anomalies. Polycom, Inc.

  • Page 591: Walls

    Integrator’s Reference Manual for Polycom HDX Systems Room Design and Layout If we are, for example, in a room that is adjacent to a double-door entry to the building, then knowing this we can take the inevitable doorway noise into account as we filter the sounds we hear both inside the meeting room and coming from that adjacent entryway.

  • Page 592: Ceiling Tiles

    Integrator’s Reference Manual for Polycom HDX Systems Room Design and Layout while providing a high level of sound and light block. Typically a heavyweight drape (24 ounces or more) of heavy fullness (not less than 6” fullness on not less than 8” centers per fold) is preferred. In all cases, the use of sheer draperies or standard vertical or horizontal blinds should be avoided, due to their inherent inefficiency in blocking sound and light, and the fine lines they create within the camera field of view.

  • Page 593: Furniture

    Integrator’s Reference Manual for Polycom HDX Systems Room Design and Layout In keeping with these color recommendations, the acoustic panels (discussed elsewhere in this section) should be ordered in light colors such as silver-gray, quartz or champagne for panels within the camera field of view.

  • Page 594: Room Lighting

    Integrator’s Reference Manual for Polycom HDX Systems Room Design and Layout the existing wall material, then the acoustic absorption panels are placed on the interior-room side of that. The barrier panels will have a SABIN of 0.9, but will have an additional specification of an STC (sound transmission coefficient) of 20.

  • Page 595: Room Preparation Conclusion

    Integrator’s Reference Manual for Polycom HDX Systems Room Design and Layout It is important to remember that the use of traditional meeting room downcans—even those that have color-corrected light sources—for any lighting in the field of view that may include human faces is to be avoided at all costs.

  • Page 596: Audio Output

    Integrator’s Reference Manual for Polycom HDX Systems Room Design and Layout Perhaps the most difficult issue for any room designer or system planner is actual microphone placement within the space. Given the fact that many people view conference table space as sacred (to be used for papers, laptops, coffee cups and other end-user items), there often is a great deal of pressure to place the local microphones on the ceiling instead of on the table surface.

  • Page 597: Power

    Integrator’s Reference Manual for Polycom HDX Systems Room Design and Layout Power Power is a function of loudspeaker efficiency and total available system power. Most speakers operate in a power range that is broader than the range in which they operate without distortion. For the purpose of conference communication, we are interested in sound that has little or no distortion.

  • Page 598: Cameras

    Integrator’s Reference Manual for Polycom HDX Systems Room Design and Layout videoconference cameras can no longer operate, since they require even, bright, color-corrected light. A direct conflict between these two technologies is clear. In the event that a rear projection room cannot be set aside, retro-projection units can be purchased from a number of manufacturers.
  • Page 599 Integrator’s Reference Manual for Polycom HDX Systems Room Design and Layout It is strongly advised that at least 20 percent of the time spent developing a videoconferencing room be devoted to this important sub-system, as it will complete the integration of the conference and presentation environment.

  • Page 600: Status Messages

    CONNECTED Is equivalent to a 50% yellow sphere. BONDING Indicates the bonding protocol is operational on the channel and is equivalent to a 75% orange sphere. COMPLETE Is equivalent to a 100% green sphere. Polycom, Inc.
  • Page 601 Integrator’s Reference Manual for Polycom HDX Systems Status Messages Feedback Examples ● dial manual 384 5551212 ISDN returns Dialing manual Dialing 5551212 384 none ISDN cs: call[0] chan[0] dialstr[95551212] state[RINGING] cs: call[0] chan[0] dialstr[95551212] state[CONNECTED] cs: call[0] chan[0] dialstr[95551212] state[BONDING]...
  • Page 602 Integrator’s Reference Manual for Polycom HDX Systems Status Messages • listen video returns listen video registered listen video ringing // there is an incoming call, auto answer is on cs: call[0] chan[0] dialstr[7005551212] state[RINGING] cs: call[0] chan[0] dialstr[7005551212] state[CONNECTED] cs: call[0] chan[0] dialstr[7005551212] state[BONDING]...

  • Page 603: Polycom Hdx 9000 Series Specifications

    Polycom HDX 9000 Series Specifications Back Panel Information Refer to the Administrator’s Guide for Polycom HDX Systems at www.polycom.com/videodocumentation back panel views of Polycom HDX systems and for details about the various connections available on each Polycom HDX back panel connector. Inputs/Outputs Audio Specifications...

  • Page 604: Dtmf Dialing

    Polycom HDX 9006 systems. DTMF Dialing The Polycom HDX 9000 series systems generate the following tip/ring signal levels: ● Low-frequency tone: -10.2 dBV, -8.0 dBm when AC termination of the line is 600 Ohms ● High-frequency tone: -8.2 dBV, -6.0 dBm when AC termination of the line is 600 Ohms ●...
  • Page 605 ● EOM–559 µs (22 pulses at 38 KHz) on ● System Code consists of a User ID field (upper nibble) and the Polycom Vender Code (lower nibble) with value 0x5. The default User ID value is 0x3, so the default System Code value is 00110101 or 0x35.
  • Page 606 Integrator’s Reference Manual for Polycom HDX Systems Polycom HDX 9000 Series Specifications Key Name Key Code Key Code Parity Dial String Even Directory 11010 100001 Even Down Arrow Even 10001 Even Fast Forward 101011 Even Feet Down 10110 Feet Up...

  • Page 607: Rs-232 Serial Interface

    Integrator’s Reference Manual for Polycom HDX Systems Polycom HDX 9000 Series Specifications Key Name Key Code Key Code Parity Up Arrow Even Volume Down 111100 Even Volume Up 111011 Zoom In 1101 Zoom Out 1110 RS-232 Serial Interface The RS-232 serial port is implemented by an FPGA-based UART (Universal Asynchronous Receiver/Transmitter) that supports the following values.

  • Page 608: Secure Rs-232 Interface Api Permissions

    You can log in with either the Admin ID and Admin Remote Password or the User ID and User Remote Password of the Polycom HDX system. The available API commands depend on which type of ID you use to start the session, as shown in the following table.
  • Page 609 User ID Admin ID addrbook size range_start range_end search search_pattern group group_name address sys_name sys_label type site_sys_name site_sys_label codec:<1..4> h323_spd h323_num h323_ext sip_spd sip_num xmpp_addr phone_num isdn_spd isdn_num isdn_ext advnetstats 0 ...n alertusertone 1|2|3|4 alertvideotone 1|2|3|4|5|6|7|8|9|1|0 all register Polycom, Inc.
  • Page 610 “areacode” audiometer <micleft | micright | lineinleft | lineinright | lineoutleft | lineoutright | contentinleft | contentinright | vcrinleft | vcrinright | vcroutleft | vcroutright | farendleft | farendright | off> Polycom, Inc.
  • Page 611 Integrator’s Reference Manual Secure RS-232 Interface API Permissions API Command Parameter User ID Admin ID audiotransmitlevel down register unregister autoanswer donotdisturb autoshowcontent backlightcompensation basicmode bri1enable bri2enable bri3enable bri4enable briallenable Polycom, Inc.
  • Page 612 <camera | delete | directory | home | keyboard | period | pip | preset> <info | menu | slides | option> “valid_button” [“valid_button” ...] <mmstop | mmplay | mmpause | mmrecord | mmforward | mmrewind> calldetailreport callinfo callid callstate register unregister callstats Polycom, Inc.
  • Page 613 <near|far> move <left|right|up|down|zoom+|zoom-|stop> <near|far> move <continuous|discrete> <near|far> source <near|far> stop near <getposition|setposition “x” “y” “z”> near ppcip for-people {2..5} for-content {2..5} list-content <register|unregister> register get tracking statistics tracking <get|on|off> cameradirection normal reversed camerainput <1..5> get <1|2|3> <s-video|composite|component> <4|5> <dvi|vga> Polycom, Inc.
  • Page 614 <monitor1 | monitor2> get <monitor1 | monitor2> <s_video | composite | vga | dvi | component> <4:3 | 16:9> [ <720p | 1080i | 1080p> | 50hz720p | 60hz720p | 50hz1080i | 60hz1080i | 50hz1080p | 60 hz1080p>] configparam Polycom, Inc.
  • Page 615 <monitor1 | monitor2> get <monitor1 | monitor2> <near | far | content | near-or-far | content-or-near | content-or-far | all | none> monitor1 "value" monitor2 "value" confirmdiradd confirmdirdel contentauto contentsplash contentvideoadjustment normal stretch zoom country normal inverted ignore daylightsavings Polycom, Inc.
  • Page 616 “addr book name” auto “speed” “dialstr” manual <56|64> “dialstr1” “dialstr2” [h320] manual “speed” “dialstr1” [“dialstr2”] [h323|h320|ip|isdn|sip] “dialstr”, “dialstr1”, “dialstr2” phone “dialstring” pots|isdn_phone|sip_speakerphone dialchannels diffservaudio, diffservfecc, diffservvideo set {0..63} directory display (deprecated) call whoami Polycom, Inc.
  • Page 617 Integrator’s Reference Manual Secure RS-232 Interface API Permissions API Command Parameter User ID Admin ID displaygraphics displayipext displayparams {1..4} set “xxx.xxx.xxx.xxx” normal inverted dsranswer normal inverted dualmonitor dynamicbandwidth e164ext “e.164name” echo “string” Polycom, Inc.
  • Page 618 Integrator’s Reference Manual Secure RS-232 Interface API Permissions API Command Parameter User ID Admin ID echocanceller echoreply enablekeyboardnoisereduction enablelivemusicmode enablepvec enablersvp encryption requiredvideocallsonly requiredallcalls exit exportdirectory exportprofile farcontrolnearcamera Polycom, Inc.
  • Page 619 15|30|60|120 flash callid duration gaddrbook batch {0..59} batch define “start_no” “stop_no” search “pattern” “count” letter {a..z} range “start_no” “stop_no” refresh grouplist size range_start range_end group group_name names search search_pattern address sys_id_string sys_id sys_name sys_label type phone_num h323_spd h323_num Polycom, Inc.
  • Page 620 “xxx.xxx.xxx.xxx” gatewayareacode set “areacode” gatewaycountrycode set “countrycode” gatewayext set “extension” gatewaynumber set “number” gatewaynumbertype number+extension gatewayprefix get “valid speed” set “value” gatewaysetup gatewaysuffix get “valid speed” set “value” gendial {0..9} Polycom, Inc.
  • Page 621 “H.323name” h331audiomode g729 | g728 | g711u | g711a | g722-56 | g722-48 | g7221-16 | g7221-24 | g7221-32 | siren14 | siren14stereo h331dualstream h331framerate 30|15|10|7.5 h331videoformat fcif h331videoprotocol h264|h263+|h263|h261 hangup phone video history homecallquality Polycom, Inc.
  • Page 622 <import data line 1> importprofile <import data line 1> incompleterevocationcheck ipaddress Note: set is not allowed while in a set “xxx.xxx.xxx.xxx” call. ipdialspeed get “valid speed” set “valid speed” <on, off> ipisdninfo both ip-only isdn-only none ipprecaudio, ipprecfecc, ipprecvideo ipstat Polycom, Inc.
  • Page 623 “valid speed” set “valid speed” <on, off> isdnnum get 1b1|1b2|2b1|2b2|3b1|3b2|4b1|4b2 Note: set is not allowed while in a set 1b1|1b2|2b1|2b2|3b1|3b2|4b1|4b2 call. isdnswitch Note: set is not allowed while in a pt-to-pt_at&t_5_ess|multipoint_at&t_5_ess|ni-1| call. nortel_dms-100|standard_etsi_euro-isdn|ts-031| ntt_ins-64 keypadaudioconf language Polycom, Inc.
  • Page 624 “base dn” ldapbinddn set “bind dn” ldapdirectory ldapntlmdomain set “domain” ldappassword set <ntlm|basic> [“password”] disabled disabled ldapserveraddress set “address” ldapserverport ldapsslenabled set [on, off] ldapusername set “user name” linestate register unregister Polycom, Inc.
  • Page 625 Admin ID listen video phone sleep localdatetime loginwindowduration marqueedisplaytext set “text” maxgabinternationalcallspeed set “valid speed” maxgabinternetcallspeed set “valid speed” maxgabisdncallspeed set “valid speed” maxtimeincall set {0..999} mcupassword “password” meetingpassword set “password” monitor1screensaveroutput black no_signal monitor2screensaveroutput black no_signal mpautoanswer donotdisturb Polycom, Inc.
  • Page 626 Integrator’s Reference Manual Secure RS-232 Interface API Permissions API Command Parameter User ID Admin ID mpmode auto discussion presentation fullscreen mtumode default specify mtusize 660|780|900|1020|1140|1260|1500 mute <register|unregister> near <get|on|off|toggle> far get muteautoanswer nath323compatible natconfig auto manual nearloop netstats {0..n} Polycom, Inc.
  • Page 627 User ID Admin ID nonotify callstatus captions linestatus mutestatus screenchanges sysstatus sysalerts vidsourcechanges notify notify callstatus captions linestatus mutestatus screenchanges sysstatus sysalerts vidsourcechanges ntpmode auto manual ntpsecondaryserver set <“server name”|“xxx.xxx.xxx.xxx”> ntpserver set <“server name”|“xxx.xxx.xxx.xxx”> numdigitsdid {0..24} numdigitsext {0..24} oobcomplete Polycom, Inc.
  • Page 628 <get|0|1|2|3> popupinfo register unregister preset <register|unregister> register get far <go|set> <{0..15}> near <go|set> <{0..99}> pricallbycall set {0..31} prichannel get all get {1..n} set all <on|off>} set {1..n} <on|off> pricsu internal external pridialchannels set {1..n} priintlprefix set “prefix” Polycom, Inc.
  • Page 629 <att5ess | att4ess | norteldms ni2 | net5/ctr4 | nttins-1500 | ts-038> reboot [y|now|n] recentcalls registerall resetsystem deletesystemsettings deletelocaldirectory deletecdr deletelogs deletecertificates keepoptsandlogos roomphonenumber set “number” rs232 baud 9600|14400|19200|38400|57600|115200 rs232port1 baud 9600|14400|19200|38400|57600|115200 rs232 mode control disabled Polycom, Inc.
  • Page 630 [register|unregister] “screen name” screencontrol enable <all|none|"screen_name"> disable <all|none|"screen_name"> serialnum servervalidatepeercert session name “session name” find “session name” sessionsenabled setpassword admin room "currentacctpasswd" "newacctpasswd" showpopup “text to display” sleep register unregister Polycom, Inc.
  • Page 631 <all|1b1|1b2|2b1|2b2|3b1|3b2|4b1|4b2> Note: set is not allowed while in a set <1b1|1b2|2b1|2b2|3b1|3b2|4b1|4b2> [“spid call. number”] sslverificationdepth normal inverted subnetmask Note: set is not allowed while in a set “xxx.xxx.xxx.xxx” call. sysinfo register unregister systemname set “system name” Polycom, Inc.
  • Page 632 User ID Admin ID systemsetting 320gatewayenable true false systemsetting 323gatewayenable true false systemsetting bass <-6|-4|-2|0|+2|+4|+6> systemsetting cameraaspectratio 16:9 systemsetting cameraaspectratio1 16:9 systemsetting cameraaspectratio2 16:9 systemsetting cameraaspectratio3 16:9 systemsetting cameraaspectratio4 16:9 systemsetting cameracontent1 people content systemsetting cameracontent2 people content Polycom, Inc.
  • Page 633 “name” systemsetting cameraname1 “name” systemsetting cameraname2 “name” systemsetting cameraname3 “name” systemsetting cameraname4 “name” systemsetting cameratype NTSC systemsetting 720p componentresolution 1080i 1080p systemsetting 720p componentresolution1 1080i 1080p systemsetting VIDEO_THEN_AUDIO connectionpreference AUDIO_THEN_VIDEO Polycom, Inc.
  • Page 634 Manual systemsetting displayiconincall true false systemsetting true displaylastnumberdialed false systemsetting domainname domain <60HZ1024x768|70HZ1024x768|75HZ1024x768|5 systemsetting dviresolution 0HZ1280x720|60HZ1280x720|60H1400x1050|50H Z1920x1080I|50HZ1920x1080P|60HZ1920x1080I |60HZ1920x1080P> <60HZ800x600|72HZ800x600|75HZ800x600|60HZ systemsetting dviresolution1 1024x768|70HZ1024x768|75HZ1024x768|50HZ12 80x720|60HZ1280x720|60HZ1400x1050|50HZ192 0x1080I|50HZ1920x1080P|60HZ1920x1080I|60H Z1920x1080P> <60HZ800x600|72HZ800x600|75HZ800x600|60HZ systemsetting dviresolution3 1024x768|70HZ1024x768|75HZ1024x768|50HZ12 80x720|60HZ1280x720|60HZ1280x1024> systemsetting enablegdsdirectory true false systemsetting enablepolycommics true false Polycom, Inc.
  • Page 635 Admin ID systemsetting farnamedisplaytime systemsetting iph323enable true false systemsetting ipmaxincoming speed systemsetting isdnh320enable true false systemsetting isdnmaxincoming speed systemsetting ldapuserid userid systemsetting lineinlevel {0..10} systemsetting lineintype LINE_INPUT MICROPHONE systemsetting lineoutmode Fixed Variable systemsetting maxrxbandwidth speed systemsetting maxtxbandwidth speed Polycom, Inc.
  • Page 636 <Off|4:3|16:9> systemsetting monitor4display <Off|4:3|16:9> systemsetting <Black|No_Signal> monitor3screensaveroutput systemsetting <Black|No_Signal> monitor4screensaveroutput systemsetting monitoroutputsignal <DVI|VGA|Component_YPbPr S_Video|Composite> systemsetting <DVI|VGA|Component_YPbPr monitoroutputsignal1 S_Video|Composite> systemsetting <DVI|VGA|Component_YPbPr monitoroutputsignal2 S_Video|Composite> systemsetting <DVI|VGA|Component_YPbPr monitoroutputsignal3 S_Video|Composite> Polycom, Inc.
  • Page 637 {1..5} systemsetting remotechannelid {0..15} systemsetting securemode true false systemsetting sipaccountname sipuser systemsetting sipdebug true false systemsetting sipenable true false systemsetting sippassword password Polycom, Inc.
  • Page 638 <Both|TCP|UDP> systemsetting sipusername “name” systemsetting stereoenable true false systemsetting telnetenabled port24only systemsetting timeelapsed <off|elapsed|local time> systemsetting transcodingenabled true false systemsetting treble <-6|-4|-2|0|+2|+4|+6> systemsetting userdomain domain systemsetting vcrdvdinlevel <Auto|0..10> systemsetting vcrdvdoutlevel {0..10} Polycom, Inc.
  • Page 639 Note: set is not allowed while in a call. techsupport “phone num” teleareacode set “telephone_area_code” telenumber set “telephone number” timediffgmt {-12:00..+12:00} typeofservice ipprecedence diffserv udpports Note: set is not allowed while in a set [{1024..49150}] call. Polycom, Inc.
  • Page 640 Note: set is not allowed while in a call. v35dialingprotocol rs366 v35num get <1b1|1b2> Note: set is not allowed while in a set <1b1|1b2> | [“v35 number”] call. v35portsused <1|1+2> v35prefix get “valid speed” set “valid speed” [“value”] v35profile adtran|adtran_isu512|ascend|ascend_vsx| ascend_max|avaya_mcu|custom_1|fvc.com| initia|lucent_mcu|madge_teleos Polycom, Inc.
  • Page 641 <near | far | auto | content | content-or-near | content-or-far | content-or-auto | none> vgaqualitypreference content people both videocallorder <isdn|h323|sip|gateway323> <1|2|3|4> voicecallorder <isdn_phone|pots> <1|2> volume down register unregister range vortex <0|1> mute <on|off> disabled disabled <0|1> forward “vortex_macro” disabled disabled waitfor <systemready|callcomplete> wake wanipaddress set “xxx.xxx.xxx.xxx” Polycom, Inc.
  • Page 642 Integrator’s Reference Manual Secure RS-232 Interface API Permissions API Command Parameter User ID Admin ID webport whitelistenabled Polycom, Inc.

  • Page 643: Categorical List Of Api Commands

    633 Directory Commands LDAP Commands ● abk (deprecated) on page 115 (all Polycom HDX system versions) ● addrbook on page 118 (Polycom HDX system versions 2.5 and later) ● gaddrbook on page 249 Call Function Commands Calling Commands ● answer on page 139 ●...

  • Page 644: Call Status Request

    Integrator’s Reference Manual for Polycom HDX Systems Categorical List of API Commands ● phone on page 375 Call Status Request ● advnetstats on page 126 ● callinfo on page 170 ● gendialtonepots (deprecated) on page 269 ● getcallstate on page 272 ●...

  • Page 645: Conference Password Settings

    Integrator’s Reference Manual for Polycom HDX Systems Categorical List of API Commands ● mpmode on page 350 ● muteautoanswer on page 354 ● systemsetting displayiconsincall on page 466 ● systemsetting maxrxbandwidth on page 485 ● systemsetting maxtxbandwidth on page 486 ●...

  • Page 646: Gms Commands

    Integrator’s Reference Manual for Polycom HDX Systems Categorical List of API Commands ● maxgabinternetcallspeed on page 340 ● localdatetime on page 336 ● registerthissystem on page 394 GMS Commands ● gmscity on page 274 ● gmscontactemail on page 275 ●...

  • Page 647: Lan, Wan, And Ip Commands

    Integrator’s Reference Manual for Polycom HDX Systems Categorical List of API Commands LAN, WAN, and IP Commands H323 Commands ● clientvalidatepeercert on page 181 ● on page 217 ● e164ext on page 222 ● gatekeeperip on page 258 ● enablersvp on page 230 ●...

  • Page 648: Sip Commands

    Integrator’s Reference Manual for Polycom HDX Systems Categorical List of API Commands ● ipv6defaultgateway on page 311 ● ipv6linklocal on page 312 ● ipv6sitelocal on page 313 ● ipaddress on page 305 ● ipstat on page 314 ● lanport on page 323 ●...

  • Page 649: Content Control Commands

    Integrator’s Reference Manual for Polycom HDX Systems Categorical List of API Commands ● systemsetting lineinlevel on page 482 ● systemsetting lineoutmode on page 484 ● systemsetting mediainlevel on page 487 ● systemsetting stereoenable on page 518 ● nonotify on page 359 ●...

  • Page 650: Monitor Video Output Setting Commands

    Integrator’s Reference Manual for Polycom HDX Systems Categorical List of API Commands ● systemsetting whitebalancemode1 on page 531 ● nonotify on page 359 ● notify on page 360 Monitor Video Output Setting Commands ● configdisplay on page 185 ● sleeptime on page 417 ●...

  • Page 651: System Commands

    Integrator’s Reference Manual for Polycom HDX Systems Categorical List of API Commands ● sleep on page 415 ● sysinfo on page 433 ● unregisterall (deprecated) on page 540 ● vcbutton on page 554 ● voicecallorder on page 562 System Commands System Commands ●...
  • Page 652 Integrator’s Reference Manual for Polycom HDX Systems Categorical List of API Commands ● remotemonenable on page 396 ● rs232 baud, rs232port1 baud on page 401 ● rs232 mode, rs232port1 mode on page 402 ● session on page 410 ● setpassword on page 413 ●...
  • Page 653 Integrator’s Reference Manual for Polycom HDX Systems Categorical List of API Commands ● systemsetting dviresolution1 on page 471 ● systemsetting iph323enable on page 477 ● systemsetting ipmaxincoming on page 478 ● systemsetting isdnh320enable on page 479 ● systemsetting isdnmaxincoming on page 480 ●...

  • Page 654: Diagnostic Commands

    Integrator’s Reference Manual for Polycom HDX Systems Categorical List of API Commands ● systemsetting telnetenabled on page 519 ● systemsetting timeelapsed on page 520 ● systemsetting transcodingenabled on page 521 ● ● systemsetting treble on page 522 ● systemsetting userdomain on page 523 ●...

  • Page 655: Index

    106 HDCI 54 Knowledge Base 107 HDMI monitor 48 video test numbers 107 HDX component video 51 area code ISDN 30 command for BRI 140 LAN 28 command for gateway 259 microphone 77 command for ISDN 315 Polycom, Inc.
  • Page 656 Integrator’s Reference Manual for the Polycom RealPresence Group Series microphone host 75 composite video cable 67 Polycom HDX component monitor 50 configchange command 184 POTS 32 configdisplay command 185 PowerCam break-out 69 configparam command 187 PowerCam control 70 configpresentation command 188...
  • Page 657 Integrator’s Reference Manual for Polycom HDX Systems Index command for allowing changes 133 gabserverip command 248 command for confirming additions 190 gaddrbook 249 command for confirming deletions 191 gaddrbook command 249 directory command 208 gatekeeper, command for mode 542 discussion mode, command for multipoint display 350...
  • Page 658 Integrator’s Reference Manual for the Polycom RealPresence Group Series homemultipoint command 293 bind DN 326 password 329 homerecentcalls command 294 port 331 homesystem command 295 ldapauthenticationtype command 324 homesystemname command 296 ldapbasedn command 325 hostname command 297 ldapbinddn command 326...
  • Page 659 Integrator’s Reference Manual for Polycom HDX Systems Index prilinesignal command 387 prinumberingplan command 388 parameters, configuring 187 prioutsideline command 389 parameters, setting multiple 187 priswitch command 390 password processing command for GDS 247 commands 111 LDAP server 329 PVEC, command to enable 229...
  • Page 660 Integrator’s Reference Manual for the Polycom RealPresence Group Series command for DNS 216 typeofservice command 538 command for GDS 248 command for NTP 365 servervalidatepeercert command 409 udpports command 539 session command 410 unregisterall command 540 sessionsenabled command 411 URL, command for Global Management System 282...
  • Page 661 Integrator’s Reference Manual for Polycom HDX Systems Index Polycom, Inc.
  • Page 662 Integrator’s Reference Manual for the Polycom RealPresence Group Series...

This manual is also suitable for:

Hdx 9002Hdx 9001

Table of Contents