Cisco TELEPRESENCE VIDEO COMMUNICATION SERVER - COMMAND REFERENCE V... Manuel d'utilisation

Cisco TelePresence

Video Communication

Server

Command Reference

D14754.01

January 2010

Software version: X6

Cisco VCS Command Reference (X6) Page 2 of 95

Contents

Introduction 3

Using the command line interface (CLI) 3

CLI command types 3

xConfiguration command reference 4

xConfiguration commands 4

xCommand command reference 58

xCommand commands 58

xStatus command reference 77

xStatus elements 77

Restoring default configuration 90

Configuration items reset by DefaultValuesSet level 3 90

Configuration items reset by DefaultValuesSet level 2 91

Policy services 93

Policy service request parameters 93

Policy service responses 94

Introduction

Cisco VCS Command Reference (X6) Page 3 of 95

Introduction

This Command Reference document provides supplementary information regarding the administration of

the Cisco TelePresence Video Communication Server (Cisco VCS). It includes:

ndetails of the commands available through the Cisco VCS's command line interface (CLI)

na 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).

The CLI is available by default over SSH and through the serial port. Access using Telnet can also be

enabled.

To use the CLI:

1. Start an SSH or Telnet session.

2. Enter the IP address or FQDN of the Cisco VCS.

3. Log in with a username of admin and your system password.

4. You can now start using the CLI by typing the appropriate commands.

CLI command types

CLI commands are divided into the following groups:

nxStatus: these commands return information about the current status of the system. Information

such as current calls and registrations is available through this command group. See xStatus

command reference for a full list of xStatus commands.

nxConfiguration: these commands allow you to add and edit single items of data such as IP

address and zones. See xConfiguration command reference for a full list of xConfiguration

commands.

nxCommand: these commands allow you to add and configure items and obtain information. See

xCommand command reference for a full list of xCommand commands.

nxHistory: these commands provide historical information about calls and registrations.

nxFeedback: these commands provide information about events as they happen, such as calls and

registrations.

Note that:

nTyping an xConfiguration path into the CLI returns a list of values currently configured for that

element (and sub-elements where applicable).

nTyping an xConfiguration path into the CLI followed by a ? returns information about the usage for

that element and sub-elements.

nTyping an xCommand command into the CLI with or without a ? returns information about the usage of

that command.

xConfiguration command reference

Cisco VCS Command Reference (X6) Page 4 of 95

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. The valid values for each

command are indicated in the angle brackets following each command, using the following notation:

Format Meaning

<0..63> Indicates an integer value is required. The numbers indicate the minimum and

maximum value.

In this example the value must be in the range 0 to 63.

<S: 7,15> An Sindicates a string value, to be enclosed in quotation marks, is required. The

numbers indicate the minimum and maximum number of characters for the string.

In this example the string must be between 7 and 15 characters long.

<Off/Direct/Indirect> Lists the set of valid values for the command. Do not enclose the value in quotation

marks

[1..50] Square brackets indicate that you can configure more than one of this particular item.

Each item is assigned an index within the range shown.

For example IP Route [1..50] Address <S: 0,39> means that up to 50 IP routes

can be specified with each route requiring an address of up to 39 characters in length.

To obtain information about existing configuration, type:

nxConfiguration to return all current configuration settings

nxConfiguration <element> to return all current configuration for that particular element and all its

sub-elements

nxConfiguration <element> <subelement>to return all current configuration for that group of

sub-elements

To obtain information about using each of the xConfiguration commands, type:

nxConfiguration ? to return a list of all elements available under the xConfigurationcommand

nxConfiguration ?? to return a list of all elements available under the

xConfigurationcommand, along with the valuespace, description and default values for each

element

nxConfiguration <element> ? to return all available sub-elements and their valuespace,

description and default values

nxConfiguration <element> <sub-element> ? to return all available sub-elements and their

valuespace, description and default values

xConfiguration commands

All of the available xConfiguration commands are listed in the table below:

xConfiguration command reference

Cisco VCS Command Reference (X6) Page 5 of 95

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>

Determines whether the VCS can be accessed via the web interface. This must be On to enable both web

interface and TMS access.

Note: you must restart the system for any changes to take effect.

Default: On

Example: xConfiguration Administration HTTPS Mode: On

Administration HTTPS RequireClientCertificate: <On/Off>

Determines whether the VCS requires a valid client certificate from your web browser before setting up an

HTTPS session. Note: this does not affect client verification of the VCS's server certificate.

Default: Off

Example: xConfiguration Administration HTTPS RequireClientCertificate: On

Administration LCDPanel Mode: <On/Off>

