1. Manuals
  2. Brands
  3. Cisco Manuals
  4. Conference System
  5. TELEPRESENCE VIDEO COMMUNICATION SERVER - COMMAND REFERENCE V...
  6. Command reference manual

Cisco TELEPRESENCE VIDEO COMMUNICATION SERVER - COMMAND REFERENCE V X6 Command Reference Manual

Software version: x6
Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
Cisco TelePresence
Video Communication
Server

Command Reference

D14754.01
January 2010
Software version: X6

Advertisement

Table of Contents
loading

Related Manuals for Cisco TELEPRESENCE VIDEO COMMUNICATION SERVER - COMMAND REFERENCE V X6

Summary of Contents for Cisco TELEPRESENCE VIDEO COMMUNICATION SERVER - COMMAND REFERENCE V X6

  • Page 1: Command Reference

    Cisco TelePresence Video Communication Server Command Reference D14754.01 January 2010 Software version: X6...

  • Page 2: Table Of Contents

    Contents Introduction Using the command line interface (CLI) CLI command types xConfiguration command reference xConfiguration commands xCommand command reference xCommand commands xStatus command reference xStatus elements Restoring default configuration Configuration items reset by DefaultValuesSet level 3 Configuration items reset by DefaultValuesSet level 2 Policy services Policy service request parameters Policy service responses...

  • Page 3: Introduction

    Introduction Introduction This Command Reference document provides supplementary information regarding the administration of the Cisco TelePresence Video Communication Server (Cisco VCS). It includes: details of the commands available through the Cisco VCS's command line interface (CLI) a description of the parameters included in requests from the Cisco VCS to external policy services Using the command line interface (CLI) The Cisco VCS can be configured through a web interface or via a command line interface (CLI).

  • Page 4: Xconfiguration Command Reference

    xConfiguration command reference xConfiguration command reference The xConfiguration group of commands are used to set and change individual items of configuration. Each command is made up of a main element followed by one or more sub-elements. The following section lists all the currently available xConfiguration commands. To set a particular item of configuration, type the command as shown.
  • Page 5 xConfiguration command reference Administration HTTP Mode: <On/Off> Determines whether HTTP calls will be redirected to the HTTPS port. On: calls will be redirected to HTTPS. Off: no HTTP access will be available. Note: you must restart the system for any changes to take effect. Default: On Example: xConfiguration Administration HTTP Mode: On Administration HTTPS Mode: <On/Off>...
  • Page 6 xConfiguration command reference Alternates Cluster Name: <S: 0,128> The fully qualified domain name used in SRV records that address this VCS cluster, for example "cluster1.example.com". The name can only contain letters, digits, hyphens and underscores. Warning: if you change the cluster name after any user accounts have been configured on this VCS, you may need to reconfigure your user accounts to use the new cluster name.
  • Page 7 xConfiguration command reference Applications External Status [1..10] Name: <S:0,64> Descriptive name for the external application whose status is being referenced. Example: xConfiguration Applications External Status 1 Name: "foo" Applications OCS Relay Mode: <On/Off> Enables or disables OCS relay support. Default: Off Example: xConfiguration Applications OCS Relay Mode: Off Applications OCS Relay OCS Domain: <S:0,128>...
  • Page 8 xConfiguration command reference Applications Presence User Agent RetryDelta: <1..65534> Specifies the time (in seconds) after which the Presence User Agent will attempt to resend a PUBLISH to the Presence Server. This will occur if the original attempt failed due to resource issues or other transitory errors. Default: 1800 Example: xConfiguration Applications Presence User Agent RetryDelta: 1800 Authentication ADS ADDomain: <S: 0,255>...
  • Page 9 xConfiguration command reference Authentication ADS SPNEGO: <Enabled/Disabled> Indicates if SPNEGO (Simple and Protected GSSAPI Negotiation Mechanism) is used when the client (the VCS) authenticates with the server (the AD domain controller). Default: Enabled Example: xConfiguration Authentication ADS SPNEGO: Enabled Authentication ADS SecureChannel: <Auto/Enabled/Disabled> Indicates if data transmitted from the VCS to an AD domain controller is sent over a secure channel.
  • Page 10 xConfiguration command reference Authentication UserName: <S: 0, 128> The username used by the VCS when authenticating with another system. Note: this does not apply to traversal client zones. Example: xConfiguration Authentication UserName: "VCS123" Bandwidth Default: <64..65535> Sets the bandwidth (in kbps) to be used on calls managed by the VCS in cases where no bandwidth has been specified by the endpoint.
  • Page 11 xConfiguration command reference Bandwidth Pipe [1..1000] Bandwidth PerCall Limit: <1..100000000> If this pipe has limited per-call bandwidth, sets the maximum amount of bandwidth (in kbps) available for any one call. Default: 1920 Example: xConfiguration Bandwidth Pipe 1 Bandwidth PerCall Limit: 256 Bandwidth Pipe [1..1000] Bandwidth PerCall Mode: <Limited/Unlimited/NoBandwidth>...
  • Page 12 Default: Off Example: xConfiguration Error Reports Mode: Off Error Reports URL: <S: 0, 128> The URL of the web service to which error reports are sent. Default: http://vcser.tandberg.com/submitapplicationerror/ Example: xConfiguration Error Reports URL: "http://vcser.tandberg.com/submitapplicationerror/" Ethernet [1..2] IP V4 Address: <S: 7,15>...
  • Page 13 xConfiguration command reference Ethernet [1..2] IP V4 StaticNAT Address: <S:7,15> If the VCS is operating in static NAT mode, this specifies the external public IPv4 address of that static NAT. Note: you must restart the system for any changes to take effect. Example: xConfiguration Ethernet 1 IP V4 StaticNAT Address: "64.22.64.85"...
  • Page 14 xConfiguration command reference H323 Gatekeeper AutoDiscovery Mode: <On/Off> Determines whether or not the VCS responds to gatekeeper discovery requests from endpoints. Default: On Example: xConfiguration H323 Gatekeeper AutoDiscovery Mode: On H323 Gatekeeper CallSignaling PortRange End: <1024..65534> Specifies the upper port in the range to be used by calls once they are established. Default: 19999 Example: xConfiguration H323 Gatekeeper CallSignaling PortRange End: 19999 H323 Gatekeeper CallSignaling PortRange Start: <1024..65534>...
  • Page 15 xConfiguration command reference H323 Gateway CallerId: <IncludePrefix/ExcludePrefix> Specifies whether the prefix of the ISDN gateway is inserted into the caller's E.164 number presented on the destination endpoint. Including the prefix allows the recipient to directly return the call. IncludePrefix: inserts the ISDN gateway's prefix into the source E.164 number. ExcludePrefix: only displays the source E.164 number.
  • Page 16 xConfiguration command reference IP DNS Hostname : <S: 0, 63> Defines the DNS host name that this system is known by. Note that this is not the fully-qualified domain name, just the host label portion. The name can only contain letters, digits, hyphens and underscores. The first character must be a letter and the last character must be a letter or a digit.
  • Page 17 xConfiguration command reference IP Route [1..50] Address: <S: 0, 39> Specifies an IP address used in conjunction with the Prefix Length to determine the network to which this route applies. Example: xConfiguration IP Route 1 Address: "128.168.0.0" IP Route [1..50] Gateway: <S: 0, 39> Specifies the IP address of the Gateway for this route.
  • Page 18 xConfiguration command reference LDAP Server Port: <1..65534> Sets the IP port of the LDAP server to use when making LDAP queries. Typically, non-secure connections use 389 and secure connections use 636. Default: 389 Example: xConfiguration LDAP Server Port: 389 LDAP UserDN: <S: 0, 255> Sets the user distinguished name to use when binding to the LDAP server.
  • Page 19 xConfiguration command reference Login Remote LDAP BaseDN Accounts: <S: 0,255> Sets the Distinguished Name to use as the base when searching for administrator and user accounts. Example: xConfiguration Login Remote LDAP BaseDN Accounts: "ou=useraccounts,dc=corporation,dc=int" Login Remote LDAP BaseDN Groups: <S: 0,255> Sets the Distinguished Name to use as the base when searching for administrator and user groups.
  • Page 20 xConfiguration command reference Login Remote LDAP Server FQDNResolution: <AddressRecord/SRVRecord> Sets how the LDAP server address is resolved if specified as an FQDN. AddressRecord: DNS A or AAAA record lookup. SRVRecord: DNS SRV record lookup. Default: AddressRecord Example: xConfiguration Login Remote LDAP Server FQDNResolution: AddressRecord Login Remote LDAP Server Port: <1..65534>...
  • Page 21 Option [1..64] Key: <S: 0, 90> Specifies the option key of your software option. These are added to the VCS in order to add extra functionality, such as increasing the VCS’s capacity. Contact your TANDBERG representative for further information. Example: xConfiguration Option 1 Key: "1X4757T5-1-60BAD5CD"...
  • Page 22 xConfiguration command reference Policy AdministratorPolicy Service Server [1..3] Address: <S: 0,128> Specifies the IP address or Fully Qualified Domain Name (FQDN) of the remote service. Example: xConfiguration Policy AdministratorPolicy Service Server 1 Address: "service.server.example.com" Policy AdministratorPolicy Service TLS CRLCheck Mode: <On/Off> Controls certificate revocation list checking of the certificate supplied by the policy service.
  • Page 23 xConfiguration command reference Policy FindMe Server Path: <S: 0, 255> Specifies the URL of the remote FindMe Manager. Example: xConfiguration Policy FindMe Server Path: "service" Policy FindMe Server Protocol: <HTTP/HTTPS> Specifies the protocol used to connect to the remote FindMe Manager. Default: HTTP Example: xConfiguration Policy FindMe Server Protocol: HTTP Policy FindMe Server UserName: <S: 0, 30>...
  • Page 24 xConfiguration command reference Policy Services Service [1..5] Server [1..3] Address: <S: 0,128> Specifies the IP address or Fully Qualified Domain Name (FQDN) of the remote service. Example: xConfiguration Policy Services Service 1 Server 1 Address: "192.168.0.0" Policy Services Service [1..5] TLS CRLCheck Mode: <On/Off> Controls certificate revocation list checking of the certificate supplied by the policy service.
  • Page 25 xConfiguration command reference Registration DenyList [1..2500] Pattern String: <S: 0, 60> Specifies an entry to be added to the Deny List. If one of an endpoint’s aliases matches one of the patterns in the Deny List, the registration will not be permitted. Example: xConfiguration Registration DenyList 1 Pattern String: "john.jones@example.com"...
  • Page 26 xConfiguration command reference Registration RestrictionPolicy Service Server [1..3] Address: <S: 0,128> Specifies the IP address or Fully Qualified Domain Name (FQDN) of the remote service. Example: xConfiguration Registration RestrictionPolicy Service Server 1 Address: "192.168.0.0" Registration RestrictionPolicy Service TLS CRLCheck Mode: <On/Off> Controls certificate revocation list checking of the certificate supplied by the policy service.
  • Page 27 xConfiguration command reference SIP Authentication Digest Nonce Maximum Use Count: <1..1024> Maximum number of times that a nonce generated by the VCS may be used by a client. Default: 128 Example: xConfiguration SIP Authentication Digest Nonce Maximum Use Count: 128 SIP Authentication NTLM Mode: <On/Off/Auto>...
  • Page 28 xConfiguration command reference Services AdvancedMediaGateway Policy Rules Rule [1..200] Pattern Type: <Exact/Prefix/Suffix/Regex> The way in which the pattern must match either the source or destination alias of the call. Exact: the entire pattern string must exactly match the alias character for character. Prefix: the pattern string must appear at the beginning of the alias.
  • Page 29 Default: On Example: xConfiguration SIP Require Duo Video Mode: On SIP Require UDP BFCP Mode: <On/Off> Controls whether the VCS will require the use of the com.tandberg.udp.bfcp extension for endpoints that support it. Default: On Example: xConfiguration SIP Require UDP BFCP Mode: On SIP Routes Route [1..20] Address: <S:0,39>...
  • Page 30 xConfiguration command reference SIP Routes Route [1..20] Header Pattern: <S:0,128> Regular expression to match against the specified SIP header field. Note: this command is intended for developer use only. Example: xConfiguration SIP Routes Route 1 Header Pattern: "(my-event-package)(.*)" SIP Routes Route [1..20] Method: <S:0,64> SIP method to match to select this route (e.g.
  • Page 31 xConfiguration command reference SIP TCP Mode: <On/Off> Determines whether incoming and outgoing SIP calls using the TCP protocol will be allowed. Default: On Example: xConfiguration SIP TCP Mode: On SIP TCP Outbound Port End: <1024..65534> Specifies the upper port in the range to be used by outbound TCP/TLS SIP connections. Default: 29999 Example: xConfiguration SIP TCP Outbound Port End: 29999 SIP TCP Outbound Port Start: <1024..65534>...
  • Page 32 xConfiguration command reference SNMP Mode: <On/Off> Enables or disables SNMP support. Default: Off Example: xConfiguration SNMP Mode: On SNMP SystemContact: <S: 0, 70> Specifies the name of the person who can be contacted regarding issues with the VCS. Example: xConfiguration SNMP SystemContact: "John Smith" SNMP SystemLocation: <S: 0, 70>...
  • Page 33 xConfiguration command reference SNMP V3 Privacy Password: <S: 0,215> Sets SNMP Version 3 privacy password. Note: must be at least 8 characters. Example: xConfiguration SNMP V3 Privacy Password: "password123" SNMP V3 Privacy Type: <DES/AES> Sets SNMP Version 3 privacy type. Example: xConfiguration SNMP V3 Privacy Type: AES SNMP V3 UserName: <S: 0,70>...
  • Page 34 xConfiguration command reference SystemUnit StrictPassword Enforce: <On/Off> Determines whether or not administrator passwords must meet a certain level of complexity before they are accepted. Default: Off Example: xConfiguration SystemUnit StrictPassword Enforce: Off TimeZone Name: <S: 0, 64> Sets the local time zone of the VCS. Time zone names follow the POSIX naming convention e.g. Europe/London or America/New_York.
  • Page 35 xConfiguration command reference Transform [1..100] Priority: <1..65534> Assigns a priority to the specified transform. Transforms are compared with incoming aliases in order of priority, and the priority must be unique for each transform. Default: 1 Example: xConfiguration Transform 1 Priority: 10 Transform [1..100] State: <Enabled/Disabled>...
  • Page 36 Traversal Server TURN Authentication Realm: <S: 1,128> The realm sent by the server in its authentication challenges. Default: TANDBERG Example: xConfiguration Traversal Server TURN Authentication Realm: "TANDBERG" Traversal Server TURN Media Port End: <1024..65534> The upper port in the range used for TURN relays.
  • Page 37 xConfiguration command reference Zones LocalZone DefaultSubZone Bandwidth PerCall Inter Limit: <1..100000000> Specifies the bandwidth limit (in kbps) for any one call to or from an endpoint in the Default Subzone (applies only if the mode is set to Limited). Default: 1920 Example: xConfiguration Zones LocalZone DefaultSubZone Bandwidth PerCall Inter Limit: 1920 Zones LocalZone DefaultSubZone Bandwidth PerCall Inter Mode: <Limited/Unlimited/NoBandwidth>...
  • Page 38 xConfiguration command reference Zones LocalZone SubZones MembershipRules Rule [1..3000] Description: <S: 0,64> A free-form description of the membership rule. Example: xConfiguration Zones LocalZone SubZones MembershipRules Rule 1 Description: "Office-based staff" Zones LocalZone SubZones MembershipRules Rule [1..3000] Name: <S: 0,50> Assigns a name to this membership rule. Example: xConfiguration Zones LocalZone SubZones MembershipRules Rule 1 Name: "Office Workers"...
  • Page 39 xConfiguration command reference Zones LocalZone SubZones MembershipRules Rule [1..3000] Subnet PrefixLength: <1..128> The number of bits of the subnet address which must match for an IP address to belong in this subnet. Default: 32 Example: xConfiguration Zones LocalZone SubZones MembershipRules Rule 1 Subnet PrefixLength: 32 Zones LocalZone SubZones MembershipRules Rule [1..3000] Type: <Subnet/AliasPatternMatch>...
  • Page 40 xConfiguration command reference Zones LocalZone SubZones SubZone [1..1000] Bandwidth PerCall Intra Mode: <Limited/Unlimited/NoBandwidth> Determines whether there is a limit on the bandwidth for any one call between two endpoints within this subzone. NoBandwidth: no bandwidth available. No calls can be made within this subzone. Default: Unlimited Example: xConfiguration Zones LocalZone SubZones SubZone 1 Bandwidth PerCall Intra Mode: Limited...
  • Page 41 xConfiguration command reference Zones LocalZone Traversal H323 H46019 Demultiplexing Mode: <On/Off> Determines whether the VCS will operate in Demultiplexing mode for calls from traversal-enabled endpoints registered directly with it. On: allows use of the same two ports for all calls. Off: each call will use a separate pair of ports for media.
  • Page 42 xConfiguration command reference Zones LocalZone Traversal H323 UDPProbe RetryInterval: <1..65534> Sets the frequency (in seconds) with which traversal-enabled endpoints registered directly with the VCS will send a UDP probe to the VCS. Default: 2 Example: xConfiguration Zones LocalZone Traversal H323 UDPProbe RetryInterval: 2 Zones LocalZone TraversalSubZone Bandwidth PerCall Limit: <1..100000000>...
  • Page 43 xConfiguration command reference Zones Policy SearchRules Rule [1..2000] Description: <S: 0,64> A free-form description of the search rule. Example: xConfiguration Zones Policy SearchRules Rule 1 Description: "Send query to the DNS zone" Zones Policy SearchRules Rule [1..2000] Mode: <AliasPatternMatch/AnyAlias/AnyIPAddress> Determines whether a query is sent to the target zone. AliasPatternMatch: queries the zone only if the alias matches the corresponding pattern type and string.
  • Page 44 xConfiguration command reference Zones Policy SearchRules Rule [1..2000] Priority: <1..65534> The order in the search process that this rule is applied, when compared to the priority of the other search rules. All Priority 1 search rules are applied first, followed by all Priority 2 search rules, and so on. Default: 100 Example: xConfiguration Zones Policy SearchRules Rule 1 Priority: 100 Zones Policy SearchRules Rule [1..2000] Progress: <Continue/Stop>...
  • Page 45 xConfiguration command reference Zones Zone [1..1000] DNS Interworking SIP Audio DefaultCodec: <G711u/G711a/G722_48/G722_56/ G722_64/G722_1_16/G722_1_24/G722_1_32/G722_1_48/G723_1/G728/G729/AALCD_48/AALCD_56/ AALCD_64/AMR> Specifies which audio codec to use when empty INVITEs are not allowed. Default: G711u Example: xConfiguration Zones Zone 1 DNS Interworking SIP Audio DefaultCodec: G711u Zones Zone [1..1000] DNS Interworking SIP EmptyInviteAllowed: <On/Off> Determines whether the VCS will generate a SIP INVITE message with no SDP to send to this zone.
  • Page 46 xConfiguration command reference Zones Zone [1..1000] DNS SIP Poison Mode: <On/Off> Determines whether SIP requests sent out to this zone will be "poisoned" such that if they are received by the local VCS again they will be rejected. On: SIP requests sent out via this zone that are received again by this VCS will be rejected. Off: SIP requests sent out via this zone that are received by this VCS again will be processed as normal.
  • Page 47 xConfiguration command reference Zones Zone [1..1000] DNS SIP UDP BFCP Filter Mode: <On/Off> Determines whether INVITE requests sent to this zone filter out UDP/BFCP. This option may be required to enable interoperability with SIP devices that do not support the UDP/BFCP protocol. On: any media line referring to the UDP/BFCP protocol is replaced with TCP/BFCP and disabled.
  • Page 48 xConfiguration command reference Zones Zone [1..1000] Neighbor Authentication Mode: <DoNotCheckCredentials/TreatAsAuthenticated/CheckCredentials> Controls how the VCS authenticates incoming messages from this zone and whether they are subsequently treated as authenticated, unauthenticated, or are rejected. The behavior varies for H.323 messages, SIP messages that originate from a local domain and SIP messages that originate from non-local domains. See the Administrator Guide for full details about each of the Authentication Policy options.
  • Page 49 xConfiguration command reference Zones Zone [1..1000] Neighbor Interworking SIP Video DefaultBitrate: <64..65535> Specifies which video bitrate to use when empty INVITEs are not allowed. Default: 384 Example: xConfiguration Zones Zone 3 Neighbor Interworking SIP Video DefaultBitrate: Zones Zone [1..1000] Neighbor Interworking SIP Video DefaultCodec: <None/H261/H263/H263p/H263pp/H264>...
  • Page 50 xConfiguration command reference Zones Zone [1..1000] Neighbor SIP Duo Video Filter Mode: <On/Off> Determines whether INVITE requests sent to this zone filter out Duo Video. This option may be required to enable interoperability with SIP devices that do not support Duo Video. On: the second video line in any outgoing INVITE request is removed.
  • Page 51 xConfiguration command reference Zones Zone [1..1000] Neighbor SIP Port: <1024..65534> Specifies the port on the neighbor to be used for SIP calls to and from this VCS. Default: 5061 Example: xConfiguration Zones Zone 3 Neighbor SIP Port: 5061 Zones Zone [1..1000] Neighbor SIP ProxyRequire Strip List: <S: 0,255> A comma separated list of option tags to search for and remove from Proxy-Require headers in SIP requests received from this zone.
  • Page 52 xConfiguration command reference Zones Zone [1..1000] Neighbor SIP TLS Verify Mode: <On/Off> Controls X.509 certificate checking and mutual authentication for inbound and outbound connections between this VCS and the neighbor system. When enabled, the neighbor system's FQDN or IP address, as specified in the Peer address field, must be contained within the neighbor's X.509 certificate (in either the Subject Common Name or the Subject Alternative Name attributes).
  • Page 53 xConfiguration command reference Zones Zone [1..1000] TraversalClient Authentication Mode: <DoNotCheckCredentials/TreatAsAuthenticated/CheckCredentials> Controls how the VCS authenticates incoming messages from this zone and whether they are subsequently treated as authenticated, unauthenticated, or are rejected. The behavior varies for H.323 messages, SIP messages that originate from a local domain and SIP messages that originate from non-local domains. See the Administrator Guide for full details about each of the Authentication Policy options.
  • Page 54 xConfiguration command reference Zones Zone [1..1000] TraversalClient SIP Poison Mode: <On/Off> Determines whether SIP requests sent out to this zone will be "poisoned" such that if they are received by the local VCS again they will be rejected. On: SIP requests sent out via this zone that are received again by this VCS will be rejected. Off: SIP requests sent out via this zone that are received by this VCS again will be processed as normal.
  • Page 55 xConfiguration command reference Zones Zone [1..1000] TraversalServer Authentication UserName: <S: 0,128> The name used by the traversal client when authenticating with the traversal server. If the traversal client is a VCS, this must be the VCS’s authentication user name. If the traversal client is a gatekeeper, this must be the gatekeeper’s System Name.
  • Page 56 xConfiguration command reference Zones Zone [1..1000] TraversalServer SIP Protocol: <Assent/TURN/ICE> Determines which firewall traversal protocol will be used for SIP calls to and from the traversal client. Note: the same protocol must be set on the client for calls to and from this traversal server. Default: Assent Example: xConfiguration Zones Zone 1 TraversalServer SIP Protocol: Assent Zones Zone [1..1000] TraversalServer SIP TLS Verify Mode: <On/Off>...
  • Page 57 xConfiguration command reference Zones Zone [1..1000] TraversalServer UDPProbe RetryCount: <1..65534> Sets the number of times the traversal client will attempt to send a UDP probe to the VCS. Default: 5 Example: xConfiguration Zones Zone 5 TraversalServer UDPProbe RetryCount: 5 Zones Zone [1..1000] TraversalServer UDPProbe RetryInterval: <1..65534> Sets the frequency (in seconds) with which the traversal client will send a UDP probe to the VCS.

  • Page 58: Xcommand Command Reference

    xCommand command reference xCommand command reference The xCommand group of commands are used to add and delete items and issue system commands. The following section lists all the currently available xCommand commands. To issue a command, type the command as shown, followed by one or more of the given parameters and values.
  • Page 59 xCommand command reference AMGWPolicyRuleDelete Deletes an Advanced Media Gateway policy rule. AMGWPolicyRuleId(r): <1..200> The index of the Advanced Media Gateway policy rule to be deleted. Example: xCommand AMGWPolicyRuleDelete AMGWPolicyRuleId: 1 AdminAccountAdd Creates a new administrator account. Name(r): <S:0,25> Defines the name of an administrator user who can login to the VCS web interface. Password(r): <S:0,65>...
  • Page 60 xCommand command reference AdsDcAdd Adds a new Active Directory server. ActiveDirectoryAddress(r): <S: 0,39> The address of a domain controller that can be used when the VCS joins the AD domain. Not specifying a specific AD will result the use of DNS SRV queries to find an AD. Example: xCommand AdsDcAdd ActiveDirectoryAddress: "192.168.0.0"...
  • Page 61 xCommand command reference AllowListDelete Deletes an entry from the Allow List. AllowListId(r): <1..2500> The index of the entry to be deleted. Example: xCommand AllowListDelete AllowListId: 2 Boot Reboots the VCS. This command has no parameters. Example: xCommand boot CheckBandwidth A diagnostic tool that returns the status and route (as a list of nodes and links) that a call of the specified type and bandwidth would take between two nodes.
  • Page 62 xCommand command reference CredentialAdd Adds an entry to the local authentication database. CredentialName(r): <S: 1, 128> Defines the name for this entry in the local authentication database. CredentialPassword(r): <S: 1, 128> Defines the password for this entry in the local authentication database. Example: xCommand CredentialAdd CredentialName: "John Smith"...
  • Page 63 xCommand command reference DenyListDelete Deletes an entry from the Deny List. DenyListId(r): <1..2500> The index of the entry to be deleted. Example: xCommand DenyListDelete DenyListId: 2 DisconnectCall Disconnects a call. Call: <1..900> The index of the call to be disconnected. CallSerialNumber: <S: 1, 255>...
  • Page 64 xCommand command reference ExtAppStatusDelete Deletes an external application status entry. Note: this command is intended for developer use only. Name(r): <S:1, 64> Descriptive name for the external application whose status is being referenced. Example: xCommand ExtAppStatusDelete Name: foo FeedbackDeregister Deactivates a particular feedback request. ID: <1..3>...
  • Page 65 xCommand command reference LinkAdd Adds and configures a new link. LinkName(r): <S: 1, 50> Assigns a name to this link. Node1: <S: 1, 50> Specifies the first zone or subzone to which this link will be applied. Node2: <S: 1, 50> Specifies the second zone or subzone to which this link will be applied.
  • Page 66 xCommand command reference Locate Runs the VCS's location algorithm to locate the endpoint identified by the given alias, searching locally, on neighbors, and on systems discovered through the DNS system, within the specified number of 'hops'. Results are reported back through the xFeedback mechanism, which must therefore be activated before issuing this command (e.g.
  • Page 67 xCommand command reference OptionKeyDelete Deletes a software option key from the VCS. OptionKeyId(r): <1..64> Specifies the ID of the software option to be deleted. Example: xCommand OptionKeyDelete OptionKeyId: 2 PipeAdd Adds and configures a new pipe. PipeName(r): <S: 1, 50> Assigns a name to this pipe.
  • Page 68 xCommand command reference PolicyServiceAdd Adds a policy service. Name(r): <S: 0, 50> Assigns a name to this Policy Service. Description: <S: 0, 64> A free-form description of the Policy Service. Protocol: <HTTP/HTTPS> Specifies the protocol used to connect to the remote service. Default: HTTP Verify: <On/Off>...
  • Page 69 xCommand command reference RemoveRegistration Removes a registration from the VCS. Registration: <1..3750> The index of the registration to be removed. RegistrationSerialNumber: <S: 1, 255> The serial number of the registration to be removed. Example: xCommand RemoveRegistration RegistrationSerialNumber: "a761c4bc-25c9-11b2- a37f-0010f30f521c" Restart Restarts the VCS without a full system reboot.
  • Page 70 xCommand command reference SearchRuleAdd Adds a new search rule to route searches and calls toward a zone or policy service. Name(r): <S: 0, 50> Descriptive name for the search rule. ZoneName: <S: 0, 50> The zone or policy service to query if the alias matches the search rule. Description: <S: 0, 64>...
  • Page 71 xCommand command reference SIPRouteAdd Adds a route that will cause SIP messages matching the given criteria to be forwarded to the specified IP address and port. Note: this command is intended for developer use only. Method(r): <S:0, 64> SIP method to match to select this route (e.g. INVITE, SUBSCRIBE). RequestLinePattern(r): <S:0, 128>...
  • Page 72 xCommand command reference SubZoneAdd Adds and configures a new subzone. SubZoneName(r): <S: 1, 50> Assigns a name to this subzone. TotalMode: <Unlimited/Limited/NoBandwidth> Determines whether this subzone has a limit on the total bandwidth of calls being used by its endpoints at any one time.
  • Page 73 xCommand command reference SubZoneMembershipRuleAdd Adds and configures a new membership rule. Name(r): <S: 1, 50> Assigns a name to this membership rule. Type(r): <Subnet/AliasPatternMatch> The type of address that applies to this rule. Subnet: assigns the device if its IP address falls within the configured IP address subnet.
  • Page 74 xCommand command reference TransformAdd Adds and configures a new transform. Pattern(r): <S: 1, 60> Specifies the pattern against which the alias is compared. Type: <Exact/Prefix/Suffix/Regex> How the pattern string must match the alias for the transform to be applied. Exact: the entire string must exactly match the alias character for character.
  • Page 75 xCommand command reference UserLoginGroupDelete Deletes a user login group. UserLoginGroupId(r): <1..15> The index of the user login group to be deleted. Example: xCommand UserLoginGroupDelete UserLoginGroupId: 1 WarningAcknowledge Acknowledges an existing warning. Note: this command is intended for developer use only. WarningID(r): <S:36, 36>...
  • Page 76 xCommand command reference ZoneDelete Deletes a zone. ZoneId(r): <1..1000> The index of the zone to be deleted. Example: xCommand ZoneDelete ZoneId: 2 ZoneList A diagnostic tool that returns the list of zones (grouped by priority) that would be queried, and any transforms that would be applied, in a search for a given alias.

  • Page 77: Xstatus Command Reference

    xStatus command reference xStatus command reference The xStatus group of commands are used to return information about the current status of the system. Each xStatus element returns information about one or more sub-elements. The following section lists all the currently available xStatus commands, and the information that is returned by each command.
  • Page 78 xStatus command reference Address: <IPv4Addr/IPv6Addr> Port: <1..65534> LastStatusChange: <Seconds since boot/Date Time> Applications Applications: Presence: UserAgent: Status: <Inactive/Initializing/Active/Failed> Presentity: Count: <0..2500> Server: Publications: Presentities: Count: <0..10000> Max: <0..10000> Presentity [1..10000]: URI: <S: 1,255> Document: Count: <1..10> Subscriptions: Subscribers: Count: <0..n> Max: <0..n>...
  • Page 79 xStatus command reference Registration: State: <Registered/Not Registered> Presence: OCS: Machine: State: <Offline/Available/Undefined> User: State: <Undefined/Busy> VCS: State: <Offline/Online/In a call/Undefined> LastUpdate: Time: <date time> SecondsSinceLastRefresh: <seconds> Calls Calls: Call <1..900>: SerialNumber: <S: 1,255> Tag: <S: 1,255> State: <Connecting/Connected/Disconnecting> StartTime: <Seconds since boot/Date Time> Duration: <Time in seconds, precision in seconds>...

  • Page 80: External Manager

    xStatus command reference CallRouted: <True/False> Participants: Leg: <1..300> {2 entries} Bandwidth: Requested: <0..100000000> kbps Allocated: <0..100000000> kbps Route: Zone/Link: <S: 1,50 Node name> {0..150 entries} Media {visible if MediaRouted = True} Channels Channel [1..n] Type: <AUDIO/VIDEO/DATA/BFCP/H224/UNKNOWN> Protocol: <S: 1,20> {RTP Payload Type} Rate: <0..
  • Page 81 xStatus command reference FindMeManager FindMeManager: Mode: <Off/Local/Remote> Status: <Active/Inactive/Unknown> {visible if Remote} Address: <1..1024> {Visible if Remote} H323 H323: Registration: Status: <Active/Inactive/Failed> IPv4: {Visible if Status=Active} Address: <IPv4Addr> {1..2 entries} IPv6: {Visible if Status=Active} Address: <IPv6Addr> {1..2 entries} OutOfResources: <True/False> CallSignaling: Status: <Active/Inactive/Failed>...
  • Page 82 xStatus command reference LDAP: Status: <Inactive/Initializing/Active/Failed> Cause: {visible if status is Failed} <Failed to connect to LDAP server / The LDAP server does not support TLS. / Failed to establish a TLS connection to the LDAP server. Please check that the LDAP server certificate is signed by a CA, and that CA is included on the CA certificate installed on the VCS.
  • Page 83 xStatus command reference Pipes: Pipe [1..1000]: Name: <S: 1,50 Pipe name> Bandwidth: LocalUsage: <0..100000000> ClusterUsage: <0..100000000> Calls: Call [0..900]: {0..900 entries} CallID: <S: 1,255> Policy PolicyServices: PolicyService [1..5]: Name: <S: 1,50 Policy name> Status: <Active/Inactive> URL: <S: 1,255> LastUsed: <Time not set/Date Time> Peers: Peer [1..3]: Host: <S: 0,255>...
  • Page 84 xStatus command reference AOR: <S: 1,128> Contact: <S: 1,255> Path: URI [1..10]: <S: 1,255> ResourceUsage ResourceUsage: Calls: Traversal: Current: <0..150> Max: <0..150> Total: <0..4294967295> NonTraversal: Current: <0..750> Max: <0..750> Total: <0..4294967295> Registrations: Current: <0..3750> Max: <0..3750> Total: <0..4294967295> TURN: Relays: Current: <0..1400>...
  • Page 85 SystemUnit SystemUnit: Product: TANDBERG VCS Uptime: <Time in seconds> SystemTime: <Time not set/date-time> TimeZone: <GMT or one of 300 other timezones> LocalTime: <local-date-time> Software: Version: X<n> Build: <Number/Uncontrolled> Name: “Release” ReleaseDate: <Date> ReleaseKey <ReleaseKey> Configuration: NonTraversalCalls: <0..500>...
  • Page 86 xStatus command reference Peer: Address: <IPv4Addr/IPv6Addr> CreationTime: <Date Time> ExpireTime: <Date Time> Counters: Received: Requests: Total: <0..65535> Allocate: <0..65535> Refresh: <0..65535> Permission: <0..65535> ChannelBind: <0..65535> Sent: Responses: Total: <0..65535> Allocate: <0..65535> Refresh: <0..65535> Permission: <0..65535> ChannelBind: <0..65535> Errors: Total: <0..65535> Allocate: <0..65535>...
  • Page 87 xStatus command reference Name: “DefaultZone” Bandwidth: LocalUsage: <0..100000000> ClusterUsage: <0..100000000> Calls: {visible only if there are calls} Call [0..900]: {0..900 entries} CallId: <S: 1,255> LocalZone: DefaultSubZone: Name: “DefaultSubZone” Bandwidth: LocalUsage: <0..100000000> ClusterUsage: <0..100000000> Registrations: {0..3750 entries } {visible only if there are registrations} Registration: <1..3750>...
  • Page 88 xStatus command reference Cause: {Visible if status is Failed or Warning} <System unreachable/ Systems unreachable> Type: <Neighbor/TraversalClient/TraversalServer/ENUM/DNS> Neighbor: {Visible if Type is Neighbor} Peer [1..6]: H323: {visible if H323 Mode=On for Zone} Status: <Unknown/Active/Failed> Cause: {visible if Status is Failed} <No response from gatekeeper/DNS resolution failed/Invalid IP address>...
  • Page 89 xStatus command reference LastStatusChange: <Time not set/Date Time> Calls: {0..900 entries} Call [0..900]: CallID: <S: 1,255> Cisco VCS Command Reference (X6) Page 89 of 95...

  • Page 90: Restoring Default Configuration

    Restoring default configuration Restoring default configuration It is possible to restore the Cisco VCS to its default configuration. This is done through the CLI using xCommand DefaultValuesSet. This command is not available through the web interface. The DefaultValuesSet command allows you to specify the level of configuration to restore, from 1 to 3 as follows: Level 1: resets most configuration items to their default value, with the exception of the Level 2 and Level 3 items shown in the tables below.

  • Page 91: Configuration Items Reset By Defaultvaluesset Level 2

    SystemUnit AdminAccount [1..15] Password <blank> SystemUnit Maintenance Mode SystemUnit Name <blank> SystemUnit Password TANDBERG SystemUnit StrictPassword Enforce Configuration items reset by DefaultValuesSet level 2 The following table lists the configuration items that are reset by xCommand DefaultValuesSet Level: 2 and their reset values.
  • Page 92 Restoring default configuration Configuration item Reset value Login Administrator Groups Group [1..30] Access ReadWrite Login Administrator Groups Group [1..30] Name <blank> Login Administrator Source Local Login Remote LDAP BaseDN Accounts <blank> Login Remote LDAP BaseDN Groups <blank> Login Remote LDAP DirectoryType ActiveDirectory Login Remote LDAP Encryption Login Remote LDAP SASL...

  • Page 93: Policy Services

    Policy services Policy services Policy services are typically used in large-scale deployments where policy decisions can be managed through an external, centralized service rather than by configuring policy rules on the Cisco VCS itself. You can configure the Cisco VCS to use policy services in the following areas: Registration Policy Search rules (dial plan) Call Policy...

  • Page 94: Policy Service Responses

    Policy services Parameter name Values Registration Search Call Policy rules Policy TRAVERSAL_TYPE TYPE_[UNDEF / ASSENTSERVER / ASSENTCLIENT / H460SERVER / H460CLIENT / TURNSERVER / TURNCLIENT / ICE] UNAUTHENTICATED_ SOURCE_ALIAS UTCTime ZONE_NAME Policy service responses The Cisco VCS expects the response from the policy service to include an item of CPL which will then be validated and processed by the Cisco VCS.
  • Page 95 THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.

This manual is also suitable for:

Telepresence video communication server

Table of Contents