User manual TANDBERG TELEPRESENCE VIDEO COMMUNICATION SERVER COMMAND REFERENCE V X6

[. . . ] Cisco TelePresence Video Communication Server Command Reference D14754. 01 January 2010 Software version: X6 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 3 3 3 4 4 58 58 77 77 90 90 91 93 93 94 Cisco VCS Command Reference (X6) Page 2 of 95 Introduction Introduction This Command Reference document provides supplementary information regarding the administration of the Cisco TelePresence Video Communication Server (Cisco VCS). It includes: n n 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). You can now start using the CLI by typing the appropriate commands. CLI command types CLI commands are divided into the following groups: n n n n n xStatus: these commands return information about the current status of the system. Information such as current calls and registrations is available through this command group. [. . . ] Default: Unlimited Example: xConfiguration Zones LocalZone TraversalSubZone Bandwidth PerCall Mode: Limited Zones LocalZone TraversalSubZone Bandwidth Total Limit: <1. . 100000000> Specifies the total bandwidth (in kbps) allowed for all traversal calls being handled by the VCS (applies only if the mode is set to Limited). Default: 500000 Example: xConfiguration Zones LocalZone TraversalSubZone Bandwidth Total Limit: 500000 Zones LocalZone TraversalSubZone Bandwidth Total Mode: <Limited/Unlimited/NoBandwidth> Determines whether or not there is a limit to the total bandwidth of all traversal calls being handled by the VCS. Default: Unlimited Example: xConfiguration Zones LocalZone TraversalSubZone Bandwidth Total Mode: Limited Zones Policy Mode: <SearchRules/Directory> The mode used when attempting to locate a destination. SearchRules: use the configured search rules to determine which zones are queried and in what order. Directory: use the facilities of a directory service to direct the request to the correct zones. Default: SearchRules Example: xConfiguration Zones Policy Mode: SearchRules Zones Policy SearchRules Rule [1. . 2000] Authentication: <Yes/No> Specifies whether this search rule applies only to authenticated search requests. Default: No Example: xConfiguration Zones Policy SearchRules Rule 1 Authentication: No Cisco VCS Command Reference (X6) Page 42 of 95 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. AnyIPAddress: queries the zone for any given IP address (but not alias). Default: AnyAlias Example: xConfiguration Zones Policy SearchRules Rule 1 Mode: AnyAlias Zones Policy SearchRules Rule [1. . 2000] Name: <S: 0, 50> Descriptive name for the search rule. Example: xConfiguration Zones Policy SearchRules Rule 1 Name: "DNS lookup" Zones Policy SearchRules Rule [1. . 2000] Pattern Behavior: <Strip/Leave/Replace> Determines whether the matched part of the alias is modified before being sent to the target zone. (Applies to Alias Pattern Match mode only. ) Leave: the alias is not modified. Replace: the matching part of the alias is substituted with the text in the replace string. Default: Strip Example: xConfiguration Zones Policy SearchRules Rule 1 Pattern Behavior: Strip Zones Policy SearchRules Rule [1. . 2000] Pattern Replace: <S: 0, 60> The string to substitute for the part of the alias that matches the pattern. (Applies to Replace pattern behavior only. ) Example: xConfiguration Zones Policy SearchRules Rule 1 Pattern Replace: "@example. net" Zones Policy SearchRules Rule [1. . 2000] Pattern String: <S: 0, 60> The pattern against which the alias is compared. (Applies to Alias Pattern Match mode only. ) Example: xConfiguration Zones Policy SearchRules Rule 1 Pattern String: "@example. com" Zones Policy SearchRules Rule [1. . 2000] Pattern Type: <Exact/Prefix/Suffix/Regex> How the pattern string must match the alias for the rule to be applied. (Applies to Alias Pattern Match mode only. ) Exact: the entire string must exactly match the alias character for character. Default: Prefix Example: xConfiguration Zones Policy SearchRules Rule 1 Pattern Type: Suffix Cisco VCS Command Reference (X6) Page 43 of 95 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> Specifies the ongoing search behavior if the alias matches this search rule. If 'stop' is selected, any rules with the same priority level as this rule are still applied. [. . . ] Note:xCommand DefaultValuesSet Level: 3 must be used with caution, as it resets the system's IPv4 and IPv6 addresses, meaning you will no longer be able to access the system over IP. It also deletes all option keys including pre-installed options such as Expressway and the number of calls. It also deletes all links configured on the Cisco VCS, including the automatically configured default links between the Default Subzone, Traversal Subzone and Default Zone. To restore these links, you should run the command xCommand DefaultLinksAdd after xCommand DefaultValuesSet Level: 3. [. . . ]