259 | TANDBERG D14049.04 guide

Grey Headline (continued)

Command Reference - xStatus

TANDBERG VIDEO COMMUNICATIONS SERVER ADMINISTRATOR GUIDE

SIP: {visible if Protocol = SIP}

Address: <IPv4Addr/[IPv6Addr]>:<1..65534>

Transport: <UDP/TCP/TLS/undefined>

Aliases:

Alias [1..50]:

Type: <URL>

Value: <S: 1,60>

EncryptionType: <None/DES/AES-128>

CheckCode: <S: 1,60> {visible if Leg = H323 and call is interworked}

Targets:

Target [1..1]:

Type: <E164/H323Id/URL>

Value: <S: 1,60>

BandwidthNode: <S: 1,50 Node name>

Registration:

ID: <1..2500>

SerialNumber: <S: 1,255>

Sessions:

Session: [1..300:]

Status: <Unknown/Searching/Failed/Cancelled/Completed/Active/Connected>

MediaRouted: <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}

Introduction

Getting Started

Overview and

System

VCS

Zones and

Call

Bandwidth

Firewall

Applications

Maintenance

Appendices

Status

Configuration

Configuration

Neighbors

Processing

Control

Traversal

D14049.04

259

JULY 2008

Image 259

TANDBERG D14049.04 manual 259

Contents