Controls whether the LCD panel on the front of the VCS identifies the system.

On: the system name and first active IP address are shown.

Off: the LCD panel reveals no identifying information about the system.

Default: On

Example: xConfiguration Administration LCDPanel Mode: On

Administration SSH Mode: <On/Off>

Determines whether the VCS can be accessed via SSH and SCP.

Note: you must restart the system for any changes to take effect.

Default: On

Example: xConfiguration Administration SSH Mode: On

Administration Telnet Mode: <On/Off>

Determines whether the VCS can be accessed via Telnet.

Note: you must restart the system for any changes to take effect.

Default: Off

Example: xConfiguration Administration Telnet Mode: Off

Administration TimeOut: <0..10000>

Sets the number of minutes that an administration session (HTTPS, Telnet or SSH) may be inactive before

the session is timed out. A value of 0 turns session time outs off.

Default: 0

Example: xConfiguration Administration TimeOut: 0

xConfiguration command reference

Cisco VCS Command Reference (X6) Page 6 of 95

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. Refer to the Clustering and peers

section of the VCSAdministrator Guide for more information.

Example: xConfiguration Alternates Cluster Name: "Regional"

Alternates ConfigurationMaster: <1..6>

Specifies which peer in this cluster is the master, from which configuration will be replicated to all other

peers. A cluster consists of up to 6 peers, including the local VCS.

Example: xConfiguration Alternates ConfigurationMaster: 1

Alternates Peer [1..6] Address: <S: 0, 128>

Specifies the IP address of one of the peers in the cluster to which this VCS belongs. A cluster consists of up

to 6 peers, including the local VCS.

Note: this must be a valid IPv4 or IPv6 address.

Example: xConfiguration Alternates 1 Peer Address: "10.13.0.2"

Applications ConferenceFactory Alias: <S:0,60>

The alias that will be dialed by the endpoints when the Multiway feature is activated. This must be pre-

configured on all endpoints that may be used to initiate the Multiway feature.

Example: xConfiguration Applications ConferenceFactory Alias: "multiway@example.com"

Applications ConferenceFactory Mode: <On/Off>

The Mode option allows you to enable or disable the Conference Factory application.

Default: Off

Example: xConfiguration Applications ConferenceFactory Mode: Off

Applications ConferenceFactory Range End: <1..65535>

The last number of the range that replaces %% in the template used to generate a conference alias.

Default: 65535

Example: xConfiguration Applications ConferenceFactory Range End: 30000

Applications ConferenceFactory Range Start: <1..65535>

The first number of the range that replaces %% in the template used to generate a conference alias.

Default: 65535

Example: xConfiguration Applications ConferenceFactory Range Start: 10000

Applications ConferenceFactory Template: <S:0,60>

The alias that the VCS will tell the endpoint to dial in order to create a Multiway conference on the MCU.

Note: this alias must route to the MCU as a fully-qualified SIP alias

Example: Applications ConferenceFactory Template: "563%%@example.com"

Applications External Status [1..10] Filename: <S:0,255>

XML file containing status that is to be attached for an external application.

Example: xConfiguration Applications External Status 1 Filename: "foo.xml"

xConfiguration command reference

Cisco VCS Command Reference (X6) Page 7 of 95

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>

The SIP domain in use on the Microsoft Office Communications Server. This must be selected from one of

the SIP domains already configured on the VCS, and must be the same domain used by all FindMe names.

Example: xConfiguration Applications OCS Relay OCS Domain: "example.com"

Applications OCS Relay OCS Routing Prefix: <S:0,128>

Prefix applied to requests routed through the VCS proxy, from the OCS Relay. This is then used to route the

requests onto to the appropriate Microsoft Office Communications Server (via Neighbor zone matches).

Default: ocs

Example: xConfiguration Applications OCS Relay OCS Routing Prefix: "ocs"

Applications Presence Server Mode: <On/Off>

Enables and disables the SIMPLE Presence Server. Note: SIP mode must also be enabled for the Presence

Server to function.

Default: Off

Example: xConfiguration Applications Presence Server Mode: On

Applications Presence Server Publication ExpireDelta: <30..7200>

Specifies the maximum time (in seconds) within which a publisher must refresh its publication.

Default: 1800

Example: xConfiguration Applications Presence Server Publication ExpireDelta: 1800

Applications Presence Server Subscription ExpireDelta: <30..7200>

Specifies the maximum time (in seconds) within which a subscriber must refresh its subscription.

Default: 3600

Example: xConfiguration Applications Presence Server Subscription ExpireDelta: 3600

Applications Presence User Agent ExpireDelta: <1..65534>

