246, Example xCommand DomainDelete DomainId | TANDBERG D14049.04

Grey Headline (continued)

Command Reference - xCommand

TANDBERG VIDEO COMMUNICATIONS SERVER ADMINISTRATOR GUIDE

DisconnectCall

Disconnects a call.

Call: <1..900>

The index of the call to be disconnected.

CallSerialNumber: <S: 1, 255>

The serial number of the call to be disconnected.

Note: you must specify either a call index or call serial number when using this command.

Example: xCommand DisconnectCall CallSerialNumber: "6d843434-211c-11b2-b35d-0010f30f521c"

DomainAdd

Adds a SIP domain for which this VCS is authoritative.

DomainName(r): <S: 1, 128>

Specifies a domain for which this VCS is authoritative. The VCS will act as a SIP Registrar and Presence Server for this domain, and will accept registration requests for any SIP endpoints attempting to register with an alias that includes this domain.

Example: xCommand DomainAdd DomainName: "example.com"

DomainDelete

Deletes a domain.

DomainId(r): <1..20>

The index of the domain to be deleted.

Example: xCommand DomainDelete DomainId: 2

FeedbackDeregister

Deactivates a particular feedback request.

ID: <1..3>

The index of the feedback request to be deactivated.

Example: xCommand FeedbackDeregister ID: 1

Introduction

Getting Started

Overview and

System

VCS

Zones and

Call

Bandwidth

Firewall

Applications

Maintenance

Appendices

Status

Configuration

Configuration

Neighbors

Processing

Control

Traversal

D14049.04

246

JULY 2008

Image 246

TANDBERG D14049.04 manual 246, Example xCommand DomainAdd DomainName example.com, Example xCommand DomainDelete DomainId

Contents