Guide Getting Started What’s in this Manual?Preamble Introduction 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? Typographical conventions Administrator GuideUsing this Administrator Guide Command Line Interface Getting Started Connecting the Cables InstallationInstallation Site Preparations General Installation Precautions Powering on the VCS Initial Configuration via Serial Cable Initial Configuration UP key Initial Configuration via Front PanelDown key Overview System Administrator Access Supported Browsers Using the Web InterfaceSelect Administrator Login Web Interface General page features How Command are Shown in this Guide Command Line Interface Supported CharactersUsing the Command Line Interface CLI Types of Commands 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 End Time Registration HistoryReason Duration 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 Status Search History Search HistoryViewing the Search History Understanding the Search History About Searches 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 Status Pipes PipesViewing the Pipes Understanding the 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 Event Log Levels Event LogViewing the Event Log Understanding the Event Log Event Log Color Coding Event Log Format Interpreting the Event Log Event Message Details Field Events and Levels Registration Accepted Message ReceivedMessage Rejected Message Sent User session Login failure System Backup errorSystem Restore error TLS Negotiation Error Types of Configuration Events Configuration LogViewing the Configuration Log Understanding the Configuration Log System Configuration About the System Name System AdministrationOverview Configuration About Administrator Access settings Ethernet speed System Configuration EthernetXConfiguration Ethernet About Ethernet Speed About IPv4 to IPv6 Gatewaying Overview IP ConfigurationXConfiguration IP XConfiguration IPProtocol XConfiguration IP Route XCommand RouteAdd IPv4 subnet mask Overview LAN ConfigurationAbout LAN Configuration About Dual Network Interfaces About DNS Servers XConfiguration IP DNSAbout the DNS Domain Name About the Time Zone System Configuration NTPXConfiguration NTP Address XConfiguration TimeZone Name About the NTP Server About Snmp XConfiguration Snmp Address XConfiguration ExternalManagerExternal Manager About the External Manager Remote Logging LoggingAbout Logging About Remote Logging About Event Log Levels Setting the Event Log LevelXConfiguration Log Level Log Levels VCS Configuration Overview Endpoint Registration 323 XConfiguration H323 Configuring H.323 SIP Registration Expiry Using the VCS as a SIP RegistrarSIP Overview About SIP on the VCS 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 View/Edit Configuring SIP DomainsVCS Configuration Protocols SIP Domains Cancel Interworking Configuring InterworkingXConfiguration Interworking Mode Save SIP interworking mode Endpoint Registration MCU, Gateway and Content Server RegistrationRegistration Control Registration Overview H323 Gatekeeper AutoDiscovery Finding a VCS with which to Register323 Preventing automatic registrations Authentication for Local Registrations AuthenticationAuthentication Mode Configuring Authentication 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 Alias Registration Attempts to Register using an Existing AliasRegistering Aliases About Alias Registration Removing existing registrations Allow and Deny ListsAbout Allow and Deny Lists Activating use of Allow or Deny Lists Managing Entries in the Allow List XCommand AllowListAdd XConfigurationAllowList Registration Add Deny List Pattern VCS Configuration Registration Deny ListXCommand DenyListAdd XConfigurationDenyList Registration Managing Entries in the Deny List Zones and Neighbors Introduction Example Network DiagramAbout your Video Communications Network Local Zone Matches Overview Configuring the Local Zone and its SubzonesLocal Zone and Subzones Bandwidth Management What are traversal calls? Configuring the Traversal Subzone PortsVCS Configuration Local Zone Traversal Subzone Traversal Subzone Neighbor Zone About Zones Traversal Client Zone Traversal Server Zone XCommand DefaultLinksAdd Enum Zone DNS Zone Default Zone XConfiguration Zones Zone Adding Zones Configuring ZonesVCS Configuration Zones XCommand ZoneAdd 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 System Name Administration Accounts IP configurationDNS Configuration Prerequisites Upgrading to Backup and RestoreRegistrations SIP Registrations Enabling the Replication of FindMe Information ConfigurationClustering and FindMe Viewing Peers Clustering and Presence 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 Enum 104Dialing by Address Types Dialing by IP Address Dialing by H.323 or SIP URI Hop Counts About Hop Counts Configuring Hop CountsXConfiguration Zones Zone 1..200 HopCount 105 Pre-Search Transforms 106Searches and Transforms Overview of Searches and Transforms XConfiguration Transform Configuring Pre-Search Transforms107 Zone Searching and Transforming 108 Local Zone Configuring Zone Searches and TransformsDefault Settings 109 Never Query a Zone 110Examples Combining Match Types and Priorities 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 114 About Call Policy Administrator Policy and AuthenticationAuthentication Mode On Authentication Mode Off Administrator Policy Mode Administrator PolicyEnabling the use of Administrator Policy VCS Configuration Call Policy 116 Configuring Administrator Policy via the Web Interface Uploading a CPL Script 117About CPL XSD files URI Dialing 118H323 Process Configuring Matches for DNS Zones119 URI Dialing for Outgoing Calls Advanced Adding and Configuring DNS ZonesXCommand ZoneAdd XConfiguration Zones Zone 120 XConfiguration IP DNS Server Configuring DNS Servers121 URI Dialing for Incoming Calls 122 URI Dialing and Firewall Traversal Example DNS Record ConfigurationRecommended Configuration 123 Enum Dialing 124Overview Process Enabling Enum Dialing 7.6.5.4.3.2.1.4.4 125Enum Dialing for Outgoing Calls Example 126 Configuring Matches for Enum ZonesConfiguring Transforms for Enum Zones Mode of PatternMatch Pattern string Pattern type of Prefix 127 Configuring Enum ZonesClick Create Zone 128 About DNS Domains for Enum Configuring DNS Naptr Records129 Enum Dialing for Incoming Calls Unregistered Endpoints Recommended Configuration for Firewall TraversalXConfiguration Call Services 130 Fallback Alias Overview Configuration Example UsageXConfiguration Call Services Fallback Alias 131 Call IDs, Serial Numbers and Tags 132Identifying a Particular Call 133 Disconnecting CallsDisconnecting a Call via the Web Interface Issues when Disconnecting SIP Calls Bandwidth Control 134 Bandwidth Control Overview 135Bandwidth Control on the VCS Example Network Deployment Specifying the Subzone IP Addresses Subzone Links About the Default Subzone136 Subzones 137 XCommand SubZoneAddCreating a Subzone XConfiguration Zones LocalZone SubZone Configuring a Subzone138 How Different Bandwidth Limitations are Managed 139Applying Bandwidth Limitations to Subzones Types of Limitations About Links Creating Links Default LinksXCommand LinkAdd 140 141 XConfiguration Bandwidth LinkEditing Links 142 Default LinksAbout Default Links Pre-Configured Links 143 XCommand PipeAddAbout Pipes Creating Pipes Editing an Existing Pipe XConfiguration Bandwidth Pipe144 Editing Pipes One Pipe, Two or More Links 145Applying Pipes to Links One Pipe, One Link 146 Default Bandwidth and DownspeedingAbout the Default Call Bandwidth Configuring Default Call Bandwidth and Downspeeding Bandwidth Control Examples 147Example Without a Firewall Example With a Firewall VCS Expressway Subzone ConfigurationVCS Control Subzone Configuration 148 Firewall Traversal 149 How does it work? 150Firewall Traversal Overview About Expressway VCS as a Firewall Traversal Client 151 Quick Guide to VCS Traversal Client Server ConfigurationVCS Expressway Server SIP Firewall Traversal Protocols 152Firewall Traversal Protocols and Ports Overview Expressway Process Firewall Traversal Protocols SIP Ports Call signaling153 Media 154 Firewall Traversal and AuthenticationAuthentication and NTP Configuration Zones Edit Zone, in the Configuration section 155 Other Issues TraversalClient Create Zone Configuring the VCS as a Traversal Client156 Adding a New Traversal Client Zone 157 Configuring a Traversal Client Zone TraversalServer Create Zone Configuring the VCS as a Traversal Server158 Adding a New Traversal Server Zone 159 Configuring a Traversal Server ZoneClient authentication username Demux mode 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 Enabling FindMe on the VCS Configuring User Policy ManagerXConfiguration Policy UserPolicy 166 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...? About your FindMe User Account Using TANDBERG’s FindMeAccessing the FindMe Configuration 170 171 Configuring your FindMe User Account Overview Presence Server 172 Registration refresh period 173Presence User Agent PUA Aggregation of Presence Information 174 Enabling and Disabling Presence ServicesEnabled Disabled Presentities 175Viewing Presence Status Publishers 176 Maintenance Upgrading Software Overview Upgrading Using SCP/PSCPInstalling and Restarting 177 Upgrading via the Web Interface 178 Restart system Software upgrade in progressSoftware successfully upgraded 179 180 Downgrade Procedure Impact on features introducedDowngrading Software Overview Adding Options via the CLI XConfiguration Option 1..64 Key181 Option Keys Add option key Maintenance Option Keys182 Adding Options via the Web Interface Security 183Overview Enabling Security Adding an Administration Account Administration Accounts184 Account Disabled This account can not be used Editing an Administration Account185 Limitations Backup and RestoreOverview Creating a Backup of your VCS Configuration 186 187 Restoring a Previous Backup Overview Creating a System Snapshot Error Reports188 System Snapshot Restarting Maintenance RestartXCommand Boot 189 Overview Shutting Down Maintenance Shutdown190 Shutting Down 191 Restoring Default ConfigurationOverview DefaultValuesSet Level XCommand DefaultValuesSet Level 3 must be 192 Password EncryptionOverview Maximum length of Passwords Command Line Interface Appendices 193 Overview of CPL on the VCS Address-switch194 CPL Reference Field 195 Subfield 196Otherwise Not-present Reject Rule-switch197 Location Call Screening Based on Alias Call Screening of Authenticated Users198 CPL Examples Dont accept calls from this source 199Call Screening Based on Domain Change of Domain Name Allow Calls from Locally Registered Endpoints Only Block Calls from Default Zone and Default SubzoneAddress Address is=DefaultSubZone 200 201 Restricting Access to a Local GatewayUsing the address-switch node Using the rule-switch node Matches 0 or more repetitions of the previous match 202Regular Expression Reference Overview Common Regular Expressions Pattern Variable Reference 203 VCS Ports VCS Configuration Protocols H.323204 VCS Port Reference XConfiguration H323 Gatekeeper CallSignaling PortRange End XConfiguration Traversal Server Stun Relay PortXConfiguration SIP TCP Port XConfiguration SIP TLS Port 206 XConfiguration SIP TCP Outbound Port StartXConfiguration SIP TCP Outbound Port End XConfiguration Traversal Media Port Start Verifying the SRV Record DNS Configuration207 Overview Microsoft DNS Server About the Ldap Databases Ldap ConfigurationDownloading the Ldap schemas 208 Create the Organizational Hierarchy 209Adding H.350 Objects Securing with TLS 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 216 Example xConfiguration Bandwidth Downspeed PerCall Mode OnExample xConfiguration Bandwidth Downspeed Total Mode On Example xConfiguration Bandwidth Link 1 Node1 Name HQ Example xConfiguration Error Reports Mode Off Example xConfiguration Bandwidth Pipe 1 Name 512Kb Asdl217 Example xConfiguration ExternalManager Address Example xConfiguration Ethernet 1 IP V4 AddressExample xConfiguration Ethernet 1 IP V4 SubnetMask Example xConfiguration Ethernet 1 Speed Auto 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 Transform 1 Pattern Behavior Replace Example xConfiguration SystemUnit Name Oslo HQ VCSExample xConfiguration SystemUnit Password password123 Example xConfiguration TimeZone Name GMT 228 Example Traversal Server Stun Relay Port Example xConfiguration Traversal Server Stun Discovery PortExample xConfiguration Traversal Server Stun Relay Mode On 229 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 237 Example xConfiguration Zones Zone 1 Match 1 PriorityExample xConfiguration Zones Zone 1 Name UK Sales Office Example xConfiguration Zones Zone 1 Neighbor H323 Port 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 243 Example xCommand AdminAccountDelete AdminAccountIdExample xCommand AllowListDelete AllowListId Example xCommand boot 244 Example xCommand DenyListDelete DenyListId Example xCommand CredentialDelete CredentialIdExample xCommand DefaultLinksAdd Example xCommand DefaultValuesSet Level 246 Example xCommand DomainAdd DomainName example.comExample xCommand DomainDelete DomainId Example xCommand FeedbackDeregister ID 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