Specifies the lifetime value (in seconds) the Presence User Agent will advertise in the PUBLISH messages it

sends to the Presence Server. The Presence User Agent will refresh its PUBLISH messages at 75% of this

value (to keep them active). The Presence Server may reduce this value in its responses.

Default: 3600

Example: xConfiguration Applications Presence User Agent ExpireDelta: 3600

Applications Presence User Agent Mode: <On/Off>

Enables and disables the SIMPLE Presence User Agent (PUA). The PUA provides presence information on

behalf of registered endpoints. SIP mode must also be enabled for the PUA to function.

Default: Off

Example: xConfiguration Applications Presence User Agent Mode: Off

xConfiguration command reference

Cisco VCS Command Reference (X6) Page 8 of 95

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>

The Kerberos realm used when the VCS joins the AD domain. Note: this field is case sensitive.

Example: xConfiguration Authentication ADS ADDomain:

Authentication ADS Clockskew: <1..65535>

Maximum allowed clockskew between the VCS and the KDC before the Kerberos message is assumed to

be invalid (in seconds).

Default: 300

Example: xConfiguration Authentication ADS Clockskew: 300

Authentication ADS DC [1..5] Address: <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: xConfiguration Authentication ADS DC 1 Address: "192.168.0.0"

Authentication ADS Encryption: <Off/TLS>

Sets the encryption to use for the connection to the ADS server.

Off: no encryption is used.

TLS: TLS encryption is used.

Default: TLS

Example: xConfiguration Authentication ADS Encryption: TLS

Authentication ADS KDC [1..5] Address: <S: 0,39>

The address of a Kerberos Distribution Center (KDC) to be used when connected to the AD domain. Not

specifying a specific KDC will result in the use of DNS SRV queries to find a KDC.

Example: xConfiguration Authentication ADS KDC 1 Address: "192.168.0.0"

Authentication ADS KDC [1..5] Port: <1..65534>

Specifies the port of a KDC that can be used when the VCS joins the AD domain.

Default: 88

Example: xConfiguration Authentication ADS KDC 1 Port: 88

Authentication ADS Mode: <On/Off>

Indicates if the VCS should attempt to form a relationship with the AD.

Default: Off

Example: xConfiguration Authentication ADS Mode: On

xConfiguration command reference

Cisco VCS Command Reference (X6) Page 9 of 95

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.

Default: Auto

Example: xConfiguration Authentication ADS SecureChannel: Auto

Authentication ADS Workgroup: <S: 0,15>

The workgroup used when the VCS joins the AD domain.

Example: xConfiguration Authentication ADS Workgroup:

Authentication Credential [1..2500] Name: <S: 0, 128>

Defines the name for this entry in the local authentication database.

Example: xConfiguration Authentication Credential 1 Name: "john smith"

Authentication Credential [1..2500] Password: <S: 0, 215>

Defines the password for this entry in the local authentication database. The maximum plaintext length is

128 characters, which will then be encrypted.

Example: xConfiguration Authentication Credential 1 Password: "password123"

Authentication Database: <LocalDatabase/LDAPDatabase>

Selects between a local authentication database and a remote LDAP repository for the storage of password

information for authentication.

Default: LocalDatabase

Example: xConfiguration Authentication Database: LocalDatabase

Authentication LDAP AliasOrigin: <LDAP/Endpoint/Combined>

Determines which aliases (i.e. from the LDAP repository or the endpoint) should be used to register the

endpoint.

Combined: the endpoint will be registered both with the aliases which it has presented and with those

configured in the LDAP repository.

Default: LDAP

Example: xConfiguration Authentication LDAP AliasOrigin: LDAP

Authentication LDAP BaseDN: <S: 0, 255>

Specifies the Distinguished Name to use when connecting to an LDAP server.

Example: xConfiguration Authentication LDAP BaseDN: "dc=example,dc=company,dc=com"

Authentication Password: <S: 0, 215>

The password used by the VCS when authenticating with another system. The maximum plaintext length is

128 characters, which is then encrypted. Note: this does not apply to traversal client zones.

Example: xConfiguration Authentication Password: "password123"

xConfiguration command reference

Cisco VCS Command Reference (X6) Page 10 of 95

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.

Default: 384

Example: xConfiguration Bandwidth Default: 384

Bandwidth Downspeed PerCall Mode: <On/Off>

Determines whether or not the VCS will attempt to downspeed a call if there is insufficient per-call bandwidth

available to fulfill the request.

On: the VCS will attempt to place the call at a lower bandwidth.

Off: the call will be rejected.

Default: On

Example: xConfiguration Bandwidth Downspeed PerCall Mode: On

