253

Grey Headline (continued)

Command Reference - xCommand

TANDBERG VIDEO COMMUNICATIONS SERVER ADMINISTRATOR GUIDE

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. Note that this command does not change any existing system configuration.

Alias(r): <S: 1, 60>

The alias to be searched for.

Example: xCommand ZoneList Alias: "john.smith@example.com"

Introduction

Getting Started

Overview and

System

VCS

Zones and

Call

Bandwidth

Firewall

Applications

Maintenance

Appendices

Status

Configuration

Neighbors

Processing

Control

Traversal

D14049.04

JULY 2008

Page 253

Image 253

TANDBERG D14049.04 manual 253, Example xCommand ZoneList Alias john.smith@example.com

Contents

Guide Preamble What’s in this Manual?Introduction Getting Started DNS Overview and Status NTP VCS Configuration Call Processing Zones and Neighbors Bandwidth Control 151 Applications Maintenance Appendices Copyright 2008, Tandberg Legal Notices Safety Instructions Safety Instructions and ApprovalsApprovals TANDBERG’s Environmental Policy Environmental IssuesWaste Handling Digital User Guides Environmental Issues Tandberg VCS Overview VCS and the Tandberg Total Solution VCS Control VCS Base ApplicationsVCS Expressway Dual Network Interfaces Standard Features Optional FeaturesUser Policy FindMe What’s New in this Version? Using this Administrator Guide Administrator GuideCommand Line Interface Typographical conventions Getting Started Installation Site Preparations InstallationGeneral Installation Precautions Connecting the Cables Powering on the VCS Initial Configuration via Serial Cable Initial Configuration UP key Initial Configuration via Front PanelDown key Overview System Administrator Access Select Administrator Login Using the Web InterfaceWeb Interface Supported Browsers General page features Using the Command Line Interface CLI Command Line Interface Supported CharactersTypes of Commands How Command are Shown in this Guide Overview and Status Viewing the Overview Understanding the Overview Overview System Information Status System Ethernet MAC address EthernetSpeed Viewing the IP Status Understanding the IP Status IP Status Viewing the Resource Usage Understanding the Resource Usage Resource UsageStatus System Resource Usage Traversal calls Viewing the Registrations Understanding the Registrations Registrations Reason Registration HistoryDuration End Time Viewing the Presence Status Pages PresencePublishers Presentities Subscribers Viewing the Calls Understanding the Calls Calls Viewing the Call History Understanding the Call History Call HistoryStatus Call History Filter Viewing the Search History Understanding the Search History Search HistoryAbout Searches Status Search History Viewing the Local Zone Understanding the Local Zone Local Zone Viewing the Zones Understanding the Zones ZonesStatus Zones Viewing the Links Understanding the Links LinksStatus Links Viewing the Pipes PipesUnderstanding the Pipes Status Pipes Viewing the Stun Relays Understanding the Stun Relays Stun Relays Viewing the Applications Understanding the Applications ApplicationsStatus Applications Status Warnings Viewing the Warnings Understanding the Warnings Viewing the Event Log Understanding the Event Log Event LogEvent Log Color Coding Event Log Levels Event Log Format Interpreting the Event Log Event Message Details Field Events and Levels Message Rejected Message ReceivedMessage Sent Registration Accepted System Restore error System Backup errorTLS Negotiation Error User session Login failure Viewing the Configuration Log Configuration LogUnderstanding the Configuration Log Types of Configuration Events System Configuration Overview Configuration System AdministrationAbout Administrator Access settings About the System Name XConfiguration Ethernet System Configuration EthernetAbout Ethernet Speed Ethernet speed XConfiguration IP XConfiguration IPProtocol Overview IP ConfigurationXConfiguration IP Route XCommand RouteAdd About IPv4 to IPv6 Gatewaying About LAN Configuration Overview LAN ConfigurationAbout Dual Network Interfaces IPv4 subnet mask About DNS Servers XConfiguration IP DNSAbout the DNS Domain Name XConfiguration NTP Address XConfiguration TimeZone Name System Configuration NTPAbout the NTP Server About the Time Zone About Snmp XConfiguration Snmp External Manager XConfiguration ExternalManagerAbout the External Manager Address About Logging LoggingAbout Remote Logging Remote Logging XConfiguration Log Level Setting the Event Log LevelLog Levels About Event Log Levels VCS Configuration Overview Endpoint Registration 323 XConfiguration H323 Configuring H.323 SIP Overview Using the VCS as a SIP RegistrarAbout SIP on the VCS SIP Registration Expiry Using the VCS as a SIP Presence Server Using the VCS as a SIP Proxy ServerSIP protocols and ports XConfiguration SIP Configuring SIP Registrations, Protocols and Ports VCS Configuration Protocols SIP Domains Configuring SIP DomainsCancel View/Edit XConfiguration Interworking Mode Configuring InterworkingSave SIP interworking mode Interworking Registration Control MCU, Gateway and Content Server RegistrationRegistration Overview Endpoint Registration 323 Finding a VCS with which to RegisterPreventing automatic registrations H323 Gatekeeper AutoDiscovery Authentication Mode AuthenticationConfiguring Authentication Authentication for Local Registrations About External Registration Credentials Configuring External Registration Credentials Alias Origin Setting Authentication DatabasesAuthentication using an Ldap Server XConfiguration Ldap XConfiguration Authentication Ldap Configuring Ldap Server settings Configuring the Local Database Authentication using a Local Database Registering Aliases Attempts to Register using an Existing AliasAbout Alias Registration Alias Registration About Allow and Deny Lists Allow and Deny ListsActivating use of Allow or Deny Lists Removing existing registrations Managing Entries in the Allow List XCommand AllowListAdd XConfigurationAllowList Registration XCommand DenyListAdd XConfigurationDenyList Registration VCS Configuration Registration Deny ListManaging Entries in the Deny List Add Deny List Pattern Zones and Neighbors Introduction Example Network DiagramAbout your Video Communications Network Local Zone and Subzones Overview Configuring the Local Zone and its SubzonesBandwidth Management Local Zone Matches VCS Configuration Local Zone Traversal Subzone Configuring the Traversal Subzone PortsTraversal Subzone What are traversal calls? Neighbor Zone About Zones Traversal Client Zone Traversal Server Zone XCommand DefaultLinksAdd Enum Zone DNS Zone Default Zone VCS Configuration Zones Adding Zones Configuring ZonesXCommand ZoneAdd XConfiguration Zones Zone Hop count Configuring Zones All TypesMatch1 Match5 Configuring Neighbor Zones Authentication username Configuring Traversal Client ZonesRetry interval Configuring Traversal Server Zones DNS suffix Configuring Enum Zones Configuring DNS Zones About Clustering Clustering, Peers and AlternatesCluster Subzone DNS Configuration Administration Accounts IP configurationPrerequisites System Name Registrations Backup and RestoreSIP Registrations Upgrading to Clustering and FindMe Viewing Peers ConfigurationClustering and Presence Enabling the Replication of FindMe Information Neighboring the Local VCS to a Cluster 100Peer 1...Peer 6 address Dial Plans 101 Call Processing 102 103 Call Processing DiagramSearch Process Dialing by Address Types 104Dialing by IP Address Dialing by H.323 or SIP URI Dialing by Enum XConfiguration Zones Zone 1..200 HopCount About Hop Counts Configuring Hop Counts105 Hop Counts Searches and Transforms 106Overview of Searches and Transforms Pre-Search Transforms XConfiguration Transform Configuring Pre-Search Transforms107 Zone Searching and Transforming 108 Default Settings Configuring Zone Searches and Transforms109 Local Zone Examples 110Combining Match Types and Priorities Never Query a Zone Filter Queries to a Zone Without Transforming 111 Query a Zone for Original and Transformed Alias 112 Query a Zone for Two or More Transformed Aliases 113 Authentication Mode On About Call Policy Administrator Policy and AuthenticationAuthentication Mode Off 114 Enabling the use of Administrator Policy Administrator PolicyVCS Configuration Call Policy Administrator Policy Mode 116 Configuring Administrator Policy via the Web Interface Uploading a CPL Script 117About CPL XSD files URI Dialing 118H323 119 Configuring Matches for DNS ZonesURI Dialing for Outgoing Calls Process XCommand ZoneAdd XConfiguration Zones Zone Adding and Configuring DNS Zones120 Advanced XConfiguration IP DNS Server Configuring DNS Servers121 URI Dialing for Incoming Calls 122 Recommended Configuration Example DNS Record Configuration123 URI Dialing and Firewall Traversal Enum Dialing 124Overview Process Enabling Enum Dialing Enum Dialing for Outgoing Calls 125Example 7.6.5.4.3.2.1.4.4 Configuring Transforms for Enum Zones Configuring Matches for Enum ZonesMode of PatternMatch Pattern string Pattern type of Prefix 126 127 Configuring Enum ZonesClick Create Zone 128 129 Configuring DNS Naptr RecordsEnum Dialing for Incoming Calls About DNS Domains for Enum XConfiguration Call Services Recommended Configuration for Firewall Traversal130 Unregistered Endpoints XConfiguration Call Services Fallback Alias Overview Configuration Example Usage131 Fallback Alias Call IDs, Serial Numbers and Tags 132Identifying a Particular Call Disconnecting a Call via the Web Interface Disconnecting CallsIssues when Disconnecting SIP Calls 133 Bandwidth Control 134 Bandwidth Control Overview 135Bandwidth Control on the VCS Example Network Deployment 136 About the Default SubzoneSubzones Specifying the Subzone IP Addresses Subzone Links 137 XCommand SubZoneAddCreating a Subzone XConfiguration Zones LocalZone SubZone Configuring a Subzone138 Applying Bandwidth Limitations to Subzones 139Types of Limitations How Different Bandwidth Limitations are Managed XCommand LinkAdd Default Links140 About Links Creating Links 141 XConfiguration Bandwidth LinkEditing Links About Default Links Default LinksPre-Configured Links 142 143 XCommand PipeAddAbout Pipes Creating Pipes 144 XConfiguration Bandwidth PipeEditing Pipes Editing an Existing Pipe Applying Pipes to Links 145One Pipe, One Link One Pipe, Two or More Links About the Default Call Bandwidth Default Bandwidth and DownspeedingConfiguring Default Call Bandwidth and Downspeeding 146 Bandwidth Control Examples 147Example Without a Firewall VCS Control Subzone Configuration VCS Expressway Subzone Configuration148 Example With a Firewall Firewall Traversal 149 Firewall Traversal Overview 150About Expressway VCS as a Firewall Traversal Client How does it work? 151 Quick Guide to VCS Traversal Client Server ConfigurationVCS Expressway Server Firewall Traversal Protocols and Ports 152Overview Expressway Process Firewall Traversal Protocols SIP Firewall Traversal Protocols 153 Call signalingMedia SIP Ports Authentication and NTP Firewall Traversal and AuthenticationConfiguration Zones Edit Zone, in the Configuration section 154 155 Other Issues 156 Configuring the VCS as a Traversal ClientAdding a New Traversal Client Zone TraversalClient Create Zone 157 Configuring a Traversal Client Zone 158 Configuring the VCS as a Traversal ServerAdding a New Traversal Server Zone TraversalServer Create Zone Client authentication username Configuring a Traversal Server ZoneDemux mode 159 XConfiguration Zones LocalZone Traversal H323 Configuring Traversal for Endpoints160 161 Configuring Traversal Server Ports 162 Stun Services 163 Configuring Stun Services 164 FindMe User Policy 165 XConfiguration Policy UserPolicy Configuring User Policy Manager166 Enabling FindMe on the VCS Managing FindMe User Accounts 167About User Accounts Creating a New User Account Viewing Existing User Account Settings Changing a User Password168 Deleting a User Account 169Are you sure...? Accessing the FindMe Configuration Using TANDBERG’s FindMe170 About your FindMe User Account 171 Configuring your FindMe User Account Overview Presence Server 172 Presence User Agent PUA 173Aggregation of Presence Information Registration refresh period Enabled Enabling and Disabling Presence ServicesDisabled 174 Viewing Presence Status 175Publishers Presentities 176 Maintenance Installing and Restarting Overview Upgrading Using SCP/PSCP177 Upgrading Software Upgrading via the Web Interface 178 Software successfully upgraded Software upgrade in progress179 Restart system 180 Downgrade Procedure Impact on features introducedDowngrading Software 181 XConfiguration Option 1..64 KeyOption Keys Overview Adding Options via the CLI 182 Maintenance Option KeysAdding Options via the Web Interface Add option key Security 183Overview Enabling Security Adding an Administration Account Administration Accounts184 Account Disabled This account can not be used Editing an Administration Account185 Overview Creating a Backup of your VCS Configuration Backup and Restore186 Limitations 187 Restoring a Previous Backup 188 Error ReportsSystem Snapshot Overview Creating a System Snapshot XCommand Boot Maintenance Restart189 Restarting 190 Maintenance ShutdownShutting Down Overview Shutting Down Overview DefaultValuesSet Level Restoring Default ConfigurationXCommand DefaultValuesSet Level 3 must be 191 Overview Maximum length of Passwords Password EncryptionCommand Line Interface 192 Appendices 193 194 Address-switchCPL Reference Overview of CPL on the VCS Field 195 Subfield 196Otherwise Not-present 197 Rule-switchLocation Reject 198 Call Screening of Authenticated UsersCPL Examples Call Screening Based on Alias Call Screening Based on Domain 199Change of Domain Name Dont accept calls from this source Address Address is=DefaultSubZone Block Calls from Default Zone and Default Subzone200 Allow Calls from Locally Registered Endpoints Only Using the address-switch node Restricting Access to a Local GatewayUsing the rule-switch node 201 Regular Expression Reference 202Overview Common Regular Expressions Matches 0 or more repetitions of the previous match Pattern Variable Reference 203 204 VCS Configuration Protocols H.323VCS Port Reference VCS Ports XConfiguration SIP TCP Port XConfiguration Traversal Server Stun Relay PortXConfiguration SIP TLS Port XConfiguration H323 Gatekeeper CallSignaling PortRange End XConfiguration SIP TCP Outbound Port End XConfiguration SIP TCP Outbound Port StartXConfiguration Traversal Media Port Start 206 207 DNS ConfigurationOverview Microsoft DNS Server Verifying the SRV Record Downloading the Ldap schemas Ldap Configuration208 About the Ldap Databases Adding H.350 Objects 209Securing with TLS Create the Organizational Hierarchy 210 Include /etc/openldap/schemas/sipidentity.ldifOpenLDAP # MeetingRoom1 endpoint 211Slapadd -l ldif file 212 Command Reference xConfiguration 213 214 Example Configuration Applications Presence Server Mode On 215 Example xConfiguration Bandwidth Downspeed Total Mode On Example xConfiguration Bandwidth Downspeed PerCall Mode OnExample xConfiguration Bandwidth Link 1 Node1 Name HQ 216 Example xConfiguration Error Reports Mode Off Example xConfiguration Bandwidth Pipe 1 Name 512Kb Asdl217 Example xConfiguration Ethernet 1 IP V4 SubnetMask Example xConfiguration Ethernet 1 IP V4 AddressExample xConfiguration Ethernet 1 Speed Auto Example xConfiguration ExternalManager Address Example xConfiguration H323 Gatekeeper TimeToLive Example xConfiguration H323 Gatekeeper CallTimeToLive219 220 221 222 223 Example xConfiguration Policy UserPolicy Mode Local Example Configuration SIP Loop Detect Mode On Example xConfiguration Registration RestrictionPolicy None224 225 226 Example xConfiguration SystemUnit Password password123 Example xConfiguration SystemUnit Name Oslo HQ VCSExample xConfiguration TimeZone Name GMT Example xConfiguration Transform 1 Pattern Behavior Replace 228 Example xConfiguration Traversal Server Stun Relay Mode On Example xConfiguration Traversal Server Stun Discovery Port229 Example Traversal Server Stun Relay Port 230 231 Example xConfiguration Zones LocalZone Match 1..5 Priority 232 233 234 235 Example xConfiguration Zones Zone 1 H323 Mode On 236 Example xConfiguration Zones Zone 1 HopCount Example xConfiguration Zones Zone 1 Name UK Sales Office Example xConfiguration Zones Zone 1 Match 1 PriorityExample xConfiguration Zones Zone 1 Neighbor H323 Port 237 Example xConfiguration Zones Zone 1 Neighbor SIP Port Example xConfiguration Zones Zone 1 Neighbor Peer 1 Address238 239 Example xConfiguration Zones Zone 1 SIP Mode On 240 Example xConfiguration Zones Zone 3 TraversalServer SIP Port 241 Example xConfiguration Zones Zone 1 Type Neighbor 242 Command Reference xCommand Example xCommand AllowListDelete AllowListId Example xCommand AdminAccountDelete AdminAccountIdExample xCommand boot 243 244 Example xCommand DefaultLinksAdd Example xCommand CredentialDelete CredentialIdExample xCommand DefaultValuesSet Level Example xCommand DenyListDelete DenyListId Example xCommand DomainDelete DomainId Example xCommand DomainAdd DomainName example.comExample xCommand FeedbackDeregister ID 246 247 248 Example xCommand LinkDelete LinkId Example xCommand OptionKeyDelete OptionKeyId Example xCommand OptionKeyAdd Key 1X4757T5-1-60BAD5CD249 Example xCommand RouteDelete RouteId Example xCommand PipeDelete PipeId250 251 Example xCommand SubZoneDelete SubZoneId2 Example xCommand ZoneDelete ZoneId Example xCommand TransformDelete TransformId252 253 Example xCommand ZoneList Alias john.smith@example.com 254 Command Reference xStatus SystemUnit 255 Ethernet 256 NTP 257 Calls 258 259 Registrations 260 Zones 261 262 263 Links 264 Alternates 265 SIP 266 Stun 267 268 269 Bibliography 270 Glossary 271 Fqdn 272 Term Definition Local VCS 273 RTP 274 VCS 275 Contact Information 276