Cisco TelePresence ISDN Link Reference Manual
  1. Manuals
  2. Brands
  3. Cisco Manuals
  4. Recording Equipment
  5. TelePresence ISDN Link
  6. Reference manual

Cisco TelePresence ISDN Link Reference Manual

Hide thumbs Also See for TelePresence ISDN Link:
Table of Contents

Advertisement

Quick Links

Download this manual See also: Administrator's Manual
Cisco TelePresence ISDN Link
Contents
Introduction
Software version IL1.0
JUNE 2012
Application Programmer Interface (API)
D14953.01
ISDN Link API Reference Guide IL1.0 June 2012.
© 2012 Cisco Systems, Inc. All rights reserved.
About the API
xConfiguration
Reference Guide
Cisco TelePresence ISDN Link
1
xCommand
xStatus
API Reference Guide
Contact us
www.cisco.com

Advertisement

Table of Contents
loading

Related Manuals for Cisco TelePresence ISDN Link

Summary of Contents for Cisco TelePresence ISDN Link

  • Page 1 About the API xConfiguration xCommand xStatus Contact us Software version IL1.0 JUNE 2012 Application Programmer Interface (API) Reference Guide Cisco TelePresence ISDN Link D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 2 About xConfiguration ............12 About xCommand ..............13 About xStatus commands ..........14 About xFeedback .............. 15 About xPreferences ............16 The SystemTools commands ..........17 D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 3 API Reference Guide Cisco TelePresence ISDN Link Contents Introduction Introduction About the API xConfiguration xCommand xStatus Contact us Chapter 1 Introduction D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 4 About this guide User documentation Cisco contacts The user documentation for the Cisco TelePresence ISDN Link, On our web site you will find an overview of the worldwide This guide will introduce you to the Application Programmer running the IL software, have several guides.
  • Page 5 Cisco TelePresence ISDN Link Contents Introduction About the API About the API xConfiguration xCommand xStatus Contact us Chapter 2 About the API D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 6 Information flowing to target. This we call supplies information about how these WRITE information (W). instructions are executed, in addition to other system related information. D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 7 Network 1 DNS Server 1 Address Example: xConfiguration Network 1 DNS Server 1 Address *c xConfiguration Network 1 DNS Server 1 Address: “test” D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 8 5 GND 6 DSR —> 6 DSR 7 RTS <— 7 RTS 8 CTS —> 8 CTS 9 RI —> 9 RI D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.

  • Page 9: Value Types And Formats

    Defines that the valid input for this configuration is a String with minimum length x and maximum length of y characters. <S: 0, 49> D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.

  • Page 10: User Commands

    If echo is set to Off no user input is displayed when entering text in a command line interface. The oher commands The other user commands are described in the following pages. D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.

  • Page 11: Main Type Of Commands

    More on this can be found in xfeedback. More on this can be found in xpreferences. xFeedback xPreferences D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.

  • Page 12: About Xconfiguration

    *? xConfiguration ExternalNetwork Interface [1..1] CustomIMUX bw64R Prefix: <S: 0, 12> *? xConfiguration ExternalNetwork Interface [1..1] CustomIMUX bw64R Suffix: <S: 0, 12> xConfiguration E1 Interface 1 CRC4: Command Path Value D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.

  • Page 13: About Xcommand

    SystemUnit DateTime Set Year: 2012 Month: 4 Day: 1 Hour: 0 Minute: 0 Second: 0 Command Path Parameters and corresponding values D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 14 Example with more than one item of the path. xStatus Network 1 Ethernet Link *s Network 1 Ethernet Link Network: “1000full” *s Network 1 Ethernet Link Endpoint: “No LAN” D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.

  • Page 15: About Xfeedback

    Example with xFeedback xFeedback register Status/ISDN xFeedback register Configuration/ISDN xFeedback list xFeedback deregister Configuration/ISDN xFeedback list D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.

  • Page 16: About Xpreferences

    Terminal: Line based XACLI output for use with line based control systems • XML: Pure XML output for use with control systems that understand XML. D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.

  • Page 17: The Systemtools Commands

    <list | show <name>> systemtools isdntrace output on|off clear root password. Logging of the ISDN D-channel signalling. on/off: Enable/disable trace output for console. D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 18 Number of failed log ins until a user is set inactive. • Maximum number of digits in PINs. n: select archived log number ‘n’, where n=1 is the most recent. D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.

  • Page 19: June

    Cisco TelePresence ISDN Link Contents Introduction About the API xConfiguration xConfiguration xCommand xStatus Contact us Chapter 3 Description of the xConfiguration commands D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.

  • Page 20: Description Of The Xconfiguration Commands

    CD are available. DTR and CD correspond to the X.21 network's C and I signals. Example: xConfiguration ExternalNetwork Interface 1 CallControl: RS366 D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 21 Format: String with a maximum of 12 characters. Example: xConfiguration ExternalNetwork Interface 1 CustomIMUX bw128 Suffix: "" Example: xConfiguration ExternalNetwork Interface 1 CustomIMUX bw192R Suffix: "" D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 22 Format: String with a maximum of 12 characters. Example: xConfiguration ExternalNetwork Interface 1 CustomIMUX bw320 Suffix: "" Example: xConfiguration ExternalNetwork Interface 1 CustomIMUX bw384R Suffix: "" D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 23 Format: String with a maximum of 12 characters. Example: xConfiguration ExternalNetwork Interface 1 CustomIMUX bw768 Suffix: "" Example: xConfiguration ExternalNetwork Interface 1 CustomIMUX bw1152R Suffix: "" D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 24 Value space: <S: 0, 12> Format: String with a maximum of 12 characters. Example: xConfiguration ExternalNetwork Interface 1 CustomIMUX bw1920 Suffix: "" D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 25 On: Set to On to force restricted (56 kbps) calls. Off: Set to Off to disable restricted calls. Example: xConfiguration H320 DefaultCall Restrict: Off D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 26 On: When set to On, the PRI interfaces will be re-initialized after restart of the system. Off: When set to Off, the PRI interface will not be re-initialized after restart. Example: xConfiguration ISDN PRI InitialRestart: On D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 27 ISDN PRI NSFTelephony Mode: Off Value space: <0..31> Range: Select a value between 0 and 31. Example: xConfiguration ISDN PRI NSFTelephony Number: 0 D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 28 Range: Select a value between 1 and 31. Example: xConfiguration ISDN BRI Alert: Off Example: xConfiguration ISDN PRI Interface 1 LowChannel: 1 D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 29 Selected: When set to Selected, the system will activate the interfaces which are already on. All: When set to All, the system will activate all interfaces regardless of status. Example: xConfiguration ISDN BRI AutoActivation: All D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 30 DNS lookup "MyVideoSystem.domain.com". Value space: <S: 0, 64> Format: String with a maximum of 64 characters. Example: xConfiguration Network 1 DNS Domain Name: "" D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 31 Point (DSCP) AF31, which equals the value 26. If in doubt, contact your network administrator. xConfiguration Network 1 QoS Diffserv Signalling: 0 Example: D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 32 Format: String with a maximum of 255 characters, comma separated IP adresses or IP range. xConfiguration Network 1 RemoteAccess Allow: "192.168.1.231, Example: 192.168.1.182" D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 33 This is the password part of the credentials used to authenticate towards the SIP proxy. <S: 0, 128> Value space: Format: String with a maximum of 128 characters. Example: xConfiguration SIP Profile 1 Authentication 1 Password: D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 34 IP address. The default port is 5060 for TCP and UDP but another Value space: <Standard/Alcatel/Avaya/Cisco/Microsoft/Nortel/Broadsoft> one can be provided. If Outbound is enabled, multiple proxies can be addressed. Standard: To be used when registering to standard SIP Proxy (tested with Cisco TelePresence Value space: <S: 0, 255> VCS and Broadsoft) Format: Compact string with a maximum of 255 characters.
  • Page 35 Range4: 399–533 ft (122–162 m) xConfiguration SystemUnit Name: "ISDN Link" Example: Range5: 533–655 ft (162–200 m) xConfiguration T1 Interface 1 CableLength: Range1; Example: D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 36 Contact us The Time configuration The Experimental configuration The Experimental settings are for testing only and should not be used unless agreed with Cisco. These settings are not documented and WILL change in later releases. xConfiguration Time Zone Set the time zone where the system is located, using Windows time zone description format.
  • Page 37 Cisco TelePresence ISDN Link Contents Introduction About the API xConfiguration xCommand xCommand xStatus Contact us Chapter 4 Description of the xCommand commands D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.

  • Page 38: Description Of The Xcommands Commands

    CUIL reboot request, restarting Confirm(r): <Yes> Connection closed by foreign host. Example: xCommand Security FIPSMode Activate Confirm: "Yes" *r SecurityFIPSModeActivateResult (status=OK) ** end D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 39 SystemUnit FactoryReset Confirm: Yes Example: *r SystemUnitFactoryResetResult (status=OK): xCommand SystemUnit DateTime Set Year:2012 Month:7 Day:1 Hour:12 Minute:0 ** end Second:0 *r SystemUnitDateTimeSetResult (status=OK): ** end D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 40 Password: <S: 0, 255> Example: xCommand SystemUnit SoftwareUpgrade URL: "ftp://<ftp _ server _ ip _ address>/<path>/<filename>" UserName: "" Password: "" *r SystemUnitSoftwareUpgradeResult (status=OK): ** end D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 41 Cisco TelePresence ISDN Link Contents Introduction About the API xConfiguration xCommand xStatus xStatus Contact us Chapter 5 Description of the xStatus commands D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.

  • Page 42: Status Type Commands

    *s Call 20 Duration: 2354 *s Call 20 Callee ReceiveCallRate: 768 ** end *s Call 20 Callee Encryption Type: "None" ** end D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.

  • Page 43: D14953.01 Isdn Link Api Reference Guide Il1.0 June

    ** end Value space of the result returned: <String> Example: xStatus Call 20 Callee RemoteNumber *s Call 20 Callee RemoteNumber: "1234" ** end D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.

  • Page 44: D14953.01 Isdn Link Api Reference Guide Il1.0 June

    Value space of the result returned: <Integer> Example: xStatus Call 20 Caller TransmitCallRate *s Call 20 Caller TransmitCallRate: 768 ** end D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.

  • Page 45: D14953.01 Isdn Link Api Reference Guide Il1.0 June

    Answering: The network has acknowledged an outgoing call, but the connection is not yet Cisco TelePresence ISDN Link has three communication interfaces: ISDN BRI, ISDN PRI and External established. Network. Only one of these interfaces can be enabled at any time.

  • Page 46: Second: <0

    Example: xStatus ExternalNetwork Interface 1 Channel 1 Call 10 Duration *s ExternalNetwork Interface 1 Channel 1 Call 10 Duration: 771 ** end D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.

  • Page 47: D14953.01 Isdn Link Api Reference Guide Il1.0 June

    Neither the PRI nor the BRI interface is enabled Shows the top level overview of the ISDN status. ------------------------------------------------ Cisco TelePresence ISDN Link has three communication interfaces: ISDN BRI, ISDN PRI and external xStatus ISDN network (NET). Only one of these interfaces can be enabled at any time.

  • Page 48: Value Space Of The Result Returned: <0

    ISDN PRI Interface 1 Channel 1 Call 20 CallingNumber *s ISDN PRI Interface 1 Channel 1 Call 20 CallingNumber: "1234" ** end D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 49 ISDN PRI Interface 1 Channel 1 Call 20 ChannelCause *s ISDN PRI Interface 1 Channel 1 Call 20 ChannelCause: 16 ** end D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 50 ISDN BRI Interface 1 Channel 1 Call 30 CauseLocation *s ISDN BRI Interface 1 Channel 1 Call 30 CauseLocation: 0 ** end D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 51 *s MediaChannels Call 20 Caller IncomingVideoChannel 2 Transport RTP Remote Port: 2368 ** end *s MediaChannels Call 20 Caller IncomingVideoChannel 2 Transport RTCP Local D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 52 Port: 2327 *s MediaChannels Call 20 Caller OutgoingAudioChannel 1 Transport RTCP Remote IpAddress: "192.0.2.181" *s MediaChannels Call 20 Caller OutgoingAudioChannel 1 Transport RTCP D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 53 Value space of the result returned: <On/Off> Example: xStatus MediaChannels Call 20 IncomingAudioChannel 1 Encryption Status *s MediaChannels Call 20 IncomingAudioChannel 1 Encryption Status: On ** end D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 54 MediaChannels Call 20 IncomingAudioChannel 1 Transport RTP Remote IpAddress *s MediaChannels Call 20 IncomingAudioChannel 1 Transport RTP Remote IpAddress: "192.0.2.181" ** end D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 55 *s MediaChannels Call 20 IncomingAudioChannel 1 Transport RTCP Local *s MediaChannels Call 20 IncomingAudioChannel 1 Transport RTCP Remote IpAddress: "192.0.2.54" IpAddress: "192.0.2.181" ** end ** end D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 56 *s MediaChannels Call 20 IncomingVideoChannel 2 Video Protocol: H264 *s MediaChannels Call 20 IncomingVideoChannel 2 Encryption Status: On ** end ** end D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 57 *s MediaChannels Call 20 IncomingVideoChannel 2 Transport RTP Local Port: *s MediaChannels Call 20 IncomingVideoChannel 2 Transport RTP Remote Port: 2342 2368 ** end ** end D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 58 *s MediaChannels Call 20 IncomingVideoChannel 2 Transport RTCP Local Port: *s MediaChannels Call 20 IncomingVideoChannel 2 Transport RTCP Remote Port: 2343 2369 ** end ** end D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 59 *s Network 1 IPv4 Gateway: "192.0.2.10" Example: ** end xStatus Network 1 Ethernet Link Network *s Network 1 Ethernet Link Network: "No LAN" ** end D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 60 Shows the address of the IPv6 gateway. Value space of the result returned: <String> Example: xStatus Network 1 IPv6 Gateway *s Network 1 IPv6 Gateway: "2001:DB8::0001" ** end D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 61 Off: There is no communication between the endpoint and the SIP Proxy. to is included in the codec’s trusted CA-list. The server will typically be a Cisco VCS or Cisco Unified Timeout: The attempt to establish communication to the SIP Proxy timed out.
  • Page 62 Value space of the result returned: <String> Example: xStatus SIP Profile 1 Registration 1 Reason *s SIP Profile 1 Registration 1 Reason: "" ** end D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.

  • Page 63: Systemunit State Maxnumberofcalls

    <Integer> Example: Example: xStatus SystemUnit Uptime xStatus SystemUnit *s SystemUnit Uptime: 2158 *s SystemUnit ProductType: "Cisco TelePresence ISDN link" ** end *s SystemUnit Uptime: 2158 *s SystemUnit Software Version: "IL1.0.0" xStatus SystemUnit Software Version *s SystemUnit Software Name: "s51500" *s SystemUnit Software ReleaseDate: "2012-05-30"...
  • Page 64 SystemUnit Software MaxAudioCalls xStatus SystemUnit Hardware MainBoard Identifier *s SystemUnit Software MaxAudioCalls: 3 *s SystemUnit Hardware MainBoard Identifier: "102030-1 [00]" ** end ** end D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.
  • Page 65 Not applicable when using the external network (NET) interface. ** end Value space of the result returned: <String> Example: xStatus SystemUnit State H320Number *s SystemUnit State H320Number: "5678" ** end D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.

  • Page 66: Table Of Contents

    Shows the number of calls in progress. Value space of the result returned: <0..3> Example: xStatus SystemUnit State NumberOfInProgressCalls *s SystemUnit State NumberOfInProgressCalls: 0 ** end D14953.01 ISDN Link API Reference Guide IL1.0 June 2012. www.cisco.com © 2012 Cisco Systems, Inc. All rights reserved.

  • Page 67: Www.cisco.com

    INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY. The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public domain version of the UNIX operating system.

Table of Contents