Bandwidth Downspeed Total Mode: <On/Off>

Determines whether or not the VCS will attempt to downspeed a call if there is insufficient total bandwidth

available to fulfill the request.

On: the VCS will attempt to place the call at a lower bandwidth.

Off: the call will be rejected.

Default: On

Example: xConfiguration Bandwidth Downspeed Total Mode: On

Bandwidth Link [1..3000] Name: <S: 1, 50>

Assigns a name to this link.

Example: xConfiguration Bandwidth Link 1 Name: "HQ to BranchOffice"

Bandwidth Link [1..3000] Node1 Name: <S: 0, 50>

Specifies the first zone or subzone to which this link will be applied.

Example: xConfiguration Bandwidth Link 1 Node1 Name: "HQ"

Bandwidth Link [1..3000] Node2 Name: <S: 0, 50>

Specifies the second zone or subzone to which this link will be applied.

Example: xConfiguration Bandwidth Link 1 Node2 Name: "BranchOffice"

Bandwidth Link [1..3000] Pipe1 Name: <S: 0, 50>

Specifies the first pipe to be associated with this link.

Example: xConfiguration Bandwidth Link 1 Pipe1 Name: "512Kb ASDL"

Bandwidth Link [1..3000] Pipe2 Name: <S: 0, 50>

Specifies the second pipe to be associated with this link.

Example: xConfiguration Bandwidth Link 1 Pipe2 Name: "2Gb Broadband"

Ce manuel convient aux modèles suivants

Table des matières

Autres manuels Cisco Système de conférence

Cisco

Cisco TelePresence IX5000 Guide de configuration

Cisco

Cisco TelePresence DX80 Manuel utilisateur

Cisco

Cisco Service Manual Manuel utilisateur

Cisco

Cisco TelePresence SX20 Manuel utilisateur

Cisco

Cisco TelePresence MXP Series Manuel de service

Cisco

Cisco TelePresence MX700 Manuel de service

Cisco

Cisco TelePresence Touch for MX Series Manuel utilisateur

Cisco

Cisco UNIFIED COMMUNICATIONS UC320W Mode d’emploi

Cisco

Cisco Webex Room Kit Plus Precision 60 Manuel utilisateur

Cisco

Cisco TelePresence SX20 Instructions originales

Cisco

Cisco TelePresence EX Series Manuel utilisateur

Cisco

Cisco TelePresence DX70 Manuel utilisateur

Cisco

Cisco CTS-SX10-K9 Manuel utilisateur

Cisco

Cisco EX60 Manuel utilisateur

Cisco

Cisco 3515 MCU12 Manuel d'installation et d'exploitation

Cisco

Cisco MX200 G2 Manuel de service

Cisco

Cisco TelePresence Manuel utilisateur

Cisco

Cisco SX80 Manuel de service

Cisco

Cisco TelePresence DX70 Manuel de service

Cisco

Cisco 7937 Manuel utilisateur

Cisco

Cisco Spark Board 55 Manuel utilisateur

Cisco

Cisco TelePresence DX70 Manuel utilisateur

Cisco

Cisco Webex DX70 Manuel de service

Cisco

Cisco TelePresence System Codec C40 Manuel utilisateur

Manuels Système de conférence populaires d'autres marques

Kramer

Kramer VIA GO Manuel utilisateur

AVT

AVT MAGIC AC1 Go Manuel utilisateur

ProSoft Technology

ProSoft Technology AN-X4-AB-DHRIO Manuel utilisateur

Sony

Sony PCS-I150 Manuel utilisateur

Middle Atlantic Products

Middle Atlantic Products VTC Series Manuel utilisateur

Prentke Romich Company

Prentke Romich Company Vanguard Plus Mode d’emploi

Speakerbus

Speakerbus iD 712 Manuel utilisateur

Trelleborg

Trelleborg SafePilot CAT PRO Manuel utilisateur

Sennheiser

Sennheiser ADN Manuel utilisateur

ADTRAN

ADTRAN NetVanta 7100 Manuel utilisateur

AINA

AINA PTT Voice Responder Manuel utilisateur

Yamaha

Yamaha ProjectPhone PJP-100H Manuel utilisateur

vissonic

vissonic VLI Series Manuel utilisateur

Panasonic

Panasonic KX-VC500 Manuel utilisateur

Poly

Poly Trio 8300 Manuel utilisateur

Crestron

Crestron Mercury CCS-UCA-SMK Dessin dimensionnel

Inmarsat

Inmarsat mini M Manuel utilisateur

Tenveo

Tenveo ALL-IN-ONE Manuel utilisateur