Guide Introduction What’s in this Manual?Preamble Getting Started Overview and Status DNS VCS Configuration NTP Zones and Neighbors Call Processing Bandwidth Control 151 Maintenance Applications Appendices Legal Notices Copyright 2008, Tandberg Safety Instructions and Approvals Safety InstructionsApprovals Environmental Issues TANDBERG’s Environmental PolicyWaste Handling Digital User Guides Environmental Issues Overview VCS and the Tandberg Total Solution Tandberg VCS VCS Base Applications VCS ControlVCS Expressway Standard Features Optional Features Dual Network InterfacesUser Policy FindMe What’s New in this Version? Command Line Interface Administrator GuideUsing this Administrator Guide Typographical conventions Getting Started General Installation Precautions InstallationInstallation Site Preparations Connecting the Cables Initial Configuration Powering on the VCS Initial Configuration via Serial Cable Initial Configuration via Front Panel UP keyDown key System Administrator Access Overview Web Interface Using the Web InterfaceSelect Administrator Login Supported Browsers General page features Types of Commands Command Line Interface Supported CharactersUsing the Command Line Interface CLI How Command are Shown in this Guide Overview and Status Overview Viewing the Overview Understanding the Overview System Information Ethernet Status System Ethernet MAC addressSpeed IP Status Viewing the IP Status Understanding the IP Status Resource Usage Viewing the Resource Usage Understanding the Resource UsageStatus System Resource Usage Traversal calls Registrations Viewing the Registrations Understanding the Registrations Duration Registration HistoryReason End Time Presence Viewing the Presence Status PagesPublishers Presentities Subscribers Calls Viewing the Calls Understanding the Calls Call History Viewing the Call History Understanding the Call HistoryStatus Call History Filter About Searches Search HistoryViewing the Search History Understanding the Search History Status Search History Local Zone Viewing the Local Zone Understanding the Local Zone Zones Viewing the Zones Understanding the ZonesStatus Zones Links Viewing the Links Understanding the LinksStatus Links Understanding the Pipes PipesViewing the Pipes Status Pipes Stun Relays Viewing the Stun Relays Understanding the Stun Relays Applications Viewing the Applications Understanding the ApplicationsStatus Applications Viewing the Warnings Understanding the Warnings Status Warnings Event Log Color Coding Event LogViewing the Event Log Understanding the Event Log Event Log Levels Interpreting the Event Log Event Log Format Message Details Field Event Events and Levels Message Sent Message ReceivedMessage Rejected Registration Accepted TLS Negotiation Error System Backup errorSystem Restore error User session Login failure Understanding the Configuration Log Configuration LogViewing the Configuration Log Types of Configuration Events System Configuration About Administrator Access settings System AdministrationOverview Configuration About the System Name About Ethernet Speed System Configuration EthernetXConfiguration Ethernet Ethernet speed XConfiguration IP Route XCommand RouteAdd Overview IP ConfigurationXConfiguration IP XConfiguration IPProtocol About IPv4 to IPv6 Gatewaying About Dual Network Interfaces Overview LAN ConfigurationAbout LAN Configuration IPv4 subnet mask XConfiguration IP DNS About DNS ServersAbout the DNS Domain Name About the NTP Server System Configuration NTPXConfiguration NTP Address XConfiguration TimeZone Name About the Time Zone XConfiguration Snmp About Snmp About the External Manager XConfiguration ExternalManagerExternal Manager Address About Remote Logging LoggingAbout Logging Remote Logging Log Levels Setting the Event Log LevelXConfiguration Log Level About Event Log Levels VCS Configuration 323 Overview Endpoint Registration Configuring H.323 XConfiguration H323 About SIP on the VCS Using the VCS as a SIP RegistrarSIP Overview SIP Registration Expiry Using the VCS as a SIP Proxy Server Using the VCS as a SIP Presence ServerSIP protocols and ports Configuring SIP Registrations, Protocols and Ports XConfiguration SIP Cancel Configuring SIP DomainsVCS Configuration Protocols SIP Domains View/Edit Save SIP interworking mode Configuring InterworkingXConfiguration Interworking Mode Interworking Registration Overview MCU, Gateway and Content Server RegistrationRegistration Control Endpoint Registration Preventing automatic registrations Finding a VCS with which to Register323 H323 Gatekeeper AutoDiscovery Configuring Authentication AuthenticationAuthentication Mode Authentication for Local Registrations Configuring External Registration Credentials About External Registration Credentials Authentication Databases Alias Origin SettingAuthentication using an Ldap Server Configuring Ldap Server settings XConfiguration Ldap XConfiguration Authentication Ldap Authentication using a Local Database Configuring the Local Database About Alias Registration Attempts to Register using an Existing AliasRegistering Aliases Alias Registration Activating use of Allow or Deny Lists Allow and Deny ListsAbout Allow and Deny Lists Removing existing registrations XCommand AllowListAdd XConfigurationAllowList Registration Managing Entries in the Allow List Managing Entries in the Deny List VCS Configuration Registration Deny ListXCommand DenyListAdd XConfigurationDenyList Registration Add Deny List Pattern Zones and Neighbors Example Network Diagram IntroductionAbout your Video Communications Network Bandwidth Management Overview Configuring the Local Zone and its SubzonesLocal Zone and Subzones Local Zone Matches Traversal Subzone Configuring the Traversal Subzone PortsVCS Configuration Local Zone Traversal Subzone What are traversal calls? About Zones Traversal Client Zone Traversal Server Zone Neighbor Zone Enum Zone DNS Zone Default Zone XCommand DefaultLinksAdd XCommand ZoneAdd Adding Zones Configuring ZonesVCS Configuration Zones XConfiguration Zones Zone Configuring Zones All Types Hop countMatch1 Match5 Configuring Neighbor Zones Configuring Traversal Client Zones Authentication usernameRetry interval Configuring Traversal Server Zones Configuring Enum Zones DNS suffix Configuring DNS Zones Clustering, Peers and Alternates About ClusteringCluster Subzone Prerequisites Administration Accounts IP configurationDNS Configuration System Name SIP Registrations Backup and RestoreRegistrations Upgrading to Clustering and Presence ConfigurationClustering and FindMe Viewing Peers Enabling the Replication of FindMe Information 100 Neighboring the Local VCS to a ClusterPeer 1...Peer 6 address 101 Dial Plans 102 Call Processing Call Processing Diagram 103Search Process Dialing by IP Address Dialing by H.323 or SIP URI 104Dialing by Address Types Dialing by Enum 105 About Hop Counts Configuring Hop CountsXConfiguration Zones Zone 1..200 HopCount Hop Counts Overview of Searches and Transforms 106Searches and Transforms Pre-Search Transforms Configuring Pre-Search Transforms XConfiguration Transform107 108 Zone Searching and Transforming 109 Configuring Zone Searches and TransformsDefault Settings Local Zone Combining Match Types and Priorities 110Examples Never Query a Zone 111 Filter Queries to a Zone Without Transforming 112 Query a Zone for Original and Transformed Alias 113 Query a Zone for Two or More Transformed Aliases Authentication Mode Off About Call Policy Administrator Policy and AuthenticationAuthentication Mode On 114 VCS Configuration Call Policy Administrator PolicyEnabling the use of Administrator Policy Administrator Policy Mode Configuring Administrator Policy via the Web Interface 116 117 Uploading a CPL ScriptAbout CPL XSD files 118 URI DialingH323 URI Dialing for Outgoing Calls Configuring Matches for DNS Zones119 Process 120 Adding and Configuring DNS ZonesXCommand ZoneAdd XConfiguration Zones Zone Advanced Configuring DNS Servers XConfiguration IP DNS Server121 122 URI Dialing for Incoming Calls 123 Example DNS Record ConfigurationRecommended Configuration URI Dialing and Firewall Traversal 124 Enum DialingOverview Process Enabling Enum Dialing Example 125Enum Dialing for Outgoing Calls 7.6.5.4.3.2.1.4.4 Mode of PatternMatch Pattern string Pattern type of Prefix Configuring Matches for Enum ZonesConfiguring Transforms for Enum Zones 126 Configuring Enum Zones 127Click Create Zone 128 Enum Dialing for Incoming Calls Configuring DNS Naptr Records129 About DNS Domains for Enum 130 Recommended Configuration for Firewall TraversalXConfiguration Call Services Unregistered Endpoints 131 Overview Configuration Example UsageXConfiguration Call Services Fallback Alias Fallback Alias 132 Call IDs, Serial Numbers and TagsIdentifying a Particular Call Issues when Disconnecting SIP Calls Disconnecting CallsDisconnecting a Call via the Web Interface 133 134 Bandwidth Control 135 Bandwidth Control OverviewBandwidth Control on the VCS Example Network Deployment Subzones About the Default Subzone136 Specifying the Subzone IP Addresses Subzone Links XCommand SubZoneAdd 137Creating a Subzone Configuring a Subzone XConfiguration Zones LocalZone SubZone138 Types of Limitations 139Applying Bandwidth Limitations to Subzones How Different Bandwidth Limitations are Managed 140 Default LinksXCommand LinkAdd About Links Creating Links XConfiguration Bandwidth Link 141Editing Links Pre-Configured Links Default LinksAbout Default Links 142 XCommand PipeAdd 143About Pipes Creating Pipes Editing Pipes XConfiguration Bandwidth Pipe144 Editing an Existing Pipe One Pipe, One Link 145Applying Pipes to Links One Pipe, Two or More Links Configuring Default Call Bandwidth and Downspeeding Default Bandwidth and DownspeedingAbout the Default Call Bandwidth 146 147 Bandwidth Control ExamplesExample Without a Firewall 148 VCS Expressway Subzone ConfigurationVCS Control Subzone Configuration Example With a Firewall 149 Firewall Traversal About Expressway VCS as a Firewall Traversal Client 150Firewall Traversal Overview How does it work? Quick Guide to VCS Traversal Client Server Configuration 151VCS Expressway Server Overview Expressway Process Firewall Traversal Protocols 152Firewall Traversal Protocols and Ports SIP Firewall Traversal Protocols Media Call signaling153 SIP Ports Configuration Zones Edit Zone, in the Configuration section Firewall Traversal and AuthenticationAuthentication and NTP 154 Other Issues 155 Adding a New Traversal Client Zone Configuring the VCS as a Traversal Client156 TraversalClient Create Zone Configuring a Traversal Client Zone 157 Adding a New Traversal Server Zone Configuring the VCS as a Traversal Server158 TraversalServer Create Zone Demux mode Configuring a Traversal Server ZoneClient authentication username 159 Configuring Traversal for Endpoints XConfiguration Zones LocalZone Traversal H323160 Configuring Traversal Server Ports 161 Stun Services 162 Configuring Stun Services 163 164 165 FindMe User Policy 166 Configuring User Policy ManagerXConfiguration Policy UserPolicy Enabling FindMe on the VCS 167 Managing FindMe User AccountsAbout User Accounts Creating a New User Account Changing a User Password Viewing Existing User Account Settings168 169 Deleting a User AccountAre you sure...? 170 Using TANDBERG’s FindMeAccessing the FindMe Configuration About your FindMe User Account Configuring your FindMe User Account 171 172 Overview Presence Server Aggregation of Presence Information 173Presence User Agent PUA Registration refresh period Disabled Enabling and Disabling Presence ServicesEnabled 174 Publishers 175Viewing Presence Status Presentities Maintenance 176 177 Overview Upgrading Using SCP/PSCPInstalling and Restarting Upgrading Software 178 Upgrading via the Web Interface 179 Software upgrade in progressSoftware successfully upgraded Restart system Downgrade Procedure Impact on features introduced 180Downgrading Software Option Keys XConfiguration Option 1..64 Key181 Overview Adding Options via the CLI Adding Options via the Web Interface Maintenance Option Keys182 Add option key 183 SecurityOverview Enabling Security Administration Accounts Adding an Administration Account184 Editing an Administration Account Account Disabled This account can not be used185 186 Backup and RestoreOverview Creating a Backup of your VCS Configuration Limitations Restoring a Previous Backup 187 System Snapshot Error Reports188 Overview Creating a System Snapshot 189 Maintenance RestartXCommand Boot Restarting Shutting Down Maintenance Shutdown190 Overview Shutting Down XCommand DefaultValuesSet Level 3 must be Restoring Default ConfigurationOverview DefaultValuesSet Level 191 Command Line Interface Password EncryptionOverview Maximum length of Passwords 192 193 Appendices CPL Reference Address-switch194 Overview of CPL on the VCS 195 Field 196 SubfieldOtherwise Not-present Location Rule-switch197 Reject CPL Examples Call Screening of Authenticated Users198 Call Screening Based on Alias Change of Domain Name 199Call Screening Based on Domain Dont accept calls from this source 200 Block Calls from Default Zone and Default SubzoneAddress Address is=DefaultSubZone Allow Calls from Locally Registered Endpoints Only Using the rule-switch node Restricting Access to a Local GatewayUsing the address-switch node 201 Overview Common Regular Expressions 202Regular Expression Reference Matches 0 or more repetitions of the previous match 203 Pattern Variable Reference VCS Port Reference VCS Configuration Protocols H.323204 VCS Ports XConfiguration SIP TLS Port XConfiguration Traversal Server Stun Relay PortXConfiguration SIP TCP Port XConfiguration H323 Gatekeeper CallSignaling PortRange End XConfiguration Traversal Media Port Start XConfiguration SIP TCP Outbound Port StartXConfiguration SIP TCP Outbound Port End 206 Overview Microsoft DNS Server DNS Configuration207 Verifying the SRV Record 208 Ldap ConfigurationDownloading the Ldap schemas About the Ldap Databases Securing with TLS 209Adding H.350 Objects Create the Organizational Hierarchy Include /etc/openldap/schemas/sipidentity.ldif 210OpenLDAP 211 # MeetingRoom1 endpointSlapadd -l ldif file Command Reference xConfiguration 212 213 Example Configuration Applications Presence Server Mode On 214 215 Example xConfiguration Bandwidth Link 1 Node1 Name HQ Example xConfiguration Bandwidth Downspeed PerCall Mode OnExample xConfiguration Bandwidth Downspeed Total Mode On 216 Example xConfiguration Bandwidth Pipe 1 Name 512Kb Asdl Example xConfiguration Error Reports Mode Off217 Example xConfiguration Ethernet 1 Speed Auto Example xConfiguration Ethernet 1 IP V4 AddressExample xConfiguration Ethernet 1 IP V4 SubnetMask Example xConfiguration ExternalManager Address Example xConfiguration H323 Gatekeeper CallTimeToLive Example xConfiguration H323 Gatekeeper TimeToLive219 220 221 222 Example xConfiguration Policy UserPolicy Mode Local 223 Example xConfiguration Registration RestrictionPolicy None Example Configuration SIP Loop Detect Mode On224 225 226 Example xConfiguration TimeZone Name GMT Example xConfiguration SystemUnit Name Oslo HQ VCSExample xConfiguration SystemUnit Password password123 Example xConfiguration Transform 1 Pattern Behavior Replace 228 229 Example xConfiguration Traversal Server Stun Discovery PortExample xConfiguration Traversal Server Stun Relay Mode On Example Traversal Server Stun Relay Port 230 Example xConfiguration Zones LocalZone Match 1..5 Priority 231 232 233 234 Example xConfiguration Zones Zone 1 H323 Mode On 235 Example xConfiguration Zones Zone 1 HopCount 236 Example xConfiguration Zones Zone 1 Neighbor H323 Port Example xConfiguration Zones Zone 1 Match 1 PriorityExample xConfiguration Zones Zone 1 Name UK Sales Office 237 Example xConfiguration Zones Zone 1 Neighbor Peer 1 Address Example xConfiguration Zones Zone 1 Neighbor SIP Port238 Example xConfiguration Zones Zone 1 SIP Mode On 239 Example xConfiguration Zones Zone 3 TraversalServer SIP Port 240 Example xConfiguration Zones Zone 1 Type Neighbor 241 Command Reference xCommand 242 Example xCommand boot Example xCommand AdminAccountDelete AdminAccountIdExample xCommand AllowListDelete AllowListId 243 244 Example xCommand DefaultValuesSet Level Example xCommand CredentialDelete CredentialIdExample xCommand DefaultLinksAdd Example xCommand DenyListDelete DenyListId Example xCommand FeedbackDeregister ID Example xCommand DomainAdd DomainName example.comExample xCommand DomainDelete DomainId 246 247 Example xCommand LinkDelete LinkId 248 Example xCommand OptionKeyAdd Key 1X4757T5-1-60BAD5CD Example xCommand OptionKeyDelete OptionKeyId249 Example xCommand PipeDelete PipeId Example xCommand RouteDelete RouteId250 Example xCommand SubZoneDelete SubZoneId2 251 Example xCommand TransformDelete TransformId Example xCommand ZoneDelete ZoneId252 Example xCommand ZoneList Alias john.smith@example.com 253 Command Reference xStatus 254 255 SystemUnit 256 Ethernet 257 NTP 258 Calls 259 260 Registrations 261 Zones 262 263 264 Links 265 Alternates 266 SIP 267 Stun 268 269 270 Bibliography 271 Glossary 272 Fqdn 273 Term Definition Local VCS 274 RTP 275 VCS 276 Contact Information