Summary of Contents for Polycom RealPresence Group Series
Page 1
INTEGRATOR REFERENCE GUIDE 6.2.0 | December 2018 | 3725-63708-011A ® ® Polycom RealPresence Group Series...
Page 2
Polycom up to three (3) years after the distribution date of the applicable product or software at a charge not greater than the cost to Polycom of shipping or distributing the software to you. To receive software information, as well as the open source software code used in this product, contact Polycom by email at OpenSourceVideo@polycom.com.
Participate in discussion forums to share ideas and solve problems with your colleagues. To register with the Polycom Community, simply create a Polycom online account. When logged in, you can access Polycom support personnel and participate in developer and support forums to find the latest information on hardware, software, and partner solutions topics.
Room Integration Set Up a Room for Video Conferencing This section provides information about how to set up a room for video conferencing using Polycom RealPresence Group systems and other Polycom products. For detailed information about setting up a room for video conferencing, refer to Room Design and Layout.
Page 14
Note: You may experience a low signal strength when connecting a touchscreen monitor with a USB cable that is longer than five feet. Polycom recommends that you use an externally powered USB hub or a USB cable that is shorter than five feet.
Page 15
Room Integration Large Conference Room Polycom, Inc.
Page 16
Note: You may experience a low signal strength when connecting a touchscreen monitor with a USB cable that is longer than five feet. Polycom recommends that you use an externally powered USB hub or a USB cable that is shorter than five feet.
Page 18
Note: You may experience a low signal strength when connecting a touchscreen monitor with a USB cable that is longer than five feet. Polycom recommends that you use an externally powered USB hub or a USB cable that is shorter than five feet.
Page 19
Note: You may experience a low signal strength when connecting a touchscreen monitor with a USB cable that is longer than five feet. Polycom recommends that you use an externally powered USB hub or a USB cable that is shorter than five feet Computer Polycom, Inc.
If you place the RealPresence Group system in a cart or credenza, make sure there is proper ventilation for maintaining an ambient temperature of 40°C or lower. Polycom recommends ventilation gaps of at least 4 inches (101.60 mm) on the left and right of the system, as shown in the following figure, with appropriate access to fresh air.
Polycom EagleEye Acoustic, Polycom EagleEye IV, Polycom EagleEye III, Polycom EagleEye Director, Polycom EagleEye Director II, Polycom EagleEye HD, Polycom EagleEye 1080, Polycom EagleEye View, or Polycom EagleEye II. Refer to the release notes for the software release installed on the system for a list of supported PTZ cameras.
Page 22
RealPresence Group 700 systems. 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 23
Room Integration Connect a Polycom EagleEye III Camera to a Polycom RealPresence Group 300 System as the Main Camera (Option 1): 1725-27441-006/A 12V 6.25A Connect a Polycom EagleEye III Camera to a Polycom RealPresence Group 310 or 500 System as the Main Camera (Option 1):...
Page 24
RealPresence Group Series system using HDCI, or when the HDCI cable is longer than 10 meters. 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 25
Room Integration Connect a Polycom EagleEye III Camera to a Polycom RealPresence Group 310 or 500 System as the Main Camera (Option 2): DC IN 12V Use Polycom Power Supply Only Optional, up to 100 ft Part Number: 1465-52748-040 Connect a Polycom EagleEye III Camera to a Polycom RealPresence Group 700 System as the Main Camera (Option 2): 100-240VAC 50/60Hz 2.3A...
Page 26
RealPresence Group Series system using HDCI, or when the HDCI cable is longer than 10 meters. 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
RealPresence Group 700 systems. 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
Room Integration Connect a Polycom EagleEye IV Camera to a Polycom RealPresence Group 300 System as the Main Camera (Option 1): 1725-27441-006/A 12V 6.25A Connect a Polycom EagleEye IV Camera to a Polycom RealPresence Group 310 or 500 System as the Main Camera (Option 1):...
Page 29
Room Integration Option 2 For installations requiring distances of farther than 10m between the camera and system, use the Polycom EagleEye Digital Extender. The EagleEye Digital Extender (part number 2215-64200-001) supports distances from 3m to 100m. Connect the camera and system using the following cables: ●...
Page 30
Room Integration Connect a Polycom EagleEye IV Camera to a Polycom RealPresence Group 300 System as the Main Camera (Option 2): 1725-27441-006/A 12V 6.25A 3m-100m DC IN 48V Polycom, Inc.
Page 31
Room Integration Connect a Polycom EagleEye IV Camera to a Polycom RealPresence Group 310 or 500 System as the Main Camera (Option 2): 3m-100m DC IN 48V Polycom, Inc.
Page 32
DBAs. Use the following cables to connect the DBA: ● HDCI Polycom EagleEye IV Digital Camera Cable to connect the EagleEye IV to a DBA, and another HDCI Polycom EagleEye IV Digital Camera Cable at the codec to the DBA. The EagleEye Acoustic has a captured cable and can directly connect to the DBA.
Page 33
Camera EagleEye Director can be connected to Polycom RealPresence systems as the main camera. Polycom EagleEye Director can be connected to a Polycom RealPresence Group 700 system as the main camera or second camera. Connect an EagleEye Director (part number 7200-82632-001, 7200-82631-001, or 2200-82559-001) to RealPresence Group system as the main camera using: ●...
Page 34
Director. Use the EagleEye Director II as the Main Camera You can connect a Polycom EagleEye Director II camera (part number 2215-69572-001) to a Polycom RealPresence Group Series system as the main camera. Connect an EagleEye Director II (part number 2215-69572-001) to a RealPresence Group system as the main camera using: ●...
Page 35
Room Integration Connect a Polycom EagleEye Director II to a Polycom RealPresence Group 300 System as the Main Camera: 1725-27441-006/A 12V 6.25A Polycom, Inc.
Page 36
Room Integration Connect a Polycom EagleEye Director II to a Polycom RealPresence Group 310 or 500 System as the Main Camera: 1725-27441-006/A 12V 6.25A Polycom, Inc.
Page 37
100-240VAC 50/60Hz 2.3A Polycom EagleEye Producer An EagleEye Producer can be connected to one Polycom RealPresence Group system as the main camera. EagleEye Producer supports the EagleEye III camera (part number 1624-08283-002, 8200-63730-001, or 8200-63740-001). It also supports the EagleEye IV camera part number 1624-66057-001 (12x zoom) or 1624-66061-001 (4x zoom).
Page 38
Room Integration Connect a Polycom EagleEye Producer with a Polycom EagleEye III Camera to a Polycom RealPresence Group 300 System: (Supplied with camera) 1725-27441-006/A 12V 6.25A Polycom, Inc.
Page 39
Room Integration Connect a Polycom EagleEye Producer with a Polycom EagleEye III Camera to a Polycom RealPresence Group 310 or 500 System: (Supplied with camera) Polycom, Inc.
Page 40
Room Integration Connect a Polycom EagleEye Producer with a Polycom EagleEye III camera to a Polycom RealPresence Group 700 system: (Supplied with camera) 100-240VAC 50/60Hz 2.3A Connect a Polycom EagleEye Producer with Polycom EagleEye IV camera to a Polycom RealPresence Group system using: Option 1 ●...
Page 41
Room Integration Connect a Polycom EagleEye Producer with a Polycom EagleEye IV Camera to a Polycom RealPresence Group 300 System (Option 1): 2457-69794-001 20 cm (Supplied with camera) 1725-27441-006/A 12V 6.25A Polycom, Inc.
Page 42
Room Integration Connect a Polycom EagleEye Producer with a Polycom EagleEye IV Camera to a Polycom RealPresence Group 310 or 500 System (Option 1): 2457-69794-001 20 cm (Supplied with camera) Polycom, Inc.
Page 43
Room Integration Connect a Polycom EagleEye Producer with a Polycom EagleEye IV Camera to a Polycom RealPresence Group 700 System (Option 1): 100-240VAC 50/60Hz 2.3A Option 2 For installations requiring distances of farther than 10m between the EagleEye Producer and the system, use the Polycom EagleEye Digital Extender.
Page 44
Room Integration Connect a Polycom EagleEye Producer with a Polycom EagleEye IV Camera to a Polycom RealPresence Group 300 System (Option 2): 1725-27441-006/A 12V 6.25A 3m-100m DC IN 48V Polycom, Inc.
Page 45
Room Integration Connect a Polycom EagleEye Producer with a Polycom EagleEye IV Camera to a Polycom RealPresence Group 310 or 500 System (Option 2): 3m-100m DC IN 48V Polycom, Inc.
Page 46
DC IN 48V Option 3 For installations where the use of HDMI cables is preferred, the Polycom Digital Breakout Adapter (DBA) is recommended. There are two versions of this adapter. One version is for use at the camera and requires a power transformer.
Page 47
Use the guidelines and recommendations in this section when installing the EagleEye Digital Extender. Maximum cable length The maximum cable length for the user provided cable for the Polycom EagleEye Digital Extender is 100 meters. This maximum length refers to the length between the two Polycom EagleEye Digital Extender boxes.
Room Integration Cable Bundling Polycom EagleEye Digital Extender is based on HDBaseT technology, which limits how many data cables can be bundled together. The following table shows the maximum number of data cables permitted in a bundle. Maximum number of cables per bundle...
Page 49
To configure these cameras, go to the RealPresence Group system web interface and select Admin Settings > Audio/Video > Video Inputs. For more information about configuring cameras, refer to the Polycom RealPresence Group Series Administrator Guide. If your camera has a breakout cable that allows the video to be connected to the HDCI port, you can use the external serial port to get the serial data to and from the camera: 1 On the system’s back panel, connect the camera to the serial port.
When connecting a Polycom RealPresence Group Series microphone to a Polycom RealPresence Group Series system, ensure that the cable is inserted correctly. When connecting the cable to a microphone, the icon must be facing up. When connecting the cable to a RealPresence Group Series system or Polycom SoundStation IP 7000 phone, the icon must be facing up.
Connect a Computer to a Polycom RealPresence Group System You can connect Polycom RealPresence Group series 310, 500, and 700 systems to a computer with an HDMI or VGA connection, or using the People+Content IP software application to share content. Polycom RealPresence Group 300 systems use only People+Content IP to share content.
Page 52
For this option, you must configure your RealPresence Group system’s 3.5mm audio input to associate with its content video ports. ● A—3.5mm stereo male to 3.5mm stereo male ● B—VGA male to VGA male cable Connect a computer to a RealPresence Group 500 system (Option 2): Polycom, Inc.
Page 53
Room Integration Connect a computer to a RealPresence Group 700 system (Option 2): 100-240VAC 50/60Hz 2.3A Polycom, Inc.
T568B Pair T568B Pair Note: 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 Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
PIN 8 12 FEET +/- 3" Note: 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 Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
25 ft (7.62 m) 2457-26994-001 Note: 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 Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Cables Polycom Touch Device Power Adapter This adapter connects the Polycom RealPresence Touch device to the LAN and a power supply (part number 2200-42740-001) for rooms that do not have Power over Ethernet (PoE) Length Part Number RoHS Compliant 2.1 ft (0.61m) 2457-40054-001 Note: Drawings and part numbers are provided for reference only.
SHELL SHELL Note: 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 Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
This cable connects a RealPresence Group Series system to a Polycom EagleEye HD, Polycom EagleEye II, Polycom EagleEye III, or Polycom EagleEye Director (3 m and 10 m lengths only) or Polycom EagleEye Director II. This cable can be connected to the EagleEye View camera, but does not support audio. It has male HDCI connectors on both ends.
Page 60
Cables Note: 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 Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
This cable, also referred to as a mini-HDCI, is a male HDCI to male mini HDCI. It connects a system to a Polycom EagleEye IV camera. It also connects an EagleEye Producer that is used with an EagleEye IV camera or an EagleEye Digital Extender to a system.
Page 62
✓ EagleEye Producer to Digital Breakout Adapter Note: 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 Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Cables HDCI Polycom EagleEye IV Camera to Polycom EagleEye Producer Digital Cable This cable connects a Polycom EagleEye Producer to a Polycom EagleEye IV camera. It is male HDCI to male mini HDCI. Length Part Number RoHS Compliant 1 ft (0.3m) 2457-64356-030 Note: Drawings and part numbers are provided for reference only.
Cables HDCI Polycom EagleEye Director Analog 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 Part Number RoHS Compliant 1 ft (0.3 m) 2457-26122-001 1 ft (0.3 m)
Page 65
As shown in the following figure, the EagleEye Director has seven microphones embedded in the base. EagleEye Director embedded microphones Vertical Mic Top Vertical Mic Center Horizontal Mic Left Horizontal Mic Right Horizontal Mic Left Center Horizontal Mic Right Center Horizontal Mic Center Polycom, Inc.
Cables HDCI Polycom EagleEye Producer Camera Digital Cable Adapter This cable connects the HDCI output of a Polycom EagleEye Producer to an EagleEye IV Digital Camera Cable. It is male HDCI to male mini HDCI. Length Part Number RoHS Compliant 0.7 ft (0.2m)
Cables Polycom EagleEye Acoustic Digital Cable This cable connects a Polycom EagleEye Acoustic camera to a RealPresence Group Series system. Length Part Number RoHS Compliant 6 ft 5 in (2 m) 0932-0000-A0A0 Caution: The cable can only be extended with the EagleEye Digital Extender (which does not support audio).
Page 68
Cables Note: 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 Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Green Blue Note: 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 Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
HDCI Polycom EagleEye 1080 Camera Cable This cable connects a Polycom system HDCI video input to the Polycom EagleEye 1080 camera. It is HDCI to 8-pin mini-DIN and HD-15. The maximum approved length for this cable is 100 ft (30 m).
Page 71
Cables Note: 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 Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Cables HDCI Polycom EagleEye View Camera Analog Cable This cable connects a RealPresence Group 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.
The Polycom RealPresence Digital Breakout, Codec adapter allows the input of HDMI and Serial for control into an HDCI input on RealPresence Group Series codecs. You can also use this adapter with the Polycom RealPresence Digital Breakout, Camera to extend the distance between an EagleEye IV camera or an EagleEye Producer and a RealPresence Group Series codec.
Page 75
Cables Note: 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 Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
This breakout adapter allows Polycom EagleEye IV and Polycom EagleEye Acoustic cameras to be broken out into HDMI and Serial (DB9) signals. You can also use this adapter with the Polycom RealPresence Digital Breakout, Codec adapter to extend the distance between an EagleEye IV camera or EagleEye Producer and a Group Series codec.
Page 77
2215-68485-001 — Note: 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 Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Cables HDCI Adapter for Polycom EagleEye Director II This adapter connects a camera’s mini-HDCI output to the mini-HDCI input on the base of the EagleEye Director II. This connection must be secured before a camera can be mounted to the EagleEye Director II.
Page 79
— 1696-69473-001 Note: 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 Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
When attaching a system to a device, this cable cannot be used to chain additional devices to the first device. This cable is male Walta to male Walta. Polycom recommends using cable 2457-23216-002 when connecting to a RealPresence Group Series system Caution: Be very careful to plug in the microphone array with the correct plug orientation.
Page 81
PAIR #2 CONDUCTOR #1 CONDUCTOR #2 DRAIN SHIELD SHIELD SHIELD CABLE UNIT JUMPER #1 CABLE UNIT JUMPER #2 PINS 1, 5, 7, 8, 11 AND 12 OF P1 & P2 ARE NOT USED AND SHALL BE LEFT OPEN. Polycom, Inc.
Page 82
Cables Note: 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 Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
10 ft (3 m) 2457-24011-001 Note: 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 Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
SHIELD SHIELD Note: 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 Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
2 ft (0.6m) 2457-26761-024 Note: 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 Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
The length from the RealPresence Group Series system to the first Polycom Microphone Array or SoundStation IP 7000 phone can be between 18 in. and 100 ft. (a RealPresence Group Series 700 system allows two such connections). Polycom recommends you use shielded CAT5e cables for lengths greater than 25 ft.
Page 87
BROWN Shielded Conference Link Crossover Cable The following diagram shows the typical shielded Polycom Conference Link crossover cable. This cable style is appropriate for lengths longer than 25 ft. Notice that pins 1 and 2 are mapped to pins 5 and 6, respectively, at the other end of the connector. The pin 4 wire is not used, and the shield is connected to pin 3.
Page 88
RealPresence Microphone Array Cable to ensure the cable is connected correctly. 1 Identify the P1 connector on the Polycom RealPresence microphone cable according to the location of the brown heat-shrink tubing as shown on the...
Page 89
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 Walta connector that connects to the RealPresence Group system. Polycom, Inc.
RED INSULATION (2X) RED INSULATION (2X) WHITE INSULATION (2X) WHITE INSULATION (2X) 6 IN. ± 0.5 IN. 6 IN. ± 0.5 IN. OVER MOLD "RCA" CONNECTORS OVER MOLD "RCA" CONNECTORS (2X) (2X) 25 FEET +/- 3" 25 FEET +/- 3" Polycom, Inc.
Polycom EagleEye Director Audio Feedback Phoenix to RCA Cable This cable connects a RealPresence Group Series system to the Polycom EagleEye Director and the room audio playback system. It is dual male Phoenix connectors (for RealPresence Group Series systems) to dual male RCA connectors (for the EagleEye Director) with dual female RCA connectors (for the room audio playback system).
Polycom EagleEye Director ll RCA Audio Breakout Cable This cable connects a RealPresence Group Series system to the Polycom EagleEye Director II and the room audio playback system. It is dual male Phoenix connectors (for RealPresence Group Series systems) to dual male RCA connectors (for the EagleEye Director II) with dual female RCA connectors (for the room audio playback system).
Polycom EagleEye Director II Dual Stereo Audio Adapter This 3.5 mm adapter is used with a Polycom EagleEye Director ll RCA Audio Breakout Cable (part number 2457-69476-001) to convert the 3.5 mm line out connection on a RealPresence Group Series 300 or 310 system to RCA.
Straight-Through Cable ● Null Modem Adapter Polycom RealPresence Group Series Serial Cable This cable connects a Polycom RealPresence Group Series system to a serial device. It is 8-pin mini-DIN to DB-9. Notes: • The 8-pin mini-DIN RS232 connection is wired per Polycom RS-232 and does not follow VISCA pinout convention.
Page 95
Cables Note: 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 Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Cables Straight-Through Cable This cable connects a RealPresence Group Series 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). Recommendations for Use Polycom does not recommend using this straight-through serial cable for RS-232 communication from a computer, Crestron system, or AMX device.
PIN 7 PIN 9 Note: 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 Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Using the API The API is for advanced users who want to automate a Polycom RealPresence Group Series system. To access the API, you can connect a control system or computer to the RS-232 serial port on your RealPresence Group Series system. You can also connect using telnet or SSH over the LAN.
Use an 8-pin mini-DIN to DB-9 cable such as the Polycom RealPresence Group Series Serial Cable connect to the RS-232 interface. The pinouts for this type of cable are listed in the following table: RealPresence Group Series 300, 310, and 500 serial port pinouts Polycom, Inc.
Start an API Session Using an RS-232 Interface RealPresence Group Series systems can run API sessions from the RS-232 interface. After you have verified that the RealPresence Group Series system and your computer or control system are configured appropriately, you can set up the devices.
Page 101
Using the API with the Maximum Security Profile Enabled. The system can be configured to require login credentials on any port. To enable login mode, go to Serial Ports > Serial Port Options. Polycom, Inc.
To use the API with a LAN connection: 1 On the computer, open a command line interface. 2 Start a telnet session using the RealPresence Group Series system IP address and port number that is currently configured for telnet API—for example, telnet 10.11.12.13 24.
2 If necessary, enable external authentication. 3 Enable the SSH feature. 4 Start an SSH session using the RealPresence Group Series system IP address and port 22. 5 When prompted, enter the remote access credentials. For information on configuring local or AD accounts, refer to the Polycom RealPresence Group Series Administrator Guide at support.polycom.com.
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 website when you need to access Polycom product documentation or tips.
Note: While every attempt has been made to ensure that the expected results of executing the API commands are accurate and complete, Polycom cannot be responsible for system behaviors and control actions that are not explicitly documented in this publication.sn About the API Commands This section provides details about the descriptions for the API commands.
API commands that are authorized for normal users. For more information on user roles, refer to the Manage System Access topic in the Polycom RealPresence Group Series Administrator Guide. Note: User sessions are available only via SSH or on the serial port (when the configured serial port Login Mode is username/password).
Page 107
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.
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. Note: API support is not available for software versions for the Joint Interoperability Test Command (JITC) certification.
● When developing your program, always allow enough time for the response to the requested command to complete before sending another command. ● Polycom does not recommend that you send any commands while an incoming or outgoing call is being established.
Specifies a pattern to match for the batch “pattern” search. Specifies the number of entries to list that ✓ “count” match the pattern. ✓ Returns a batch of entries in the range defined define by “start_no” to “stop_no.” Polycom, Inc.
Page 111
The size parameter can be used with the names and the names search commands. The response is in the following format: addrbook names <all|video|phone> size {0..n} addrbook names search "search_pattern" <all|video|phone> size {0..n} Polycom, Inc.
Page 112
Returns a list of the names of all the sites group included in a local directory group in this format: addrbook group {0..n}. name:"site_sys_name" sys_label:"site_sys_label" addrbook group "group_name" [range] done addrbook group size <num_entries> ✓ A local address book group name. group_name Polycom, Inc.
Page 113
The preferred speed for a SIP call to this entry. sip_spd If no speed is associated with the entry, then this is the same as the h323_spd. IP address. ✓ sip_num ✓ XMPP address, also known as the Jabber ID xmpp_addr (JID). Polycom, Inc.
Page 114
System Commands Feedback Examples ● addrbook all returns addrbook 0. “Polycom Group Series Demo 1” isdn_spd:384 isdn_num:1.700.5551212 isdn_ext: addrbook 1. “Polycom Group Series Demo 2” h323_spd:384 h323_num:192.168.1.101 h323_ext:7878 addrbook 2. “Polycom Group Series Demo 3” sip_spd:384 sip_num:polycomgroupseries@polycom.com addrbook 3. “Polycom Group Series Demo 3” phone_num:1.512.5121212...
Page 116
0. name:"John Doe" sys_label:"" codec:1 h323_spd:384 h323_num:172.25.137.101 h323_ext: addrbook address name:"John Doe" sys_label:"" done Limitations None Comments As of release 6.0.0, this command is deprecated. Instead of this command, Polycom recommends using localdir. See Also See the gaddrbook command on page speeddial command on page 340.
Page 118
= transmit content frame rate rcfr = receive content frame rate tcpl = transmit content packet loss rcpl = receive content packet loss Limitations None Comments None See Also To return network statistics for a call, use the nearloop command. Polycom, Inc.
To register for events not included in this feedback, refer to the specific registration command. This is a one-time registration command that is retained in flash memory. Sending the command a second time results in the following feedback response: Polycom, Inc.
Page 120
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. Use the notify command for camera notifications.
The following types of parameters are unregistered: ● Current near-site or far-site source ● State of privacy ● Current volume level ● Active camera presets ● Status of point-to-point or multipoint calls ● IP connection to codec ● System information Polycom, Inc.
Turns on the AMX Device Discovery beacon. Turns off the AMX Device Discovery beacon. Feedback Examples ● amxdd get returns amxdd off ● amxdd on returns amxdd on Limitations None Comments The default setting for this signal is off. Polycom, Inc.
✓ video Answer Point-to-Point Video or Auto Answer Multipoint Video is set to No. Feedback Examples ● answer video returns answer incoming video call failed ● answer video returns answer incoming video call passed Limitations None Comments None Polycom, Inc.
Feedback Examples ● apiport get returns apiport 24 ● apiport 23 returns apiport 23 Limitations None Comments After sending the command to change the port, you must exit the current session and reconnect on the new port. Polycom, Inc.
When 3.5mm audio input is enabled for only the far site: ● Local playback is unavailable. ● You cannot use the mute button to control 3.5mm audio. ● The 3.5mm Audio Input option in the web interface is hidden. Polycom, Inc.
User Settings option in the local or web interface Prompts the user to answer incoming video is enabled. See the calls. Polycom RealPresence Group Series Notifies the user of incoming calls, but does donotdisturb Administrator Guide for not connect the call. The site that placed the more information.
Sets the system to not send content automatically. Feedback Examples ● autoshowcontent on returns autoshowcontent on ● autoshowcontent off returns autoshowcontent off ● autoshowcontent get returns autoshowcontent off Limitations None Comments None Polycom, Inc.
Accessible Additional Restrictions ✓ Returns the current setting. Enables diagnostic mode. Disables diagnostic mode. Feedback Examples ● basicmode on returns basicmode on ● basicmode off returns basicmode off ● basicmode get returns basicmode off Limitations None Comments None Polycom, Inc.
Simulates Polycom remote control buttons. Note: The button commands rely on the organization of the RealPresence Group Series local interface, which can vary depending on administrator settings. When possible, Polycom recommends using related API commands instead of the button commands.
Page 132
Sends the volume + button signal to the ✓ volume+ user interface. Feedback Examples ● button menu returns button menu ● button up sends the up arrow command to the user interface and returns button up Polycom, Inc.
Page 133
Use the camera command for camera control. Do not use the following commands for camera control: ● button left ● button right ● button down ● button up See Also To control the volume level and receive feedback about the system volume, use the volume command. Polycom, Inc.
● calendardiscovery emaildomain get returns calendardiscovery not available (if not configured or not found) ● calendardiscovery get returns error: command needs more parameters to execute successfully ● calendardiscovery returns error: command needs more parameters to execute successfully Limitations None Polycom, Inc.
Page 135
System Commands Comments None Polycom, Inc.
To enable or disable the calendaring service, use the calendarregisterwithserver command. To configure the Microsoft Exchange server address used by this service, use the calendarserver command. To set the resource mailbox to be monitored, use the calendarresource command. Polycom, Inc.
Retrieves meeting details for scheduled info meetings when the system is registered with the calendaring service. Returns information such as the location, subject and organizer of the meeting. The ID of the meeting for which you want to “meetingid” find details. Polycom, Inc.
Page 138
DI/G8AAAQ 2010-03-30:08:30|2010-03-30:09:00|dialable|public organizer|Russell Bell location|Russell's RMX Meeting Room - IP Video Number: 123456 (if registered to corp GK); 888-123-4567/978-123-4567 with passcode: #760900 subject|Bug Scrub dialingnumber|video|733397@vsgwstdma01.r13.vsg.local2|sip dialingnumber|video|733397|h323 dialingnumber|audio|48527 meetingpassword|none attendee|Russell Bell attendee|Rebecca Sharp calendarmeetings info end Polycom, Inc.
Page 139
AAAQ|2009-09-25:08:30|2009-09-25:09:15|private meeting calendarmeetings list end If a RealPresence Group Series system is configured to provide private meeting information on the web interface, the API provides the same information to the API client; for example: calendarmeetings list begin meeting|AAAZAGV4Y2H1C2VYMDFACJEZLNZZZY5SB2NHBDIARGAAAAAAKQKC8WW3CUWGCPM+AP66WQ...
Page 140
● CR (carriage return) ● LF (line feed) See Also To enable or disable the calendaring service, use the calendarregisterwithserver command. To configure the Microsoft Exchange Server address that is used by this service, use the calendarserver command. Polycom, Inc.
Comments The password is case-sensitive and can contain a maximum of 15 characters. Use strong passwords that combine uppercase and lowercase letters, numbers, and symbols. See Also To enable or disable the calendaring service, use the calendarregisterwithserver command. Polycom, Inc.
Gets the current setting for the alert tone. Enables the alert tone. Disables the alert tone. Feedback Examples ● calendarplaytone get returns calendarplaytone yes ● calendarplaytone yes returns calendarplaytone yes ● calendarplaytone no returns calendarplaytone no Limitations None Comments None See Also calendarremindertime command. Polycom, Inc.
Gets the current setting. ✓ ✓ Sets the connection protocol to automatic auto discovery. ✓ Sets the connection protocol to TLS. Feedback Examples ● calendarprotocol get returns calendarprotocol tls ● calendarprotocol auto returns calendarprotocol auto Limitations None Comments None Polycom, Inc.
Feedback Examples ● calendarregisterwithserver get returns calendarregisterwithserver no ● calendarregisterwithserver yes returns calendarregisterwithserver yes ● calendarregisterwithserver no returns calendarregisterwithserver no Limitations None Comments To configure the Microsoft Exchange Server address used by the calendaring service, use the calendarserver command. Polycom, Inc.
Feedback Examples ● calendarremindertime get returns calendarremindertime 5 ● calendarremindertime 15 returns calendarremindertime 15 ● calendarremindertime none returns calendarremindertime none Limitations None Comments None See Also Use the notify command to register for meeting reminders. See also calendarplaytone command. Polycom, Inc.
A resource can be a user mailbox or a resource mailbox. A resource mailbox is a mailbox specifically assigned to a meeting room. See Also Use the calendarregisterwithserver command to enable or disable the calendaring service. See the calendarserver command to configure the Microsoft Exchange Server address used by the calendaring service. Polycom, Inc.
192.168.44.168 ● calendarserver 192.168.23.221 returns calendarserver 192.168.23.221 ● calendarserver get returns calendarserver mail.exchangeserver.local.com ● calendarserver mail2.exchserver.local.com returns calendarserver mail2.exchserver.local.com Limitations None Comments None See Also Use the calendarregisterwithserver command to enable or disable the calendaring service. Polycom, Inc.
Gets the current setting for private meeting display. Enables the display of private meetings. Blocks the display of private meetings. Feedback Examples ● calendarshowpvtmeetings get returns calendarshowpvtmeetings no ● calendarshowpvtmeetings yes returns calendarshowpvtmeetings yes ● calendarshowpvtmeetings no returns calendarshowpvtmeetings no Limitations None Comments None Polycom, Inc.
Returns the Microsoft Exchange Server ✓ connection status. Feedback Examples ● calendarstatus get returns calendarstatus established ● calendarstatus get returns calendarstatus unavailable Limitations None Comments None See Also Use the calendarregisterwithserver command to enable or disable the calendaring service. Polycom, Inc.
The user name the calendaring service uses to username log in to the Microsoft Exchange Server. Feedback Examples ● calendaruser get returns calendaruser jpolycom Limitations None Comments None See Also See the calendarserver command to configure the Microsoft Exchange Server address used by this service. Polycom, Inc.
Returns information about the connection with ✓ callid the specified call ID. Feedback Examples ● callinfo all returns callinfo begin callinfo:43:Polycom Group Series Demo:192.168.1.101:384:connected: notmuted:outgoing:videocall callinfo:36:192.168.1.102:256:connected:muted:outgoing:videocall callinfo end ● callinfo callid 36 returns callinfo:36:192.168.1.102:256:connected:muted:outgoing:videocall ● callinfo all returns...
[384] After registering, the following response occurs when disconnecting an IP call: cleared: call[34] dialstr[IP:192.168.1.103 NAME:Polycom Group Series Demo] ended: call[34] Limitations None Comments None...
Page 153
System Commands See Also You can also use the notify command and the nonotify command for notifications. Polycom, Inc.
Valid directions are: left, right, up, down, zoom+, zoom-, and stop. ✓ Starts moving the camera left. left ✓ Starts moving the camera right. right ✓ Starts moving the camera up. ✓ Starts moving the camera down. down ✓ Starts zooming in. zoom+ Polycom, Inc.
Page 155
-50000 <= pan <= 50000 -50000 <= tilt <= 50000 -50000 <= zoom <= 50000 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 156
Director tracking feature. on turns the tracking <get|on|off> feature on, off turns the tracking feature off, and get returns the current tracking feature setting. Sets the video image of the Polycom EagleEye camerainvert IV camera to upside down ( ) or normal ( near Feedback Examples ●...
Page 157
As of release 4.1.1, the camera register and camera unregister commands are no longer available. Use the notify vidsourcechanges command instead. After using a camera command to move a Polycom EagleEye Producer or Polycom EagleEye Director camera, you must use the camera <near|far> stop command to update the camera position.
System Commands camera near tracking Enables or disables camera tracking for a Polycom EagleEye Director, EagleEye Director II, or EagleEye Producer camera. The camera near tracking get command returns one of the following values that corresponds to the product setting in use: ●...
Page 159
System Commands User Parameter Description Accessible Additional Restrictions ✓ Set the tracking mode for the Polycom mode EagleEye Producer or EagleEye Director camera. EagleEye Director: voice - Camera tracking that switches to room view before moving to the next speaker.
Page 160
30 ● cameraautohanguptimer off returns cameraautohanguptimer off ● cameraautohanguptimer 30 returns cameraautohanguptimer 30 ● cameratracking near mode get returns cameratracking near mode group when a Polycom EagleEye Director II or EagleEye Producer is attached to the system. Polycom, Inc.
Page 161
● cameratracking near pip off returns cameratracking near pip off when a Polycom EagleEye Director II is attached to the system. ● cameratracking near speed get returns cameratracking near speed normal ● cameratracking near speed slow...
Page 162
System Commands Limitations None Comments None Polycom, Inc.
Specifies that the video source is connected hdmi using HDMI. Available on camera 1 on Groups Series 700 systems. Available on cameras 2 and 3 on all RealPresence Group Series systems. ✓ Specifies that the video source is connected using VGA. Available on cameras 2 and 3 only.
Page 164
System Commands hdmi is available on camera 1 on Group Series 700 systems, and available on cameras 2 and 3 on all RealPresence Group systems. Comments None Polycom, Inc.
✓ 60hz1024x768p Sets the resolution to 1920x1080p, 60 Hz. ✓ 60hz1920x1080p ✓ Sets the resolution to 1920x1080i, 50 Hz. 50hz1920x1080i ✓ Sets the resolution to 1920x1080i, 60 Hz. 60hz1920x1080i ✓ Sets the resolution to 1920x1080p, 50 Hz. 50hz1920x1080p Polycom, Inc.
Page 166
● 50hz1280x720p ● 60hz1280x720p ● 50hz1920x1080i ● 60hz1920x1080i ● 50hz1920x1080p ● 60hz1920x1080p RealPresence Group 700 systems support HDMI, DVI, VGA and Component outputs. The following resolutions are available on Monitor 1. HDMI, DVI, and Component: ● 50hz1280x720p ● 60hz1280x720p Polycom, Inc.
Sets the Self View (PIP) to appear at the pip_bottom bottom of the monitor. ✓ Sets the Self View (PIP) to appear next to side_by_side far site or content. Sets the Self View (PIP) to appear full ✓ full_screen screen. Polycom, Inc.
Page 169
● configlayout monitor1 pip_right returns configlayout monitor1 pip_right Limitations None Comments The number of monitors, Self View setting, content, point-to-point, and multipoint calls all impact the layouts that are supported. Polycom, Inc.
<1|2|3|4> sharpness video input for motion or for sharpness (for images without motion). Feedback Examples ● configparam camera_video_quality 1 set motion returns camera1_video_quality motion ● configparam camera_video_quality 1 get returns camera1_video_quality sharpness Limitations None Comments None Polycom, Inc.
Selects content as the video source to display on the specified monitor. ✓ content-or-near Sets both near-site video and content as video sources to display on the specified monitor. ✓ far-content-near Sets available far-site content as video source to display on Monitor 1. Polycom, Inc.
Page 172
● configpresentation monitor1 near returns configpresentation monitor1 near failed Fails because monitor1 does not support the near profile. Limitations None Comments The monitor configurations and the number of monitors configured with your system determine the available monitor profiles. Polycom, Inc.
Disables automatic bandwidth adjustment for people and content. The system Quality Preference settings is used instead. Feedback Examples ● contentauto off returns contentauto off ● contentauto on returns contentauto on ● contentauto get returns contentauto on Limitations None Comments None Polycom, Inc.
Sets the default gateway when followed by the “xxx.xxx.xxx.xxx” parameter. IP address to use as the default gateway. “xxx.xxx.xxx.xxx” Feedback Examples ● defaultgateway set 192.168.1.101 returns defaultgateway 192.168.1.101 Limitations None Comments You can only change the defaultgateway setting if DHCP is turned off. Polycom, Inc.
IP address from a server on your network. Feedback Examples ● dhcp off returns dhcp off ● dhcp client returns dhcp client ● dhcp get returns dhcp client Limitations None Comments You must restart the system after making a change to a setting. Polycom, Inc.
Use dial manual without specifying a call type Call type ✓ h323|ip|sip|gateway Dials an audio call. This option Is ✓ phone supported only when the Enable Audio Add In call feature is enabled. Polycom, Inc.
Page 178
Description Accessible Additional Restrictions ✓ Dials an audio call using a connected sip_speakerphone Polycom IP 7000 conference phone. Numeric string specifying the phone ✓ “dialstring” number to dial. Enclose the string in quotation marks if it includes spaces. Example: “512 555 1212”...
Page 179
You can use callstate register or notify callstatus to obtain updated information on the status of a call. For example, when using dial manual to place a call, both registration commands will tell you when the call is connected. Refer to the callstate command and the notify command. Polycom, Inc.
Unique identifier associated with a site or ✓ “UID” group, for example: ldap#g#f82be96eea3bd644a1963dc7fdf45011 The complete UID must be specified Feedback Examples ● dial addressbook_entry ldap#g#35086aa0ecc9014facdcaa89bd34ccf6 returns dialing addressbook_entry ldap#g#35086aa0ecc9014facdcaa89bd34ccf6Comments Limitations None Comments The “UID” value must be retrieved by the globaldir command. Polycom, Inc.
Enables dial plan normalization. Disables dial plan normalization. Feedback Examples ● dialplannormalization on returns dialplannormalization on ● dialplannormalization get returns dialplannormalization on Limitations None Comments Dial plan normalization is available when your system is registered to Skype for Business. Polycom, Inc.
● dns set 1 192.168.1.205 returns dns 1 192.168.1.205 Limitations None Comments After making a change, you must restart the system for the setting to take effect. You cannot set these values if the system is in DHCP client mode. Polycom, Inc.
The system’s dynamic bandwidth function automatically finds the optimum line speed for a call. If you experience excessive packet loss while in a call, the dynamic bandwidth function decrements the line speed until there is no packet loss. This is supported in calls with endpoints that also support dynamic bandwidth. Polycom, Inc.
“e.164name”. A valid E.164 extension (usually a four-digit “e.164name” number). Feedback Examples ● e164ext set 7878 returns e164ext 7878 ● e164ext get returns e164ext 7878 Limitations None Comments The extension number is associated with a specific LAN device. Polycom, Inc.
Syntax echo <string> User Parameter Description Accessible Additional Restrictions Returns a string sent to the system. ✓ echo <string> Feedback Examples ● echo “Are you there?” returns Are you there? ● echo KA returns Limitations None Comments None Polycom, Inc.
Disables the echo canceller option. Feedback Examples ● echocanceller get returns echocanceller no Limitations The echocanceller command is not supported on RealPresence Group 300 and 310 systems. The echocanceller command is not supported on RealPresence Group 300 and 310 systems. Comments None Polycom, Inc.
● echoreply no returns echoreply no Limitations None Comments The number of responses may be traffic-conditioned to limit the effect of a denial of service attack. You must restart the system after making a change to a setting. Polycom, Inc.
System Commands enableaudioadd Enables or disables the Audio Add In feature, which allows one additional outbound, audio-only call from a RealPresence Group Series system when the maximum number of calls allowed for a license type has been reached. Syntax enableaudioadd <get|yes|no>...
Returns the current setting. Enables the firewall traversal feature. Disables the firewall traversal feature. Feedback Examples ● enablefirewalltraversal on returns enablefirewalltraversal on ● enablefirewalltraversal off returns enablefirewalltraversal off ● enablefirewalltraversal get returns enablefirewalltraversal off Limitations None Comments None Polycom, Inc.
Enables M-Mode. Disables M-Mode. Feedback Examples ● enablelivemusicmode yes returns enablelivemusicmode yes ● enablelivemusicmode no returns enablelivemusicmode no Limitations None Comments M-Mode was previously known as MusicMode. The feature functions the same way as before despite the name change. Polycom, Inc.
This command is supported when the following conditions are met: ● The Country system location setting for the RealPresence Group system supports the Phase Alternating Lines (PAL) video encoding system. ● The Advanced Video 1080p and Multipoint Video Conferencing software options are enabled. Polycom, Inc.
System Commands enablepvec Gets or sets the Polycom Video Error Concealment (PVEC) setting on the system. Syntax enablepvec <get|yes|no> User Parameter Description Accessible Additional Restrictions Returns the current setting. ✓ Enables the PVEC option. Disables the PVEC option. Feedback Examples ●...
Returns the current setting. Enables the RSVP option. Disables the RSVP option. Feedback Examples ● enablersvp yes returns enablersvp yes ● enablersvp no returns enablersvp no ● enablersvp get returns enablersvp no Limitations None Comments This option is enabled by default. Polycom, Inc.
Additional Restrictions Returns the current setting. Enables the SNMP option. Disables the SNMP option. Feedback Examples ● enablesnmp yes returns enablesnmp yes ● enablesnmp no returns enablesnmp no ● enablesnmp get returns enablesnmp no Limitations None Comments None Polycom, Inc.
Parameter Description Accessible Additional Restrictions ✓ Returns the current setting. Enables VSC. Disables VSC. Feedback Examples ● enablevisualsecurity get returns enablevisualsecurity off ● enablevisualsecurity on returns enablevisualsecurity on ● enablevisualsecurity off returns enablevisualsecurity off Limitations None Comments None Polycom, Inc.
Feedback Examples ● encryption yes returns encryption yes ● encryption no returns encryption no ● encryption get returns encryption no ● encryption requiredvideocallsonly returns encryption requiredvideocallsonly Polycom, Inc.
Page 200
● encryption requiredallcalls returns encryption requiredallcalls Limitations None Comments You cannot execute the encryption command while a call is in progress. Using this command while the system is in a call returns the following message: error: command has illegal parameters Polycom, Inc.
System Commands exit Ends the API command session. Syntax exit User Accessible Additional Restrictions None Feedback Examples ● exit returns Connection to host lost. Limitations None Comments For serial sessions, this command starts a new session. Polycom, Inc.
Page 203
The format of the exported directory 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 RealPresence Group Series software.
Page 204
When importing directory data back into the system, use the data in its entirety (not edited in any form). There is information that is used by the system to determine what type (XML or CSV) of data is being imported. See Also See the importdirectory command. Polycom, Inc.
User Accessible Additional Restrictions None Feedback Example ● exportprofile returns exportprofile started profileversion,0.2 system.info.eulafile,eula system.info.hardwareversion,9 system.info.humanreadablemodel,RealPresence Group 500 system.info.humanreadableplatform,GROUPSERIES system.info.humanreadableversion,Dev - 4.1.3-0 system.info.plcmstandardversion,Dev - 4.1.3-0 system.info.serialnumber,8213130FE433CV audio.lineIO.lineinechocanceller,"False" audio.volume.speakervolume,"46" comm.Firewall.fixedportstcphigh,"3241" comm.Firewall.fixedportsudphigh,"3301" comm.NICs.H323Nic.h323extension,"177704997" comm.NICs.H323Nic.h323name,"Group Series 177704997" comm.NICs.SipNic.bfcptransportprotocol,"Prefer_UDP" comm.NICs.SipNic.thirdpartyinterop.ocs.sipuuid,"d503b976-c62f-5484-82c0-64a479 18d1" comm.Qos.tos.tosaudio,"5" Polycom, Inc.
Page 206
The format of the exported directory 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 RealPresence Group Series software.
Page 207
System Commands See Also See the importprofile command. Polycom, Inc.
Allow Access to User Settings option in Disables far control of the near camera. the local or web interface is enabled. See the Polycom RealPresence Group Series Administrator Guide for more information. Feedback Examples ● farcontrolnearcamera yes...
Disables the name on a far site monitor. Feedback Examples ● farnametimedisplay get returns farnametimedisplay on ● farnametimedisplay on returns farnametimedisplay on ● farnametimedisplay off returns farnametimedisplay off Limitations None Comments The name will time out in 10 seconds after displayed. Polycom, Inc.
Returns entries beginning with the letter ✓ letter specified from the range {a..z}. Requires one or two alphanumeric characters. Valid characters are: - _ / ; @ , . \ 0 through 9 a through z Polycom, Inc.
Page 211
If range_end is -1, all entries starting with range_start will be returned. Note that the LDAP server will limit the maximum number of entries that may be returned. Polycom, Inc.
Page 212
The search looks for a match at the beginning of any of these attributes: first name, last name, display/friendly name, or room name. The response is similar to the group command: gaddrbook search {0..n}. name:"sys_name" sys_label:"sys_label" sys_id:"sys_id_string" phone_num:"phone_num" type:<video|multicodec|phone> gaddrbook names search "search_pattern" done Polycom, Inc.
Page 213
The response is similar to the group command: gaddrbook search {0..n}. name:"sys_name" sys_label:"sys_label" sys_id:"sys_id_string" phone_num:"phone_num" type:<video|multicodec|phone> ✓ Specifies the string pattern for which to search_patt search. Wildcard characters are not supported. Polycom, Inc.
Page 214
The response is in the following format: gaddrbook address {0..n}. sys_id:"sys_id" h323_spd:"h323_spd" h323_num:"h323_num" h323_ext:"h323_ext" gaddrbook address {0..n}. sys_id:"sys_id" sip_spd:"sip_spd" sip_num:"sip_num" gaddrbook address {0..n}. sys_id:"sys_id" xmpp:xmpp_addr gaddrbook address {0..n}. sys_id:"sys_id" isdn_spd:"isdn_spd" isdn_num:"isdn_num" isdn_ext:"isdn_ext" gaddrbook address "sys_id_string" done Polycom, Inc.
Page 215
If no speed is associated with the entry, then the value of the configuration variable "globaladdrmaxh323" is returned. The default is 384. For LDAP entries systems currently do not ✓ h323_num use this field. It is always blank. Polycom, Inc.
Page 216
ID (JID). For LDAP this is the H.350.7 XmppIdentityURI attribute. Feedback Examples ● gaddrbook all returns gaddrbook 0. “Polycom Group Series Demo 1” isdn_spd:384 isdn_num:1.700.5551212 isdn_ext: gaddrbook 1. “Polycom Group Series Demo 2” h323_spd:384 h323_num:192.168.1.101 h323_ext:7878 gaddrbook 2. “Polycom Group Series Demo 3” sip_spd:384 sip_num:polycomgroupseries@polycom.com...
Page 217
System Commands ● gaddrbook batch define 0 2 returns gaddrbook 0. “Polycom Group Series Demo 1” isdn_spd:384 isdn_num:1.700.5551212 isdn_ext: gaddrbook 1. “Polycom Group Series Demo 2” h323_spd:384 h323_num:192.168.1.101 h323_ext:7878 gaddrbook 2. “Polycom Group Series Demo 3” sip_spd:384 sip_num:polycomgroupseries@polycom.com gaddrbook batch define 0 2 done ●...
Page 219
“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 220
System Commands See Also See the addrbook command. See the globaldir command. Polycom, Inc.
“xxx.xxx.xxx.xxx”. IP address of the gatekeeper. “xxx.xxx.xxx.xxx” Feedback Examples ● gatekeeperip set 192.168.1.205 returns gatekeeperip 192.168.1.205 ● gatekeeperip get returns gatekeeperip 192.168.1.205 Limitations None Comments gatekeeperip get command feedback may include the port number after the IP address. Polycom, Inc.
System Commands gdsdirectory Gets or sets options for the Polycom Global Directory Service (GDS). Syntax gdsdirectory <get|on|off|status> User Parameter Description Accessible Additional Restrictions Returns the current setting. ✓ ✓ Enables GDS registration. ✓ Disables GDS registration. ✓ Returns the current GDS status registration status.
System Commands gdspassword Sets the password for Polycom GDS registration. Syntax gdspassword set <“password”> User Parameter Description Accessible Additional Restrictions Sets the GDS registration ✓ password. ✓ The GDS password when using the “password” set command. Feedback Examples ● gdspassowrd set “polycomuser 01”...
Specifies the IP address. ✓ IP address to use with set “ipaddress” command. Feedback Examples ● gdsserverip get returns gdsserverip 192.168.1.1 ● gdsserverip set 192.168.1.1 returns gdsserverip 192.168.1.1 Limitations None Comments The gdsserverip command is supported only when H.323 is enabled. Polycom, Inc.
Generates the DTMF tone corresponding to a ✓ telephone * button. Feedback Examples ● gendial 2 returns gendial 2 and causes the system to produce the DTMF tone corresponding to a telephone’s 2 button Limitations None Comments None Polycom, Inc.
✓ Sets DTMF tones for both in band and out of both band. Feedback Examples ● gendialset get returns gendialset inband ● gendialset both returns gendialset both ● gendialset outofband returns gendialset outofband Limitations None Comments None Polycom, Inc.
Turns off the test tone. Feedback Examples ● generatetone on returns generatetone on and the system produces a test tone ● generatetone off returns generatetone off and the system stops producing a test tone Limitations None Comments None Polycom, Inc.
Feedback Examples ● getcallstate returns cs: call[34] speed[384] dialstr[192.168.1.101] state[connected] cs: call[1] inactive cs: call[2] inactive Limitations None Comments None See Also To register the shell session to receive notifications about call state activities, see the callstate command. Polycom, Inc.
● If the IP address is set manually the configured IP address is returned, regardless of whether the LAN connection is currently active. ● If the IP address is obtained automatically, the currently-assigned address is returned, or 0.0.0.0 is returned if there is no active connection. Polycom, Inc.
System Commands globaldir Retrieves global directory entries. Polycom recommends that you use this command for the Global Directory. This command supports all global directory types, including GDS, Skype for Business, and LDAP. Syntax globaldir “search_string” globaldir “search_string” “size” globaldir entry “UID”...
Page 234
Multi-tiered directory commands are supported only when using the LDAP function of RealPresence Resource Manager configured for multitiered directory. Using multitiered directory commands on a system that does not support multitiered directory returns the following message: error: command not supported in current configuration Polycom, Inc.
Returns the current setting. Enables H.239 People+Content on the system. Disables H.239 People+Content on the system. Feedback Examples ● h239enable yes returns h239enable yes ● h239enable no returns h239enable no ● h239enable get returns h239enable no Limitations None Comments None Polycom, Inc.
Additional Restrictions Returns the current H.323 name. The H.323 name to use to identify the system. True Feedback Examples ● h323authenticate name get returns h323authenticate name Administrator ● h323authenticate name Administrator returns h323authenticate name Administrator Limitations None Comments None Polycom, Inc.
Sets the password for H.323 authentication. Syntax h323authenticate password set “password” User Parameter Description Accessible Additional Restrictions Password to use for H.323 authentication. “password” Feedback Examples ● h323authenticate password set Polycom returns h323authenticate password accepted Limitations None Comments None Polycom, Inc.
For example: “RealPresence Group Series Demo” Feedback Examples ● h323name set My returns h323name my ● h323name set “RealPresence Group Series Demo” returns h323name “RealPresence Group Series Demo” ● h323name get returns h323name “RealPresence Group Series Demo” Limitations...
● If callstate register is used for notifications, hangup video 42 returns hanging up video cleared: call[42] dialstring[IP:192.168.1.101 NAME:RealPresence Group Series Demo] ended: call[42] and disconnects the specified site, leaving other sites connected Limitations None Comments After sending the hangup command, if registered for notification, the feedback response will notify that the call has ended.
Feedback Examples ● hostname set returns hostname ADMIN ● hostname set “My” returns hostname My ● hostname get returns hostname My Polycom, Inc.
Page 242
System Commands Limitations None Comments A LAN host name is required; it cannot be deleted or left blank. After making a change, you must restart the system for the setting to take effect. Polycom, Inc.
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 User Accessible Additional Restrictions None Polycom, Inc.
Page 247
API session. All previous data entered is ignored. Attempts to export and import directory information between different systems might fail. The message import failed indicates that the system was not able to import the information. See Also See the exportdirectory command. Polycom, Inc.
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> <import data line 3> . . . importcomplete User Accessible Additional Restrictions None Polycom, Inc.
Page 250
Exporting a profile on one system model and importing the profile on another model is not supported. Attempts to export and import profile information between different systems might also fail. The message importprofile failed indicates that the system was not able to import the information. See Also See the exportprofile command. Polycom, Inc.
● ipaddress get returns ipaddress 192.168.1.101 Limitations None Comments Use this command when you need to allocate a static IP address to your system. After making a change, you must restart the system for the setting to take effect. Polycom, Inc.
Feedback Examples ● lanport auto returns lanport auto restart system for changes to take effect. restart now? <y,n> ● lanport get returns lanport auto Limitations None Comments After making a change, you are prompted to restart the system. Polycom, Inc.
Sets the authentication type of an LDAP server. Note: This parameter does not change the setting on the server. Instead, this parameter changes how the Polycom system recognizes the server. Specifies “anonymous” as the authentication anonymous type of an LDAP server.
“base dn” parameter. Note: This parameter does not change the setting on the server. Instead, this parameter changes how the Polycom system recognizes the server. Specifies the base DN of an LDAP server. “base dn”...
Authentication. To erase the current setting, omit the “bind dn” parameter. Note: This parameter does not change the setting on the server. Instead, this parameter changes how the Polycom system recognizes the server. Specifies the bind DN of an LDAP server. “bind dn”...
Page 256
System Commands Limitations None Comments None Polycom, Inc.
Limitations None 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. If the Polycom GDS directory server and another directory server are defined on the system, the Polycom GDS directory server becomes the default directory server after upgrading the system software.
“domain” parameter. Note: This parameter does not change the setting on the server. Instead, this parameter changes how the Polycom system recognizes the server. Specifies the domain in which authentication “domain” takes place in the Active Directory server.
LDAP server. To erase the current setting, omit the “password” parameter. Note: This parameter does not change the setting on the server. Instead, this parameter changes how the Polycom system recognizes the server. Specifies setting the password for NTLM ntlm authentication of an LDAP server.
LDAP server. To erase the current setting, omit the “address” parameter. Note: This parameter does not change the setting on the server. Instead, this parameter changes how the Polycom system recognizes the server. Specifies the IP address or the DNS name of “address”...
“port number” parameter. Note: This parameter does not change the setting on the server. Instead, this parameter changes how the Polycom system recognizes the server. Specifies the port number of an LDAP server. “port number”...
Sets the SSL encryption state for LDAP operations. Note: This parameter does not change the setting on the server. Instead, this parameter changes how the Polycom system recognizes the server. Specifies “on” as the encryption state for LDAP operations. This is the default setting.
LDAP server. To erase the current setting, omit the “user name” parameter. Note: This parameter does not change the setting on the server. Instead, this parameter changes how the Polycom system recognizes the server. Specifies the user name for NTLM “user name”...
When this event occurs, the message “listen going to sleep” is received. When the system wakes up, the message “listen waking up” is received. Deprecated. Polycom recommends using sleep register instead of this command. Feedback Examples ●...
✓ Retrieves a list of sites and groups in the grouplist<UID> specified group. ✓ Retrieves directories that match the string grouplist<UID> inside of the specified group. <search string> ✓ Returns directory entries in the range range specified. Polycom, Inc.
Feedback Examples ● loglevel get returns loglevel info ● loglevel set warning returns loglevel warning ● loglevel set error returns loglevel error Limitations None Comments logs the fewest number of messages. warning Polycom, Inc.
Page 269
System Commands Polycom recommends leaving this setting at the default value of debug. Polycom, Inc.
Feedback Examples ● lyncdirectory get returns lyncdirectory off ● lyncdirectory on returns lyncdirectory on ● lyncdirectory off returns lyncdirectory off ● lyncdirectory status returns lyncdirectory online Limitations None Comments You can enable only one directory service at a time Polycom, Inc.
Limitations None Comments When the time has expired in a call, a message asks you if you want to hang up or stay in the call. If you do not answer within one minute, the call automatically disconnects. Polycom, Inc.
● monitor1screensaveroutput black returns monitor1screensaveroutput black ● monitor1screensaveroutput no_signal returns monitor1screensaveroutput no_signal ● monitor1screensaveroutput get returns monitor1screensaveroutput no_signal Limitations None Comments Setting Monitor 1 automatically sets Monitor 2 to the same setting. See Also See the monitor2screensaveroutput command. Polycom, Inc.
● monitor2screensaveroutput get returns monitor2screensaveroutput no_signal Limitations The monitor2screensaveroutput command is not supported on RealPresence Group 300 and 310 systems. Comments Setting Monitor 2 automatically sets Monitor 1 to the same setting. See Also See the monitor1screensaveroutput command. Polycom, Inc.
See the call. If the user selects Yes, the call is added Polycom RealPresence to the ongoing conference. If the user Group Series selects No, the call is rejected. The default is Administrator Guide for more information.
Page 275
System Commands Limitations The mpautoanswer command is not supported on RealPresence Group 300 and 310 systems. Comments If mpautoanswer is set to no or donotdisturb, you must rely on API session notifications to answer inbound calls. Polycom, Inc.
In Full Screen mode, every site in the call sees ✓ fullscreen the current speaker, or the latest person to speak, on the full screen. Feedback Examples ● mpmode auto returns mpmode auto ● mpmode discussion returns mpmode discussion ● mpmode get returns mpmode discussion Limitations None Polycom, Inc.
Page 277
This option is not available unless the multipoint option is enabled. What you see during a multipoint call can depend on many factors such as the system’s monitor configuration, the number of sites in the call, whether content is shared, and whether dual monitor emulation is used. Polycom, Inc.
Returns the mute state of the far site system. Requires the parameter get. Feedback Examples ● mute register returns mute registered ● mute near on returns mute near on ● mute far get returns mute far off Limitations None Polycom, Inc.
Page 279
System Commands Comments In register mode, the system sends notification to the API session when the far or near site is muted or unmuted. Polycom, Inc.
Disables Mute Auto Answer Calls mode. The the local or web interface microphone will not be muted when the is enabled. See the system receives a call while in Auto Answer Polycom RealPresence mode. Group Series Administrator Guide for more information.
Disables the option when the system is not behind a NAT. Feedback Examples ● natconfig auto returns natconfig auto ● natconfig manual returns natconfig manual ● natconfig off returns natconfig off ● natconfig get returns natconfig off Limitations None Comments None Polycom, Inc.
Specifies that NAT is capable of translating H.323 traffic. Specifies that NAT is not capable of translating H.323 traffic. Feedback Examples ● nath323compatible yes returns nath323compatible yes ● nath323compatible no returns nath323compatible no ● nath323compatible get returns nath323compatible no Limitations None Comments None Polycom, Inc.
● nearloop on returns nearloop on ● nearloop off returns nearloop off Limitations None Comments When Near End Loop is on, you can test the encoder/decoder on the system. This test is not available when you are in a call. Polycom, Inc.
= receive content format Limitations None Comments Both pktloss and %pktloss report only numbers related to packet loss on the transmit. These numbers are not affected by packet loss on the Real-time Transport Protocol (RTP) that is received. Polycom, Inc.
Page 285
System Commands The number listed for %pktloss is not cumulative and is calculated every 5 seconds. The number listed for pktloss is calculated every 5 seconds and is cumulative. Polycom, Inc.
<call id>:<line id>:<channel id>: <connection status> ✓ Registers the system to receive changes in mutestatus audio mute status in the following format: notification:mutestatus:<near or far>:<call id>:<site name>:<site number>:<mute status> Polycom, Inc.
Page 289
● notify returns registered for 2 notifications:callstatus:mutestatus ● notify calendarmeetings returns notify calendarmeetings success The following are examples of notifications that may be returned after registering to receive them. ● notification:callstatus:outgoing:34:Polycom Group Series Demo:192.168.1.101:connected:384:0:videocall Polycom, Inc.
Page 290
RS-232 session with the same system. Duplicate registrations produce another success response. The notify setting remains in effect, even if you restart the system or update the software with system settings saved. See Also See also the nonotify command and the callinfo command. Polycom, Inc.
NTP server address. Feedback Examples ● ntpmode get returns ntpmode manual ● ntpmode auto returns ntpmode auto ● ntpmode off returns ntpmode off ● ntpmode manual returns ntpmode manual Limitations None Comments None Polycom, Inc.
Feedback Examples ● ntpsecondaryserver get returns ntpsecondaryserver 172.26.44.22 ● ntpsecondaryserver set returns ntpsecondaryserver “” ● ntpsecondaryserver set 172.26.44.22 returns ntpsecondaryserver 172.26.44.22 Limitations None Comments You must first set the ntpmode command to manual before using the ntpsecondaryserver command. Polycom, Inc.
Feedback Examples ● ntpserver get returns ntpserver 192.168.1.205 ● ntpserver set returns ntpserver <empty> ● ntpserver set 192.168.1.205 returns ntpserver 192.168.1.205 Limitations None Comments You must first set the ntpmode command to manual before using the ntpserver command. Polycom, Inc.
User Accessible Feedback Examples ● oobcomplete returns oobcomplete Limitations None Comments The oobcomplete command is processed only when the Polycom system is in setup wizard mode. To execute oobcomplete successfully, the Polycom system name must be configured. Polycom, Inc.
None Comments The powerdown command does not prompt the user to confirm and turns off the system with no other feedback returned. After the system turns off, it cannot be restarted remotely. The system must be restarted manually. Polycom, Inc.
● popupinfo: choice0: Ok is returned if a call fails ● popupinfo: question: Save Changes? popupinfo: choice0: Yes popupinfo: choice1: No popupinfo: answered: Yes is returned if the user edits the password field Limitations None Comments None Polycom, Inc.
● preset near go 1 returns preset near go 1 and moves the near-site camera to the preset 1 position ● preset near set 2 returns preset near set 2 and saves the current location/position of the near-site camera as preset 2 Polycom, Inc.
Page 298
System Commands Comments Up to 100 preset camera positions can be set. These camera presets can be distributed across the far camera and up to four near-site cameras. Polycom, Inc.
Sets the IP address of the provisioning server. ✓ Specifies the IP address to use when using the “Server command. Address” Feedback Examples ● provisionserveraddress get returns provisionserveraddress 10.223.15.152 ● provisionserveraddress set 192.168.1.1 returns provisionserveraddress 192.168.1.1 Limitations None Comments None Polycom, Inc.
Sets the domain name of the provisioning server. ✓ Specifies the domain name for the provisioning “Server server address when using the command. Address” Feedback Examples ● provisionserverdomain get returns provisionserverdomain Polycom ● provisionserverdomain set corporate1 returns provisionserverdomain corporate1 Limitations None Comments None Polycom, Inc.
“password” server when using the command. Feedback Examples ● provisionserverpassword set “Polycom01” returns provisionserverpassword accepted ● provisionserverpassword set Pcom 01 returns error: command has illegal parameters. ● provisionserverpassword set “Pcom 01” returns provisionserverpassword accepted Limitations None Comments None Polycom, Inc.
Gets the current status of the provisioning server. Syntax provisionserverstatus <get> User Parameter Description Accessible Additional Restrictions Returns the current status of the provisioning ✓ server. Feedback Examples ● provisionserverstatus get returns provisionserverstatus registered ● provisionserverstatus get returns provisionserverstatus unregistered Limitations None Comments None Polycom, Inc.
Sets the provisioning server type to RealPresence Resource Manager. ✓ Sets the provisioning server type to DMS. Feedback Examples ● provisionservertype get returns provisionservertype rpm ● provisionservertype dms returns provisionservertype dms ● provisionservertype rpm returns provisionservertype rpm Limitations None Comments None Polycom, Inc.
✓ Specifies the user name for the provisioning “User Name” server when using the set command. Feedback Examples ● provisionserveruser get returns provisionserveruser John Smith ● provisionserveruser set Harry Thomas returns provisionserveruser Harry Thomas Limitations None Comments None Polycom, Inc.
Restrictions restarts the system without prompting you. ✓ Feedback Examples ● reboot now does not prompt the user to confirm and restarts the system with no other feedback returned. Limitations None Comments The preferred format is reboot now. Polycom, Inc.
System Commands remotemonenable Gets the state of remote room and call monitoring. Syntax remotemonenable <get> User Accessible Additional Restrictions None Feedback Examples ● remotemonenable get returns remotemonenable on ● remotemonenable get returns remotemonenable off Limitations None Comments None Polycom, Inc.
Deletes all local directory entries from deletelocaldirectory the address book. Deletes the CDR file from the deletecdr /opt/polycom/cdr directory after copying the contents of the file to the trace log. Deletes the system logs. deletelogs Deletes all certificates from the deletecertificates system.
Page 311
System Commands ● resetsystem deletecertificates returns resetsystem deletecertificates Limitations None Comments None Polycom, Inc.
Sets the RS-232 port to Camera PTZ mode. camera_ptz Sets the RS-232 port to Closed Caption mode. closed_caption Feedback Examples ● rs232 mode control returns rs232 mode control ● rs232port1 mode closed_caption returns rs232port1 mode closed_caption Limitations None Comments None Polycom, Inc.
✓ Sets the serial port login requirement to use pwuser both admin and user passwords. Feedback Examples ● rs232login get returns rs232login off ● rs232login pwonly returns rs232login pwonly Limitations None Comments None Polycom, Inc.
● screen returns screen: adminsettings if the Admin Settings screen is currently displayed in the user interface ● screen register returns screen registered ● screen monitors returns screen: monitors and displays the Monitors screen in the user interface Polycom, Inc.
Page 316
System Commands Limitations None Comments Only a small number of user interface screens are available using this command. Polycom, Inc.
System Commands serialnum Returns the serial number of the system. Syntax serialnum User Accessible Additional Restrictions None Feedback Examples ● serialnum returns serialnum 82065205E72E1 Limitations None Comments None Polycom, Inc.
System Commands setpassword Sets the admin password for the Polycom system local admin account. Syntax setpassword admin room "currentacctpasswd" "newacctpasswd" User Parameter Description Accessible Additional Restrictions Specifies the Polycom system local admin admin account. Changes the room password. room The current account password.
Feedback Examples ● sleep returns sleep This command puts the system into sleep mode. ● sleep register returns sleep registered ● If entered again, sleep register returns info: event/notification already active:sleep ● sleep unregister returns sleep unregistered Polycom, Inc.
Page 321
System Commands ● If entered again, sleep unregister returns info: event/notification not active:sleep ● sleep mute get returns sleep mute off ● sleep mute on returns sleep mute on Limitations None Comments None See Also None Polycom, Inc.
60|120|240|480 The default value is 3. A value of 0 indicates that the system will never go to sleep. Feedback Examples ● sleeptime 30 returns sleeptime 30 Limitations None Comments None Polycom, Inc.
● snmpadmin set “John Admin” returns snmpadmin “John Admin” ● snmpadmin set returns error: command needs more parameters to execute successfully Limitations None Comments After making a change, you must restart the system for the setting to take effect. Polycom, Inc.
Feedback Examples ● snmpcommunity set returns snmpcommunity <empty> ● snmpcommunity set Public returns snmpcommunity Public ● snmpcommunity get returns snmpcommunity Public Limitations None Comments After making a change, you must restart the system for the setting to take effect. Polycom, Inc.
Feedback Examples ● snmpconsoleip set returns snmpconsoleip <empty> ● snmpconsoleip set 192.168.1.111 returns snmpconsoleip 192.168.1.111 ● snmpconsoleip get returns snmpconsoleip 192.168.1.111 Limitations None Comments After making a change, you must restart the system for the setting to take effect. Polycom, Inc.
● snmplocation set “Mary_Polycom in United States” returns snmplocation “Mary_Polycom in United States” ● snmplocation get returns snmplocation “Mary_Polycom in United States” Limitations None Comments You must restart the system after making a change to the SNMP setting. Polycom, Inc.
System Commands snmpnotification Enables or disables SNMP notifications for the Polycom MIB, which can be downloaded from the SNMP page of the system web interface. Syntax snmpnotification <get|true|false> User Parameter Description Accessible Additional Restrictions Returns the current setting for SNMP notifications.
● snmpsystemdescription set returns snmpsystemdescription <empty> ● snmpsystemdescription set “videoconferencing system” returns snmpsystemdescription “videoconferencing system” ● snmpsystemdescription get returns snmpsystemdescription “videoconferencing system” Limitations None Comments After making a change, you must restart the system for the setting to take effect. Polycom, Inc.
SNMP trap version 1, 2c, or 3. v1|v2c|v3 Feedback Examples ● snmptrapversion get returns snmptrapversion v2c ● snmptrapversion set v3 returns snmptrapversion v3 Limitations None Comments After making a change, you must restart the system for the setting to take effect. Polycom, Inc.
The response is returned in the following format: speeddial names <all|video|phone> size {0..n} For the names and group commands, specifies ✓ range_start the beginning of the range of entries to return. Polycom, Inc.
Page 332
If those systems are of the same type, such as all RealPresence Group Series systems, the client considers that entry to be a telepresence system with multiple codecs rather than separate systems.
Page 333
The preferred speed for a SIP call to this entry. ✓ sip_spd If no speed is associated with the entry, then this is the same as the h323_spd. ✓ SIP address. sip_num ✓ XMPP address, also known as the Jabber ID xmpp_addr (JID). Polycom, Inc.
Page 334
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 CMA Desktop.
Page 335
System Commands See Also See the addrbook command and the gaddrbook command. Polycom, Inc.
Subnet mask of the system. “xxx.xxx.xxx.x xx” Feedback Examples ● subnetmask set 255.255.255.0 returns subnetmask 255.255.255.0 ● subnetmask get returns subnetmask 255.255.255.0 Limitations None Comments After making a change, you must restart the system for the setting to take effect. Polycom, Inc.
“system name” Enclose the string in quotation marks if it includes spaces. Example: “Polycom Group Series Demo” Feedback Examples ● systemname set “RealPresence Group Series Demo” returns systemname “RealPresence Group Series Demo” ● systemname set get returns systemname “RealPresence Group Series Demo”...
Prefer_TCP ● systemsetting get bfcptransportprotocol returns systemsetting bfcptransportprotocol Prefer_TCP ● systemsetting bfcptransportprotocol UDP_Only returns systemsetting bfcptransportprotocol UDP_Only Limitations None Comments The BFCP Transport Protocol in which your system is operating determines which protocol is required. Polycom, Inc.
● systemsetting cameracontent People returns systemsetting cameracontent People ● systemsetting cameracontent Content returns systemsetting cameracontent Content ● systemsetting get cameracontent returns systemsetting cameracontent Content Limitations Command is not supported on RealPresence Group 300 and 310 systems. Comments None Polycom, Inc.
● systemsetting cameracontent1 People returns systemsetting cameracontent1 People ● systemsetting cameracontent1 Content returns systemsetting cameracontent1 Content ● systemsetting get cameracontent1 returns systemsetting cameracontent1 Content Limitations Command is not supported on RealPresence Group 300 and 310 systems. Comments None Polycom, Inc.
● systemsetting cameracontent2 People returns systemsetting cameracontent2 People ● systemsetting cameracontent2 Content returns systemsetting cameracontent2 Content ● systemsetting get cameracontent2 returns systemsetting cameracontent2 Content Limitations Command is not supported on RealPresence Group 300, 310, and 500 systems. Comments None Polycom, Inc.
● systemsetting cameracontent3 People returns systemsetting cameracontent3 People ● systemsetting cameracontent3 content returns systemsetting cameracontent3 Content ● systemsetting get cameracontent3 returns systemsetting cameracontent3 People Limitations Command is not supported on RealPresence Group 300, 310, and 500 systems. Comments None Polycom, Inc.
Sets Video as the preferred call choice before VIDEO_THEN_AUD Audio calls. Sets Audio as the preferred call choice before AUDIO_THEN_VID Video calls. Feedback Examples ● systemsetting connectionpreference VIDEO_THEN_AUDIO returns systemsetting connectionpreference VIDEO_THEN_AUDIO ● systemsetting get connectionpreference returns systemsetting connectionpreference VIDEO_THEN_AUDIO Limitations None Comments None Polycom, Inc.
Manual prompts the user to select the call type from a list when placing a call. Feedback Examples ● systemsetting dialingmethod Auto returns systemsetting dialingmethod Auto ● systemsetting get dialingmethod returns systemsetting dialingmethod Auto Limitations None Comments None Polycom, Inc.
Specifies to not display the icons on the info False bar while in a call. Feedback Examples ● systemsetting displayiconsincall True returns systemsetting displayiconsincall True ● systemsetting get displayiconsincall returns systemsetting displayiconsincall True Limitations None Comments None Polycom, Inc.
System Commands systemsetting enablepolycommics Gets or specifies whether the Polycom C-Link 2 microphone arrays attached to the system are enabled. Syntax systemsetting enablepolycommics <True|False> systemsetting get enablepolycommics User Parameter Description Accessible Additional Restrictions Returns the current setting. Enables Polycom microphones.
● systemsetting get gatewaynumbertype returns systemsetting gatewaynumbertype ipaddress Limitations None Comments Setting the ISDN Gateway number type does not require a set parameter. For example, entering the command systemsetting gatewaynumbertype e.164 sets the number type to e.164. Polycom, Inc.
Enables debug logs for large Skype for True Business conference calls. Disables debug logs for large Skype for False Business conference calls. Feedback Examples ● systemsetting largeconfdebug True returns systemsetting largeconfdebug True ● systemsetting get largeconfdebug returns systemsetting largeconfdebug True Limitations None Comments None Polycom, Inc.
0 to 10. Feedback Examples ● systemsetting lineinlevel 5 returns systemsetting lineinlevel 5 ● systemsetting get lineinlevel returns systemsetting lineinlevel 5 Limitations The systemsetting lineinlevel command is not supported on RealPresence Group 300, 310, and 500 systems. Comments None Polycom, Inc.
Feedback Examples ● systemsetting lineoutmode fixed returns systemsetting lineoutmode fixed ● systemsetting get lineoutmode returns systemsetting lineoutmode fixed Limitations The systemsetting lineoutmode command is not supported on RealPresence Group 300, 310, and 500 systems. Comments None Polycom, Inc.
Feedback Examples ● systemsetting mediainlevel 5 returns systemsetting mediainlevel 5 ● systemsetting get mediainlevel returns systemsetting mediainlevel 5 Limitations The systemsetting mediainlevel command is not supported on RealPresence Group 300, 310, and 500 systems. Comments None Polycom, Inc.
Returns the model of the system. Syntax systemsetting get model User Parameter Description Accessible Additional Restrictions ✓ Returns the current setting. Feedback Examples ● systemsetting get model returns systemsetting model “RealPresence Group 700” Limitations None Comments None Polycom, Inc.
Sets the specified input as the primary camera 1..4 (numbering convention matches the numbering in the on-screen user interface). Camera 3 and Camera 4 are available on Polycom RealPresence Group 700 systems only. Feedback Examples ● systemsetting primarycamera 1 returns systemsetting primarycamera 1 ●...
Returns the current setting. Sets the channel ID to be used with the remote 0..15 control. Feedback Examples ● systemsetting remotechannelid 7 returns systemsetting remotechannelid 7 ● systemsetting get remotechannelid returns systemsetting remotechannelid 7 Limitations None Comments None Polycom, Inc.
✓ Sets self-view to auto mode. auto Feedback Examples ● systemsetting selfview on returns systemsetting selfview on ● systemsetting selfview off returns systemsetting selfview off ● systemsetting get selfview returns systemsetting selfview on Limitations None Comments None Polycom, Inc.
Address of the proxy server. Format can be address either an actual IP address or a valid DNS hostname (PQP or FQP). Feedback Examples ● systemsetting sipproxyserver pserver.abc.com returns systemsetting sipproxyserver pserver.abc.com ● systemsetting get sipproxyserver returns systemsetting ipproxyserver pserver.abc.com Limitations None Comments None Polycom, Inc.
Address of the registrar server. Format can be address either an actual IP address or a valid DNS hostname (PQP or FQP). Feedback Examples ● systemsetting sipregistrarserver pserver.abc.com returns systemsetting sipregistrarserver pserver.abc.com ● systemsetting get sipregistrarserver returns systemsetting sipregistrarserver pserver.abc.com Limitations None Comments None Polycom, Inc.
System Commands systemsetting stereoenable Gets the current setting or specifies whether Polycom StereoSurround is used for all calls. Syntax systemsetting stereoenable <True|False> systemsetting get stereoenable User Parameter Description Accessible Additional Restrictions ✓ Returns the current setting. Enables Polycom stereo. True Disables Polycom stereo.
● systemsetting telnetenabled True returns systemsetting telnetenabled True ● systemsetting telnetenabled returns error: command needs more parameters to execute successfully Limitations None Comments After making a change, you must restart the system for the setting to take effect. Polycom, Inc.
System Commands systemsetting uspairingenabled Gets the current setting or detects and unpairs a RealPresence Group Series system from the ® RealPresence Mobile application on an Apple iPad tablet. Syntax systemsetting uspairingenabled <Disabled|Manual|Auto> systemsetting get uspairingenabled User Parameter Description Accessible Additional Restrictions ✓...
Enables remote access from the web interface. True Disables remote access from the web False interface. Feedback Examples ● systemsetting webenabled True returns systemsetting webenabled True ● systemsetting get webenabled returns systemsetting webenabled True Limitations None Comments None Polycom, Inc.
System Commands systemsetting whitebalancemode Gets or sets the user white balance mode for a Polycom camera on Camera port 1. Syntax systemsetting whitebalancemode <Auto|Manual|3200K|3680K|4160K|4640K|5120K|5600K> systemsetting get whitebalancemode User Parameter Description Accessible Additional Restrictions Returns the current setting. Auto - Automatic white balance...
System Commands systemsetting whitebalancemode1 Gets or sets the user white balance mode for a Polycom camera on Camera port 2. Syntax systemsetting whitebalancemode1 <Auto|Manual|3200K|3680K|4160K|4640K|5120K|5600K> systemsetting get whitebalancemode1 User Parameter Description Accessible Additional Restrictions Returns the current setting. Auto - Automatic white balance <Auto|Manual|3200K|3680K...
System Commands uptime Returns the total time the RealPresence Group Series system has been running since the last system start. Syntax uptime get User Parameter Description Accessible Additional Restrictions Returns the current setting. ✓ Feedback Example ● uptime get returns...
Sets the system to automatically find an auto available gatekeeper. Feedback Examples ● usegatekeeper off returns usegatekeeper off ● usegatekeeper specify returns usegatekeeper specify ● usegatekeeper auto returns usegatekeeper auto ● usegatekeeper get returns usegatekeeper auto Limitations None Comments None Polycom, Inc.
Page 384
System Commands See Also See the gatekeeperip command. Polycom, Inc.
Specifies the content video source to control. ✓ map {1..6} Note: This parameter is only necessary if no video source was specified when using the vcbutton play command. 5 is not supported. ✓ Gets the content video source that is currently source get playing. Polycom, Inc.
Page 386
(valid ranges 2..6) vcbutton play failed ● vcbutton register returns vcbutton registered ● vcbutton stop returns Control event: vcbutton stop Camera near none vcbutton stop vcbutton stop succeeded ● vcbutton get returns vcbutton stop vcbutton get succeeded Polycom, Inc.
Page 387
● vcbutton source get returns vcbutton source get none vcbutton source get succeeded Polycom recommends registering for notifications. If vcbutton register is used for notifications, the following responses occur. ● Pressing the play button at the far site returns Control event: vcbutton farplay ●...
Returns the current system’s version information. Syntax version User Accessible User role does not have access when the Security Profile is set to Maximum. Additional Restrictions None Feedback Examples ● version returns version 5.1.0 Limitations None Comments None Polycom, Inc.
Sets the VGA quality preference to both people both and content video. Feedback Examples ● vgaqualitypreference people returns vgaqualitypreference people ● vgaqualitypreference content returns vgaqualitypreference content ● vgaqualitypreference both returns vgaqualitypreference both ● vgaqualitypreference get returns vgaqualitypreference both Limitations None Comments None Polycom, Inc.
1 ● videocallorder sip 2 returns videocallorder sip 2 ● videocallorder gateway 3 returns videocallorder gateway 3 Limitations None Comments None See Also To set the dialing order for audio-only protocols, use the volume command. Polycom, Inc.
Specifies local video. near ✓ Enables information. ✓ Returns the current setting. Feedback Examples ● videomute get returns vidoemute off ● videomute near on returns videomute near on ● videomute near off returns videomute near off Limitations None Comments None Polycom, Inc.
System Commands visualboard Gets or specifies the current setting for the Polycom VisualBoard application. Syntax visualboard <get|on|off> User Parameter Description Accessible Additional Restrictions Returns the current setting. ✓ ✓ Enables the Polycom VisualBoard application. ✓ Disables the Polycom VisualBoard application.
System Commands visualboardppt Gets or sets the current setting for the Microsoft PowerPoint slide conversion function in the Polycom VisualBoard application. Syntax visualboardppt <get|on|off> User Parameter Description Accessible Additional Restrictions ✓ Returns the current setting. ✓ Enables the PowerPoint conversion function in the Polycom VisualBoard application.
System Commands visualboardswipe Gets or sets the current setting for the swipe navigation feature in the Polycom VisualBoard application. Syntax visualboardswipe <get|on|off> User Parameter Description Accessible Additional Restrictions Returns the current setting. ✓ ✓ ✓ ✓ Enables the swipe function in the Polycom VisualBoard application.
System Commands visualboardzoom Gets or sets the current setting for the zoom function in the Polycom VisualBoard application. Syntax visualboardzoom <get|on|off> User Parameter Description Accessible Additional Restrictions Returns the current setting. ✓ ✓ Enables the zoom function in the Polycom VisualBoard application.
Feedback Examples ● volume register returns volume registered ● If entered again, volume register returns info: event/notification already active:volume ● volume set 23 returns volume 23 ● volume up returns volume 24 ● volume get returns volume 24 Polycom, Inc.
Page 397
Limitations None Comments Changes the call audio volume (not sound effects) on the system. button command also allows you to control the system volume. Note that the button command does not return feedback about the current volume level. Polycom, Inc.
Wakes the system from sleep mode. Syntax wake User Accessible Additional Restrictions None Feedback Examples ● wake returns wake and wakes the system from sleep mode Limitations None Comments None See Also To put the system in sleep mode, use the sleep command. Polycom, Inc.
● wanipaddress set 192.168.1.101 returns wanipaddress 192.168.1.101 ● wanipaddress get returns wanipaddress 192.168.1.101 Limitations None Comments The NAT Configuration option on the Firewall screen must be set to Auto, Manual, or UPnP for this option to be available. Polycom, Inc.
System Commands webmonitoring Enables or disables the ability to view video from a RealPresence Group Series system via the web interface. Syntax webmonitoring “remoteaccesspasswd” <yes|no> User Parameter Description Accessible Additional Restrictions Current remote access password. “remoteaccessp asswd” Allows RealPresence Group Series video to be viewed via the web interface.
User Accessible Additional Restrictions None Feedback Examples ● whoami returns Hi, my name is: RealPresence Group Series Demo Here is what I know about myself: Model: Group Series 500 Serial Number: 82065205E72E1 Software Version: 1.0 Build Information: root on domain.polycom.com Contact Number: <empty>...
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.
They not only transmit room sound, but also allow unwanted outside noise to intrude on the conference space. In the event that windows cannot be avoided, it becomes essential that window treatment of some sort be used. This treatment should match the interior look and feel of the space, Polycom, Inc.
In general, light gray with just a touch of blue seems to work best. For rooms that have marginal lighting, slightly darker colors are quite useful. Polycom, Inc.
0.9 average. This specification is sometimes referred to as NRC (noise reduction coefficient). If reduction of sound passing through is required, then an additional barrier layer is laminated to the dense-core material, usually 3/8” thick fiber compression board. The barrier layer is placed against Polycom, Inc.
The vendors will analyze the plans and return a finished lighting layout to the customer, detailing the number of fixtures, placement and required wiring. Polycom, Inc.
1. Davis, Don and Carolyn. “Designing for Intelligibility” in Handbook for Sound Engineers: The New Audio Cyclopedia, ed. Glen Ballou (Indianapolis: Howard Sams & Co., 1991), 1279-1297. Polycom, Inc.
Since sound travels faster electronically than it travels through the open air we may need to add audio delay to the side firing or ceiling speaker arrays in order to keep the primary perceived point source as the front of room/front-firing speakers. Polycom, Inc.
Front projection systems are less expensive and easier to implement, but the conflicting interest between the camera and the projection display makes this form of display a very poor choice. Front projection setups operate best when the lighting in the room is dimmed or doused. When this is done, the Polycom, Inc.
In lieu of a complete control system, a limited functionality controller can be located at the presentation interface panel to control the switching and routing of the computer graphics and configure the overhead camera video paths. Polycom, Inc.
Page 411
And remember that simpler is always better. People do not pay for technology. They pay for the benefits that technology can bring. The doorway to those benefits is a simple, straightforward and intuitive user control. Polycom, Inc.
Polycom RealPresence Group Series Specifications This chapter includes information about system specifications. For back panel views of systems and for details about the various connections available on each back panel connector, refer to the Polycom RealPresence Group Series Administrator Guide at support.polycom.com Inputs/Outputs The table below contains audio specifications for RealPresence Group Series systems.
Page 413
Polycom RealPresence Group Series Specifications Characteristic Value Frequency Response Any input to any output, Relative to 997 +1, -3 dB, 50 Hz to 20 kHz Total Harmonic Distortion + Noise vs. Frequency -1 dBFS Input Level -60 dB, 50 Hz to 20 kHz...
-75 dB, 50 Hz to 20 kHz DTMF Dialing RealPresence Group 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 ●...
● 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.
Polycom RealPresence Group Series Specifications Key Name Key Code Key Code Parity Call 100101 Call/Hang Up Even Delete 100010 Even Down Arrow Even Home 11011 Even Left Arrow 1001 Even Low Battery 10111 Even Menu (Back) 10011 Mute 111010 Even...
Need help?
Do you have a question about the RealPresence Group Series and is the answer not in the manual?
Questions and answers