Avaya User Guide Enablement pack for · Preface 1 As part of an effort to improve and enhance the performance and capabilities of its product lines, VMware periodically releases revisions

Enablement pack forAvaya User Guide

VMware Smart Assurance 10.1.0

You can find the most up-to-date technical documentation on the VMware website at:

https://docs.vmware.com/

If you have comments about this documentation, submit your feedback to

[email protected]

VMware, Inc.3401 Hillview Ave.Palo Alto, CA 94304www.vmware.com

Copyright © 2019 VMware, Inc. All rights reserved. Copyright and trademark information.

Enablement pack for Avaya User Guide

VMware, Inc. 2


mailto:[email protected]

http://pubs.vmware.com/copyright-trademark.html

Contents

1 Preface 5Audience 5

VMware Smart Assurance VoIP Management Suite installation directory 5

VMware Smart Assurance VoIP Management Suite products 6

Related documentation 6

Help for command line programs 6

VMware Smart Assurance documentation 6

VMware Smart Assurance VoIP Management Suite documentation 7

Suggestions for searching PDF files 7

Conventions used in this document 8

Typographical conventions 8

Pathname conventions 9

Graphical conventions 9

Manager 9

Where to get help 9

Your comments 10

2 Introduction 11VMware Smart Assurance Enablement Pack for Avaya 11

Avaya Communication Manager requirements 12

VoIP Availability Manager and other VMware Smart Assurance products 12

VoIP Performance Manager and client tools 13

Processing flow overview 14

Discovery and monitoring 15

Trap processing 15

Installation 15

3 Integrating the Enablement Pack with VoIP 17Avaya virtual IP addresses 17

Excluding Avaya virtual IP addresses from the topology 17

Procedure to exclude an Avaya virtual IP address 17

4 Discovering Elements and Monitoring Events 19Avaya Enablement Pack object classes 19

Avaya Enablement Pack attributes 20

CardServiceRedundancyGroup 20

ConvergedCallManager 21

ConvergedCallManagerRedundancyGroup 21

VMware, Inc. 3

GatewayService 22

H323GateKeeper 22

IPConnector 22

IPPhone 23

IPPhoneGroup 23

MediaProcessor 24

DS1Service 24

VoiceAnnounceService 24

H248RegistrationSession 25

PortNetwork 25

VoiceMailApplication 25

VoipApplication 26

VoipCluster 26

VoipProcess 26

Events for VoIP Availability Manager Avaya elements 27

Impact Analysis 29

Aggregates Analysis 30

5 Default Notification Attributes 33Default notification attributes 33

6 Understanding the sm_edit Utility 35The sm_edit utility 35

Example 1 35

Example 2 36

7 Wildcard Patterns 37Types of wildcard patterns 37


VMware, Inc. 4

Preface 1As part of an effort to improve and enhance the performance and capabilities of its product lines, VMwareperiodically releases revisions of its hardware and software. Therefore, some functions described in thisdocument may not be supported by all versions of the software or hardware currently in use. For the mostup-to-date information on product features, refer to your product release notes.

If a product does not function properly or does not function as described in this document, please contactyour VMware representative.

This chapter includes the following topics:

n Audience

n VMware Smart Assurance VoIP Management Suite installation directory

n VMware Smart Assurance VoIP Management Suite products

n Related documentation

n Suggestions for searching PDF files

n Conventions used in this document

n Where to get help

n Your comments

Audience

This document is part of the VMware Smart Assurance VoIP Management Suite documentation set, andis intended for use by administrators and network operators who use VMware Smart Assurance VoIPAvailability Manager (VoIP Availability Manager) to manage and monitor Avaya Voice over IP (VoIP)environments.

VMware Smart Assurance VoIP Management Suiteinstallation directory

In this document, the term BASEDIR represents the location where VMware Smart Assurance software isinstalled:

n For UNIX, this location is: /opt/InCharge/<productsuite>.

VMware, Inc. 5

n The <productsuite> represents the VMware Smart Assurance product suite to which the productbelongs. For example, on UNIX operating systems, VMware Smart Assurance VoIP ManagementSuite is, by default, installed to: /opt/InCharge/VoIP/smarts.

Optionally, you can specify the root of BASEDIR to be something different, but you cannot change the<productsuite> location under the root directory.

The VMware Smart Assurance System Administration Guide provides detailed information about thedirectory structure for VMware Smart Assurance software.

VMware Smart Assurance VoIP Management Suiteproducts

The VMware Smart Assurance VoIP Management Suite includes the following:

n VMware Smart Assurance VoIP Availability Manager

n VMware Smart Assurance VoIP Integration Pack for VoIP Performance Manager

n VMware Smart Assurance Enablement Pack for Avaya

n VMware Smart Assurance Enablement Pack for Cisco

n VMware Smart Assurance Enablement Pack for Nortel

n VMware Smart Assurance VoIP Performance Manager

n VMware Smart Assurance VoIP Performance Reporter

Related documentation

In addition to this document, VMware Corporation provides a Help system for command line programs aswell as product documentation.

Help for command line programs

Descriptions of command line programs are available as HTML pages. The index.html file, which providesan index to the various commands, is located in the BASEDIR/smarts/doc/html/usage directory.

VMware Smart Assurance documentation


VMware, Inc. 6

Readers of this guide may find the following related documentation helpful. It can be found in theBASEDIR/smarts/doc/pdf directory:

Note These documents are updated periodically. Electronic versions of the updated manuals areavailable on the Vmware Docs website:

docs.vmware.comn VMware Smart Assurance Documentation Catalog

n VMware Smart Assurance System Administration Guide

n VMware Smart Assurance ICIM Reference (in HTML format)

n VMware Smart Assurance ASL Reference Guide

n VMware Smart Assurance Perl Reference Guide

n VMware Smart Assurance MODEL Reference Guide

VMware Smart Assurance VoIP Management Suite documentation

The following documents are relevant to users of the VMware Smart Assurance VoIP Management Suite:

n VMware Smart Assurance VoIP Management Suite Release Notes (VMware Docs only)

n VMware Smart Assurance VoIP Availability Manager Installation Guide

n VMware Smart Assurance VoIP Availability Manager Configuration Guide

n VMware Smart Assurance VoIP Availability Manager Discovery Guide

n VMware Smart Assurance VoIP Management Suite Overview and Integration Guide

n VMware Smart Assurance VoIP Availability Manager User Guide

n VMware Smart Assurance Enablement Pack for Avaya User Guide

n VMware Smart Assurance Enablement Pack for Cisco User Guide

n VMware Smart Assurance Enablement Pack for Nortel User Guide

n VMware Smart Assurance VoIP Availability Manager Certification Matrix (VMware Docs only)

n VMware Smart Assurance VoIP Performance Manager and Performance Reporter Certification Matrix(VMware Docs only)

n VMware Smart Assurance VoIP Management Suite Certification Framework Technical Notes(VMware Docs only)

n VMware Smart Assurance VoIP Availability Manager Third-Party Copyright Read Me

The VMware Smart Assurance Documentation Catalog lists documentation resources provided withother VMware Smart Assurance product suites.

Suggestions for searching PDF files


VMware, Inc. 7


You may search across multiple PDF files using the Adobe Acrobat Reader software:

1 If the documentation is not accessible to all users of the VMware Smart Assurance product suite,copy the contents of the BASEDIR/smarts/doc/pdf directory to a central location, such as a shareddrive on your LAN, that operators and others may view.

2 To search throughout the documentation library, open the Acrobat Reader software:

3 Select Edit > Search , and type a word or phrase.

4 Select All PDF Documents in, in the Where would you like to search option, and type thepathname of the location where the PDF documents reside.

If you have more than one VMware Smart Assurance product suite installed, you can set up cross-product document searches by copying files from the BASEDIR/smarts/doc/pdf directory for eachproduct suite into this common documentation directory path.

Conventions used in this document

VMware uses the following conventions for special notices.

Note A note presents information that is important, but not hazard-related.

A caution contains information essential to avoid data loss or damage to the system or equipment.

An important notice contains information essential to operation of the software.

Typographical conventions

VMware uses the following type style conventions in this document:

Normal Used in running (nonprocedural) text for:

n Names of interface elements (such as names of window, dialog boxes, buttons, fields, andmenus)

n Names of resources, attributes, pools, Boolean expressions, buttons, DQL statements,keywords, clauses, environment variables, functions, utilities

n URLs, pathnames, filenames, directory names, computer names, filenames, links, groups,service keys, file systems, notifications

Bold Used in procedures for:

n Names of interface elements (such as names of window, dialog boxes, buttons, fields, andmenus)

n What user specifically selects, clicks, presses, or types

Italic Used in text for:

n Full titles of publications referenced in text

n Emphasis (for example a new term)

CourierUsed for:

n System output, such as an error message or script

n URLs, complete paths, filenames, prompts, and syntax when shown outside of running text


VMware, Inc. 8

Courier bold

Used for:

n Specific user input (such as commands)

Courier italic

Used in procedures for:

n Variables on command line

n User input variables

< > Angle brackets enclose parameter or variable values supplied by the user

[ ] Square brackets enclose optional values

| Vertical bar indicates alternate selections - the bar means “or”

{ } Braces indicate content that you must specify (that is, x or y or z)

... Ellipses indicate nonessential information omitted from the example

Pathname conventions

Directory pathnames are shown with forward slashes (/).

Graphical conventions

If there are figures illustrating consoles in this document - under UNIX, the consoles appear with slightdifferences. For example, in views that display items in a tree hierarchy such as the Topology Browser, anopen circle appears for UNIX.

Manager

Unless otherwise specified, the term Manager is used to refer to VMware Smart Assurance programssuch as Domain Managers, Global Managers, and adapters.

Where to get help

VMware support, product, and licensing information can be obtained as follows.

Product information

For documentation, release notes, software updates, or for information about VMware products, licensing,and service, go to the VMware support website (registration required) at:

docs.vmware.com

support.vmware.com

For technical support


VMware, Inc. 9


https://support.vmware.com

Go to online support website. On the Support page, you will see several options, including one for makinga service request. Note that to open a service request, you must have a valid support agreement. Pleasecontact your VMware sales representative for details about obtaining a valid support agreement or withquestions about your account.

Your comments

Your suggestions will help us continue to improve the accuracy, organization, and overall quality of theuser publications. Please provide your feedback of this document to:


If you have issues, comments, or questions about specific information or procedures, please include thetitle and, if available, the part number, the revision (for example, A01), the page numbers, and any otherdetails that will help us locate the subject you are addressing.


VMware, Inc. 10


Introduction 2This chapter includes the following topics:

n VMware Smart Assurance Enablement Pack for Avaya

n VoIP Availability Manager and other VMware Smart Assurance products

n VoIP Performance Manager and client tools

n Processing flow overview

n Discovery and monitoring

n Trap processing

n Installation

VMware Smart Assurance Enablement Pack for Avaya

The VMware Smart Assurance Enablement Pack for Avaya (Avaya Enablement Pack) is a softwarepackage that discovers and monitors Avaya-specific elements in an Avaya Communication ManagerVoice over IP (VoIP) environment. The package is installed with or after the installation of VMware SmartAssurance VoIP Availability Manager, and operates in conjunction with the VoIP Availability Manager. Itrequires a separate feature license.

The functions of the Avaya Enablement Pack include:

n Automated discovery of the elements in an environment using SNMP querying. The product modelsthe various hardware that can be part of an Avaya Communication Manager Voice over IPenvironment.

n Automated discovery of the applications and software processes running in an Avaya CommunicationManager Voice over IP environment.

n Trap support for devices in the Avaya Communication Manager Voice over IP environment.

n Root-cause analysis for problems in software services.

n Redundancy group analysis. VoIP Availability Manager models redundancy groups at the system,software process, and software system levels.

n Impact analysis within the VoIP domain and impact propagation to VoIP services.

n Cross-domain correlation with IP connectivity problems.

n Mapping of nonsymptomatic alarms to notifications that are passed up to the Global Console.

VMware, Inc. 11

The Avaya Enablement Pack discovers and monitors the following devices and services in the AvayaVoIP environment:

n Avaya Communication Manager 3.1 and later

n Avaya S87xx Media Server 3.1 and later

n Avaya S8500B Media Server 3.1 and later

n Avaya S8300 and S8400 Media Servers 3.1 and later

n Avaya G600 and G650 Gateways 3.1 and later

n Avaya G700 Media Gateway 3.1 and later

n Avaya G250 and G350 Media Gateways 3.1 and later

n Message Storage Server (MSS) (S3400 and S3500) 3.1 and later

n Messaging Application Server (MAS) (S3400 and S3500) 3.1 and later

n Avaya IP phones

Avaya Communication Manager requirements

Avaya Communication Manager requirements, specifically patch levels, as well as vendor versionrequirements are provided in the VMware Smart Assurance VoIP Management Suite Release Notes. Youmust ensure that these requirements are satisfied for proper operation with the VMware Smart AssuranceEnablement Pack for Avaya.

VoIP Availability Manager and other VMware SmartAssurance products

The VMware Smart Assurance Enablement Pack for Avaya is part of the VoIP Management Suite andoperates in conjunction with VoIP Availability Manager. During the installation of the VoIP ManagementSuite, you need to select the Avaya Enablement Pack for installation. (The VMware Smart AssuranceVoIP Availability Manager Installation Guide provides complete information about the installation process.)

VMware Smart Assurance VoIP Availability Manager provides discovery and monitoring of the VoIPenvironment. Discovery and monitoring is performed over a combination of infrastructure andapplications. The infrastructure includes: Media Gateways, IP PBXs, IP phones, IP phone groups, VoIPswitches and routers. The applications include the VoIP network and telephony applications and softwareservices. The inter-dependencies between these elements are represented by the VoIP topology.

VMware Smart Assurance VoIP Availability Manager operates in conjunction with the following Smartssoftware:

n VMware Smart Assurance Service Assurance Manager

Consolidates the topology and events from underlying Domain Managers. VoIP Availability Manageralso operates in conjunction with the software that is installed with Service Assurance Manager:Adapter Platform and SNMP Trap Adapter.


VMware, Inc. 12

n VMware Smart Assurance IP Manager

Provides topology information about the infrastructure elements and ComputerSystems, as well asevent information about whether the ComputerSystems are reachable.

n VMware Smart Assurance VoIP Performance Manager, and VMware Smart Assurance VoIPPerformance Reporter, optional

VoIP Performance Reporter is an add-on module to VoIP Performance Manager.

When implemented, the VoIP Performance Manager provides performance data from theinfrastructure elements that enriches the analysis performed by VoIP Availability Manager.

VoIP Performance Reporter captures and records information from multiple devices and applicationsthroughout the Avaya VoIP network, and produces charts, graphs, and reports to help administratorsvisualize and understand important trends across the VoIP environment.

The VMware Smart Assurance VoIP Management Suite Release Notes provides detailed informationon interoperability with other VMware Smart Assurance products.

VoIP Performance Manager and client tools

Client tools enable Global Console operators to invoke programs on a particular target object, such as atopology object, or a map object. Right-clicking a target object launches a pop-up menu that lists theavailable tools for the target object.

Client tools created to access VoIP Performance Manager data are available only for VoIP topologyobjects which are imported by the Global Manager from VoIP Availability Manager. They enable GlobalConsole operators to use the Java-based GUI available from the VoIP Performance Manager to accessdrill-down displays.

The client tools that are available for use are dependent on the configuration of the VoIP AvailabilityManager and VoIP Performance Manager implementation, as well as the managed elements on thenetwork. For example, these client tools may be available for the following VoIP Availability Managertopology objects:

n VoIP Performance Manager—Launch VoIP PM View

n MedPro—Launch MedPro View

n CLAN—Launch CLAN View

n DS1—Launch DS1 Service View

n Media Gateway—Launch Media Gateway View

n Port Network—Launch Port Network View

n Network Region—Launch IP Network Region View

n Trunk Group—Launch Trunk Group View

n Route Pattern—Launch Route Pattern View


VMware, Inc. 13

n Processor—Launch Processor View

To access the tools, open the Service Assurance Manager Topology Browser Console, select a VoIPAvailability Manager object from the topology, and right click the object. Select Client Tools from thedrop-down list. The list of client tools displayed are context based to the selected object. Click on oneof the tools to launch it.

The VMware Smart Assurance VoIP Availability Manager Configuration Guide provides configurationinformation for VoIP client tools. The VMware Smart Assurance VoIP Management Suite Overviewand Integration Guide provides an overview about the use of client tools.

Processing flow overview

The flow of information among the components of a VoIP Availability Manager and Enablement Packdeployment proceeds as follows.

During discovery:

n The IP Availability Manager performs discovery of routers, switches, and hosts, as well as VoIPdevices, along with their physical and logical connectivity.

n The IP Availability Manager groups the VoIP devices into a Topology Collection using deploymentcustomization. This Topology Collection may be used to filter the devices monitored by VoIPAvailability Manager based on customers’ organizational partitioning.

n VoIP Availability Manager imports the VoIP device information from the IP Availability Manager, anduses that information as the foundation for its own discovery.

n VoIP Availability Manager uses SNMP discovery probes to discover the VoIP specific elements.

n After a successful discovery, VoIP Availability Manager creates a VoIP topology with relationshipsbetween the associated elements.

During event processing:

n The IP Availability Manager polls network elements and performs root-cause and impact analysis forthe IP domain.

n The IP Availability Manager sends notifications to the VoIP Availability Manager.

n VoIP Availability Manager, in conjunction with the installed Enablement Pack(s), uses SNMPInstrumentation to monitor the health of the VoIP topology and generate appropriate symptoms andevents.

n VoIP Availability Manager includes a built-in SNMP trap receiver which listens for VoIP related traps.Traps generated by the monitored devices and forwarded to the VoIP Availability Manager areprocessed to set the state of the referenced component. Note that the traps must be enabled andtheir destinations set.

n VoIP Availability Manager imports the performance oriented data collected by VoIP PerformanceManager to enrich the VoIP Availability Manager topology with information from traps sent at regularintervals.


VMware, Inc. 14

n The Global Manager receives notifications from the IP Availability Manager and the VoIP AvailabilityManager for presentation to network operations personnel.

The VMware Smart Assurance VoIP Availability Manager Configuration Guide provides detailedinformation about the architecture of VoIP Availability Manager and its Enablement Packs.

Discovery and monitoring

The Avaya Enablement Pack includes Avaya-specific probes that are activated when the VoIP AvailabilityManager starts. The probes analyze the unitary computer systems in the VoIP environment to determineif Avaya communications elements exist on them. In order for the probes to analyze the systems, allsystems hosting Avaya services and cards must be specified in a seed file or discovered using IPAvailability Manager's autodiscovery. When Avaya elements are discovered on a device, further analysisis performed to determine exactly which components are hosted on the given system. The Avaya-specificelements, such as applications and services, are then added to the VoIP Availability Manager’s topology.

The Avaya element classes that are discovered by the Avaya Enablement Pack are listed in “AvayaEnablement Pack object classes” on page 22.

Note The discovery of IP phones need to be enabled during configuration. By default, discovery forthese devices is not enabled. To do so, specify the settings in the BASEDIR/smarts/conf/voip/voip.conffile, as described in the VMware Smart Assurance VoIP Availability Manager Configuration Guide.

VoIP Availability Manager discovery starts after VMware Smart Assurance IP Availability Managercompletes its discovery cycle. IP Availability Manager uses a seed file to perform discovery. All systemshosting Avaya services and cards must be specified in the seed file used by IP Availability Manager. TheVMware Smart Assurance VoIP Availability Manager Discovery Guide provides detailed information ondiscovery by the VoIP Availability Manager. The VMware Smart Assurance IP Management SuiteDiscovery Guide provides detailed information about creating seed files.

After discovery, the VoIP Availability Manager and Avaya Enablement Pack monitor the status of theAvaya VoIP environment as reported by the Avaya communications components. Events derived fromtraps and SNMP polling, are analyzed and generate symptoms. “Discovering Elements and MonitoringEvents” on page 21 describes the events that may occur for each class.

Trap processing

The VoIP Availability Manager includes an integrated Trap Receiver and Notification Processor thatprovide the ability to utilize traps from external monitoring systems and map them into symptom eventsthat are used for root-cause or impact analysis.

The VMware Smart Assurance VoIP Availability Manager Configuration Guide provides detailedinformation on enabling trap processing.

Installation


VMware, Inc. 15

The Avaya Enablement Pack is installed from the media on which the VMware Smart Assurance VoIPAvailability Manager resides. It is installed into the same folder as VoIP Availability Manager.

The VMware Smart Assurance VoIP Availability Manager Installation Guide lists installation requirementsand provides detailed installation procedures.

A separate feature license is required and must be installed in order to use the Avaya Enablement Pack.The name of the Avaya feature is AP_VOIP_AVAYA.

After the Avaya Enablement Pack is installed and properly licensed, it starts whenever the VoIPAvailability Manager is started. For example, here is the UNIX command for starting the VoIP AvailabilityManager:

/opt/InCharge/VoIP/smarts/bin/sm_service start ic-voip-server

When the VoIP Availability Manager starts, it loads the avaya.import file and probes the unitary computersystems in the VoIP environment for Avaya VoIP applications.


VMware, Inc. 16

Integrating the EnablementPack with VoIP 3This chapter includes the following topics:

n Avaya virtual IP addresses

n Excluding Avaya virtual IP addresses from the topology

Avaya virtual IP addresses

As with most vendors, Avaya uses virtual IP addresses to provide redundancy in a hot standbyconfiguration. In VoIP networks, that redundancy is between the server systems running the Call Managerapplications that together form a Call Manager (redundancy) group. To client devices, the Call Managerappears as a single application running on a single server.

Excluding Avaya virtual IP addresses from the topology

You need to perform the following procedure to exclude virtual IP addresses from the topology discoveredby IP Availability Manager which is used by VoIP Availability Manager.

To exclude a virtual IP address, you create an ipExcludeList filter in the IP Availability Managerdiscovery.conf file.

Note In general, do not include any virtual IP addresses in a seed file and do not use the Add Agentcommand to enter virtual IP addresses. Seed files and the Add Agent command are described in theVMware Smart Assurance IP Management Suite Discovery Guide.

In addition, you might also want to create an ipExcludeList filter to exclude the service port on AvayaS8x00 Media Servers. The service port, preconfigured with IP address 192.11.13.6, provides a diagnosticand maintenance interface for Avaya engineers and technicians. Any attempt by IP Availability Managerto use the service port address to discover an S8x00 Media Server will fail.

Procedure to exclude an Avaya virtual IP address

Upon identifying the virtual IP address, use the ipExcludeList parameter in the discovery.conf file toprevent the IP address from being added to the discovered topology. You can use wildcards, described inAppendix B, “Wildcard Patterns,” to specify matching patterns in the IP exclude patterns. Any IP addressthat matches an exclude pattern will not be added to the topology.

VMware, Inc. 17

To exclude an Avaya virtual IP address from the topology:

1 Go to the BASEDIR/smarts/bin directory in the IP Availability Manager installation area and type thefollowing command to open the discovery.conf file:

sm_edit conf/discovery/discovery.conf

2 Add your ipExcludeList filter to the file.

Here is an example of an ipExcludeList filter:

ipExcludeList += "192.11.13.6"

3 Save and close the file. The modified version of the discovery.conf file is saved to the BASEDIR/smarts/local/conf/discovery directory.

4 If IP Availability Manager was running before you edited the discovery.conf file, restart IP AvailabilityManager.


VMware, Inc. 18

Discovering Elements andMonitoring Events 4This chapter includes the following topics:

n Avaya Enablement Pack object classes

n Avaya Enablement Pack attributes

n Events for VoIP Availability Manager Avaya elements

n Impact Analysis

n Aggregates Analysis

Avaya Enablement Pack object classes

VoIP Availability Manager builds a data model of the discovered Avaya VoIP elements in its domain. Themodel represents the elements and their relationships.

Avaya Enablement Pack object classes lists the elements that VoIP Availability Manager discovers forAvaya and displays in its topology.

Table 4-1. Avaya Enablement Pack object classes

Class Description

CallServer A Unitary Computer System that is responsible for hosting the VoIP CallManager

MediaGateway A Unitary Computer System that is responsible for the transfer of data, video,and audio streams

ConvergedCallManager Provides call processing, call control, transfer, and call routing functions

ConvergedCallManagerRedundancyGroup Redundant group of Avaya Communication Managers for S87xx type ofmedia server

GatewayService A VoIP network service used to pass traffic between Public SwitchedTelephone Networks and VoIP systems

Chassis A chassis for a PortNetwork

Card An Avaya card in a G650 PortNetwork Chassis

CardServiceRedundancyGroup A redundancy group composed of IPConnectors (Avaya IPSI cards) orMediaProcessors (Avaya MedPro cards). Either redundancy group can haveonly two cards.

H323Gatekeeper Control LAN service (CLAN service), hosted by circuit pack host of carrierswitch

VMware, Inc. 19

Table 4-1. Avaya Enablement Pack object classes (continued)

Class Description

IPConnector IPServer interface service (IPSI service), associated with port network switch

IPPhone A physical instrument that acts as a telephone using Voice over IPtechnology. An IP phone can transmit audio-only information or video andaudio information.

IPPhoneGroup A group of IP phones. IP phone groups correspond to topological objects thatare vendor-specific. For Avaya, the group includes IP phones configured toregister to the same converged call manager.

MediaProcessor Media processor service (MedPro service), hosted by circuit pack host ofcarrier switch

DS1Service A Digital Signal 1 (DS1) card-service application that provides

digital connectivity to the PSTN to enable long distance and local

telephone service.

VoiceAnnounceService Voice over LAN service (VAL service), hosted by circuit pack host of carrierswitch

H248RegistrationSession H248 link software session between media controller S87xx/S8500 or S8300and IP remote media gateway

PortNetwork A logical collection of VoIP functional cards

VoiceMailApplication An application that provides a voice mail service for Avaya devices.

VoipApplication A VoiceMailService, ConferenceService, or CTIService

VoipCluster A group of Call Managers

VoipProcess The processes that are components of network services or applications

Avaya Enablement Pack attributes

This section lists attributes for the Avaya Enablement Pack classes.

Note When VoIP Performance Manager is integrated with VoIP Availability Manager, the VoipCluster,ConvergedCallManager, H323GateKeeper, MediaProcessor, GatewayService, and DS1Service classesinclude additional attributes drawn from VoIP Performance Manager.

CardServiceRedundancyGroup

Key attributes for CardServiceRedundancyGroup lists some key attributes for theCardServiceRedundancyGroup class.


VMware, Inc. 20

Table 4-2. Key attributes for CardServiceRedundancyGroup

Attribute Description

AtRiskThreshold Indicates the lower bound for the percent of redundancy group elements that musthave a normal status before a notification is generated. When the number of elementswith a normal status falls below this threshold, an AtRisk notification is generated

CurrentlyFaulty Indicates if this SoftwareService is unavailable

Type HOT, STANDBY, FAILOVER

ConvergedCallManager

Key attributes for ConvergedCallManager lists some key attributes for the ConvergedCallManager class.

Table 4-3. Key attributes for ConvergedCallManager


VirtualIPAddr The virtual IP address of the redundant pair of Avaya Call Managers (if applicable)

IPAddress The primary IP address of the Avaya Call Manager

Priority The unique server number for the Avaya Call Manager: 0 indicates simplex call server;1 indicates the active call server; 2 indicates the standby call server

NetworkRegion The unique name for the Avaya Network Region

RegistrationIP The Registration IP address for the LSP or ESS call server that is registered with themain server

SyncIP File synchronization, IP address of LSP or ESS type of call server to sync with themain server

SyncAltIP File synchronization, Alternate IP address of LSP or ESS type of call server to syncwith the main server

IsACAEnabled An indication of whether Automated Circuit Assurance is turned on for this CallManager

ProcessorOccupancy Total Processor Occupancy of the call server

ConvergedCallManagerRedundancyGroup

Key attributes for ConvergedCallManagerRedundancyGroup lists some key attributes for theConvergedCallManagerRedundancyGroup class.

Table 4-4. Key attributes for ConvergedCallManagerRedundancyGroup


RedundancyGroupType HOT, STANDBY, FAILOVER

AtRiskThreshold Indicates the lower bound for the percent of redundancy group elements that musthave a normal status before a notification is generated. When the number of elementswith a normal status falls below this threshold, an AtRisk notification is generated

CurrentlyFaulty Indicates if this SoftwareService is unavailable


VMware, Inc. 21

GatewayService

Key attributes for GatewayService lists some key attributes for the GatewayService class.

Table 4-5. Key attributes for GatewayService


GatewayNumber A unique number for the Media Gateway

MACAddress The MAC address of the Media Gateway

IsIPFromDHCP An indication of whether the Media Gateway uses a DHCP service

RegistrationIP The IP address of the call server or gatekeeper when registered with the Gateway

RegistrationIP1 The IP address of first Local Spare Processor in controller list of the Media Gateway

RegistrationIP2 The IP address of second Local Spare Processor in controller list of the MediaGateway

RegistrationIP3 The IP address of third Local Spare Processor in controller list of the Media Gateway

RegistrationIP4 The IP address of fourth Local Spare Processor in controller list of the Media Gateway

H323GateKeeper

Key attributes for H323GateKeeper lists some key attributes for the H323GateKeeper class.

Table 4-6. Key attributes for H323GateKeeper


Name Service, IPAddress, Location

Status Responsive, unresponsive

Type CLAN


PortNetworkNo The number of the PortNetwork

Code The board type code, uniquely identifies the board type

RegisteredPhones

PhoneRegistrationChanges

The total number of phones registered with this GateKeeper;

The changes in the RegisteredPhones in the last sampling interval

IPConnector

Key attributes for IPConnector lists some key attributes for the IPConnector class.

Table 4-7. Key attributes for IPConnector






VMware, Inc. 22

Table 4-7. Key attributes for IPConnector (continued)



Type IPSI


IPPhone

Key attributes for the IPPhone class lists some key attributes for the IPPhone class.

Table 4-8. Key attributes for the IPPhone class


CallAgentActive IP address of the current call agent to which the IP phone is registered. This valuemay vary from the originally discovered call agent.

CallAgentDiscovered IP address of the discovered call agent to which the IP phone is registered

DisplayName Name of the IP phone as displayed in the Global Console

Extensions List of phone extensions associated with this phone

IPAddress IP address of the IP phone

MACAddress MAC address of the IP phone

Model Model of the IP phone

RegistrationStatus Registration state of the IP phone:

n Registered (default). The IP phone is active.

n Unregistered. The connection from the call agent to the IP phone closed in thenormal manner.

n Deceased. The connection from the call agent to the IP phone closed becausethe amount of time exceeded the keep-alive timeout limit.

n Failed. The IP phone failed to registered to the call agent.

n Unknown.

Type Type of the IP phone

Username Name of the user. The default is Admin.

Vendor Name of the IP phone’s supplier

IPPhoneGroup

Key attributes for the IPPhoneGroup class lists some key attributes for the IPPhoneGroup class.

Table 4-9. Key attributes for the IPPhoneGroup class


RegisteredPhones The number of registered IP phones in this group

TotalPhones The total number of IP phones in this group

UnregisteredPhones The number of unregistered IP phones in this group


VMware, Inc. 23

Table 4-9. Key attributes for the IPPhoneGroup class (continued)


UnregisteredThreshold The threshold value (percentage) of unregistered IP phones in the group

Vendor Name of the IP phone’s supplier

MediaProcessor

Key attributes for MediaProcessor lists some key attributes for the MediaProcessor class.

Table 4-10. Key attributes for MediaProcessor







ControlLinkStatus

EthernetLinkStatus

The status of Control Link circuit pack. One of: UP, DOWN, UNKNOWN;

The status of Ethernet Link circuit pack. One of: UP, DOWN, UNKNOWN

DS1Service

Key attributes for DS1Service lists some key attributes for the DS1Service class.

Table 4-11. Key attributes for DS1Service


Name Service, IPAddress, Location; IPAddress is the call server shared IP



DownTrunks

TotalTrunks

ActiveTrunks

The number of Trunks with Down status;

The total number of Trunks;

The total number of active Trunks

VoiceAnnounceService

Key attributes for VoiceAnnounceService lists some key attributes for the VoiceAnnounceService class.

Table 4-12. Key attributes for VoiceAnnounceService


Name The name of the VoiceAnnounceService



VMware, Inc. 24

Table 4-12. Key attributes for VoiceAnnounceService (continued)


Type The type of this service


H248RegistrationSession

Key attributes for H248RegistrationSession lists some key attributes for the H248RegistrationSessionclass.

Table 4-13. Key attributes for H248RegistrationSession


Name SESS and service name

GatewayEndIP The IPAddress of the Media Gateway

CardEndIP The CLAN IP address if this session is between a CLAN card and the gateway

ServerEndIP The Call Server IP if this session is between a call server and gateway

ActiveControllerIP The IP of the call controller for this gateway

IsActive TRUE if the Media Gateway Session is in use

IsDisconnected The current session is down

LinkErrorCode The session link error code

Type H248

PortNetwork

Key attributes for PortNetwork lists some key attributes for the PortNetwork class.

Table 4-14. Key attributes for PortNetwork



VoiceMailApplication

Key attributes for the VoiceMailApplication class lists some key attributes for the VoiceMailApplicationclass.

Table 4-15. Key attributes for the VoiceMailApplication class


Name APP-, host DNS name

IsCritical True or false

Status RESPONSIVE, UNRESPONSIVE


VMware, Inc. 25

Table 4-15. Key attributes for the VoiceMailApplication class (continued)


SystemName The system name hosting this service

Type This application type

NumberOfComponents The number of components for the voice mail application

VoipApplication

Key attributes for VoipApplication lists some key attributes for the VoipApplication class.

Table 4-16. Key attributes for VoipApplication


AgentSysName Administratively-assigned name for service’s host

ApplicationName Name of the application

IPAddress Last known IP address of the service

Status The current status of the Service. Value can be: RESPONSIVE, UNRESPONSIVE,DEGRADED, MALFUNCTION, STANDBY or UNKNOWN.

Type Application type

Vendor Manufacturer of the service

VoipCluster

Key attributes for VoipCluster lists some key attributes for the VoipCluster class.

Table 4-17. Key attributes for VoipCluster


Vendor The name of the vendor

TotalRoutePatterns

TotalTrunkGroups

TotalPhones

TotalDegradedRoutePatterns

TotalDegradedTrunkGroups

TotalDownRoutePatterns

TotalDownTrunkGroups

TotalDownPhones

The total number of RoutePatterns;

The total number of TrunkGroups;

The total number of Phones;

The total number of DegradedRoutePatterns;

The total number of DegradedTrunkGroups;

The total number of DownRoutePatterns;

The total number of DownTrunkGroups;

The total number of DownPhones

VoipProcess

Key attributes for VoipProcess lists some key attributes for the VoipProcess class.


VMware, Inc. 26

Table 4-18. Key attributes for VoipProcess


Name Process (runName) name of the process

ProcessName All processes for MAS/MSS are .exe files

PID The unique process ID


Events for VoIP Availability Manager Avaya elements

Events reported by VoIP Availability Manager for Avaya EP lists the classes of elements managed byVoIP Availability Manager with the Avaya Enablement Pack and the events that may occur for each class.

Table 4-19. Events reported by VoIP Availability Manager for Avaya EP

Class Events Description

Card OperationallyDown The problem pertains to a card that is providing aVoIP card service (such as Avaya’s CLAN or IPSIcard) and is diagnosed by VoIP Availability Managerthrough a received Avaya trap

CardServiceRedundancyGroup AllComponentsDown

AtRisk

ReducedRedundancy

All of the components in the redundancy group aredown

The number of functioning components is below theAtRiskThreshold

At least one component is not functioning but thetotal number of functioning components is aboveAtRiskThreshold

ConvergedCallManager BackupActivated

MajorFailover

MinorFailover

LoadException

Unresponsive

A primary call manager has failed and a secondarycall manager has been activated

A major failure was observed and a failover tookplace giving control to the Enterprise SurvivorableServer (ESS)

A Minor failure was observed and a failover tookplace giving control to the Local SurvivorableProcessor (LSP)

The occupancy of the call server processor hasexceeded the threshold

This entity is unresponsive according to the statusreceived or all of its critical components areunresponsive


VMware, Inc. 27

Table 4-19. Events reported by VoIP Availability Manager for Avaya EP (continued)


ConvergedCallManagerRedundancyGroup

NoIPStationRegistered

AllComponentsDown

AtRisk

ReducedRedundancy

No IP end points are registered to any member ofthis redundancy group. This implies a significantfailure may be underway

There is more than one component in the group,and all components are down

The number of functioning components is below theAtRiskThreshold

There are down components in the group, but theup percent is above the AtRiskThreshold

DS1Service LoadException

TrunksUnavailable

Active trunk percentage has exceeded thethreshold. Indicates the service may be overloaded

All trunks from this DS1 card are down

GatewayService Unregistered

Unresponsive

This Media Gateway service is not registered withany call server and hence provides no functionality

This entity is unresponsive according to the statusreceived or all of its critical components areunresponsive

H323Gatekeeper RegistrationException

PhonesUnavailable

Unresponsive

There are phones still registered to this service, butthe reduced phone registration count has exceededthe threshold in the last data sampling interval

There were phones previously registered to thisservice, but all phones registrations have beendropped due to possible network problems

Received trap indicates the CLAN is unresponsive

H248RegistratioonSession Disconnected The H.248 link between the gateway and its CallManager or H.323 gatekeeper is down.

IPConnector Unresponsive Received trap indicates IPSI is unresponsive

IPPhone Unregistered

RegistrationRejected

IP phone is not registered with any call agent

Attempts by the IP phone to register with the callagent were rejected

IPPhoneGroup Degraded Unregistered IP phone percentage exceeds thethreshold.

MediaProcessor LinksUnavailable

Unresponsive

Control link or Ethernet link is down

Received trap indicates MedPro is unresponsive

UnitaryComputerSystem

Host; Switch; Router; Node;CallServer; MediaGateway

ProxyDown (not visible) Received Down event from IP Manager

VoiceAnnounceService Unresponsive Received trap indicates VAL is unresponsive

VoipApplication Unresponsive

PartialUnresponsive

This entity is unresponsive according to the statusreceived or all of its critical or key components areunresponsive

Partial components are unresponsive.


VMware, Inc. 28

Table 4-19. Events reported by VoIP Availability Manager for Avaya EP (continued)


VoiceMailApplication Unresponsive

PartialUnresponsive



VoipCluster ResourceException

RoutePatternsUnavailable

TrunkGroupsUnavailable

PhonesUnavailable

Degraded route patterns or trunk groups exist in thiscluster

All route patterns in this cluster are down

All trunk groups in this cluster are down

All phones in this cluster are down

VoipNetworkService Unresponsive

PartialUnresponsive



VoipProcess Unresponsive This entity is unresponsive according to the statusreceived or all of its critical components areunresponsive

Impact Analysis

Impacts describe the effect of an event or aggregate of events on other elements in the system.

Down root-cause problems and impacts lists Down root-cause problems and their impacts.

ServiceExeption root-cause problems and impacts lists ServiceException root-cause problems and theirimpacts.

Table 4-20. Down root-cause problems and impacts

Problem Impacts

Card Down OperationallyDown

Card CardImpact

PackagesSystemUSC SystemImpact

ComposedCard CardImpact

CardRedundancyGroup GroupImpact

RealizedNetworkAdapterImpact

DS1Service Down Unresponsive

DS1Service TrunksUnavailable

GatewayService Down Unresponsive

GatewayService Unregistered;

H248RegistrationSession Disconnected;


VMware, Inc. 29

Table 4-20. Down root-cause problems and impacts (continued)

Problem Impacts

H323GateKeeper Down Unresponsive

GatewayService Unregistered;

IPPhone Unregistered;

IPPhoneGroup Degraded;

H248RegistrationSession Down GatewayService Unregistered

Disconnected

IPConnector Down Unresponsive

CardServiceRedundancyGroup AllComponentsDown or ReducedRedundancyor AtRisk;

Port Down ProxyDown (not visible)

ConnectedIPPhone Unregistered

VoiceAnnounceService Down Unresponsive

VoipApplication Down Unresponsive

VoipProcess Unresponsive

VoipNetworkService Down Unresponsive


VoiceMailApplication Down Unresponsive

VoipProcess Unresponsive;

UnitaryComputerSystem Down

(including subclasses)

Hosting Service DownSymptoms

Composed Card CardImpact

Composed UCS SystemImpact

Table 4-21. ServiceExeption root-cause problems and impacts

Problem Impacts

VoipApplication ServiceException PartialUnresponsive


VoipNetworkService ServiceException PartialUnresponsive


VoiceMailApplication ServiceException PartialUnresponsive


Aggregates Analysis

Aggregates indicate impacts on the logical group or application from services or components which haveperformance or availability exceptions. Aggregates lists the current aggregates.


VMware, Inc. 30

Table 4-22. Aggregates

Class Aggregate name/description Component events

VoipCluster PerformanceExceptions

VoipCluster issues a single notification toaggregate performance exceptions onprocessor overload; call overload; mediaresource overload; media resourcerequest being rejected; DS1 trunkoverload; large phone registrationchanges, and so forth

VoipCluster ResourceException;

ConvergedCallManager LoadException;

DS1Service LoadException;

AvailabilityExceptions

VoipCluster issues a single notification toaggregate availability exceptions onroute pattern, trunk group, voice mail,phone are unavailable, or anycomponents

VoipCluster PhonesUnavailable;

VoipCluster RoutePatternsUnavailable;

VoipCluster TrunkGroupsUnavailable;

VoipCluster PhoneUnavailable;

CardServiceRedundancyGroupAllComponentsDown;

H323GateKeeper PhonesUnavailable;

H323GateKeeper RegistrationException;

MediaProcessor LinksUnavailable;

DS1Service TrunksUnavailable;

IPPhone Impacted NetworkAdapter_PerformanceHighUtilization;

NetworkAdapter_PerformanceHighErrorRate;

NetworkAdapter_PerformanceHighDiscardRate;

NetworkAdapter_PerformanceHighBroadcastRate;

NetworkAdapter_PerformanceHighCollisionRate;

NetworkAdapter_PerformanceHighQueueDropRate;

IPPhoneGroup Impacted

When one or more of the call managergroups it registers are down, or allgateway devices have unregistered withcall managers in the group, or all mediadevices have unregistered with callmanagers in the group.

ConvergedCallManagerRedundancyGroup AllComponentsDown;

ConvergedCallManager Unresponsive;

H323Gatekeeper Unresponsive;

NetworkAdapter_PerformanceHighUtilization;

NetworkAdapter_PerformanceHighErrorRate;

NetworkAdapter_PerformanceHighDiscardRate;

NetworkAdapter_PerformanceHighBroadcastRate;

NetworkAdapter_PerformanceHighCollisionRate;

NetworkAdapter_Performance

HighQueueDropRate;


VMware, Inc. 31

Table 4-22. Aggregates (continued)

Class Aggregate name/description Component events

RegistrationExceptions IPPhone Unregistered

PortNetwork Impacted

When the ConvergedCallManager whichservers PortNetwork or the IPConnectorwhich is the critical component ofPortNetwork, is unresponsive, thisPortNetwork cannot prove any VoIPfunction

ConvergedCallManager Unresponsive;

IPConnector Unresponsive


VMware, Inc. 32

Default Notification Attributes 5This appendix lists the default notification attributes for events that are displayed by the VoIP AvailabilityManager with the Avaya Enablement Pack.

This chapter includes the following topics:

n Default notification attributes

Default notification attributes

The VoIP Availability Manager with the Avaya Enablement Pack displays various default notificationattributes for events.

Default notification attributes lists the default notification attributes.

Table 5-1. Default notification attributes

Notification attribute Description

AutoAcknowledgmentInterval Automatically acknowledge this event if it is cleared for thisinterval 0 means never autoAcknowledge.

Category Category of this event. The event category represents a broadcategorization of the event, for example, availability againstperformance.

Certainty The certainty of this event. Defaults to 100.

ClassName Class name of the object where this event occurred. Thisattribute along with InstanceName and EventName uniquelyidentify this event.

ClassDisplayName Display name for the event class. Defaults to ClassName.

ClearOnAcknowledge Indicates if this event should be cleared when it isacknowledged. Set this to TRUE only for events that do notexpire nor have sources that generate a clear. Defaults toFALSE.

Description A textual description of the object. Defaults to “ ”.

DisplayName The string shown in the GUI when this object is displayed.Defaults to Name.

EventName Name of the event. This attribute along with ClassName andInstanceName uniquely identify this event.

EventDisplayName Display name for the event Name. Defaults to EventName.

EventText The textual representation of the event.

VMware, Inc. 33

Table 5-1. Default notification attributes (continued)

Notification attribute Description

EventType Indicates the nature of the event. A MOMENTARY event has noduration. An authentication failure is a good example. ADURABLE event has a period during which the event is activeand after which the event is no longer active. An example of adurable event is a link failure.

(Possible values: DURABLE, MOMENTARY).

InstanceName Instance name of the object where this event occurred. Thisattribute along with ClassName and EventName uniquelyidentify this event.

InstanceDisplayName Display name for the event instance. Defaults to InstanceName.

OccurredOn The element the indication is associated with. Setting this valuecauses ElementClassName and ElementName to be setappropriately.

OriginalSources This table maps an original source to corresponding immediatesources.

ServiceName Name of external server used for imported events andinstrumented attributes.

Severity An enumerated value that describes the severity of the eventfrom the notifier's point of view: 1—Critical is used to indicateaction is needed NOW and the scope is broad, for example, anoutage to a critical resource. 2—Major is used to indicate actionis needed NOW. 3—Minor should be used to indicate action isneeded, but the situation is not serious at this time. 4—Unknown indicates that the element is unreachable,disconnected or in an otherwise unknown state. 5—Normal isused when an event is purely informational. Default = 5.

SourceDomainName The name(s) of the domain(s) that have originally diagnosedand notified—directly or indirectly—current occurrences of thisevent. If there are more than one original domain, the attributelists each separated by a comma. When the notification iscleared, the last clearing domain stays in the value.

TroubleTicketID Trouble ticket ID. Defaults to "".

UserDefined1-UserDefined10 Ten user defined fields. Each field defaults to "".


VMware, Inc. 34

Understanding the sm_editUtility 6This chapter includes the following topics:

n The sm_edit utility

The sm_edit utility

As part of the VMware Smart Assurance deployment and configuration process, you need to modifycertain files. User modifiable files include configuration files, rule set files, templates, and files (such asseed files, and security configuration files) that contain encrypted passwords. Original versions of thesefiles are installed into appropriate subdirectories under the BASEDIR/smarts/ directory.

Original versions of files should not be altered. If a file requires modification, it must be stored as a localcopy of the file in BASEDIR/smarts/local or one of its subdirectories. The VMware Smart AssuranceSystem Administration Guide provides additional information about the sm_edit utility.

Example 1

Modify serverConnect.conf

In UNIX:

n The original version of the server connect (serverConnect.conf) security configuration file is installedto:

/opt/InCharge/VoIP/smarts/conf

n A modified serverConnect.conf security configuration file should be saved to:

/opt/InCharge/VoIP/smarts/local/conf

n Smarts software is designed to first search for user modifiable files in BASEDIR/smarts/local or one ofits subdirectories. If a modified version of a file is not found in the local area, Smarts softwaresearches appropriate nonlocal directories.

To facilitate proper file editing, VMware, Inc. provides the sm_edit utility with every Smarts productsuite. When used to modify an original version of a file, this utility automatically creates a local copy ofthe file and places it in the appropriate location under BASEDIR/smarts/local. This ensures that theoriginal version of the file remains unchanged. You can invoke sm_edit from the command line.

VMware, Inc. 35

To invoke the sm_edit utility from the command line, specify the path and the name of the file to editunder BASEDIR/smarts. If multiple Smarts products are running on the same host, invoke sm_editfrom the bin directory of the product suite with the files to edit.

Example 2

Edit a configuration file

To edit the configuration file for connecting to a server (serverConnect.conf), invoke:

/opt/InCharge/VoIP/smarts/bin>sm_edit conf/serverConnect.conf

In this example, the sm_edit utility automatically creates a local copy of the serverConnect.conf file inthe /opt/InCharge/VoIP/smarts/local/conf directory and opens the file in a text editor. If a local version ofthe file already exists, the sm_edit utility opens the local version in a text editor. In addition, sm_editcreates any necessary subdirectories.


VMware, Inc. 36

Wildcard Patterns 7This chapter includes the following topics:

n Types of wildcard patterns

Types of wildcard patterns

A wildcard pattern is a series of characters that are matched against incoming character strings. You canuse these patterns when you define pattern matching criteria.

Matching is done strictly from left to right, one character or basic wildcard pattern at a time. Basic wildcardpatterns are defined in Basic wildcard patterns. Characters that are not part of match constructs matchthemselves. The pattern and the incoming string must match completely. For example, the pattern abcddoes not match the input abcde or abc.

A compound wildcard pattern consists of one or more basic wildcard patterns separated by ampersand(&) or tilde (~) characters. A compound wildcard pattern is matched by attempting to match each of itscomponent basic wildcard patterns against the entire input string. Compound wildcard patterns are listedin Compound wildcard patterns.

If the first character of a compound wildcard pattern is an ampersand (&) or tilde (~) character, thecompound is interpreted as if an asterisk (*) appeared at the beginning of the pattern. For example, thepattern ~*[0-9]* matches any string not containing any digits. A trailing instance of an ampersandcharacter (&) can only match the empty string. A trailing instance of a tilde character (~) can be read as“except for the empty string.”

Note Spaces are interpreted as characters and are subject to matching even if they are adjacent tooperators like “&”.

Table 7-1. Basic wildcard patterns

Character Description

? Matches any single character.

For example, server?.example.com matches server3.example.com and serverB.example.com, but notserver10.example.com.

* Matches an arbitrary string of characters. The string can be empty.

For example, server*.example.com matches server-ny.example.com and server.example.com (an emptymatch).

VMware, Inc. 37

Table 7-1. Basic wildcard patterns (continued)


[set] Matches any single character that appears within [set]; or, if the first character of [set] is (^), any singlecharacter that is not in the set. A hyphen (-) within [set] indicates a range, so that [a-d] is equivalent to[abcd]. The character before the hyphen (-) must precede the character after it or the range will be empty.The character (^) in any position except the first, or a hyphen (-) at the first or last position, has no specialmeaning.

For example, server[789-].example.com matches server7.example.com through server9.example.com, butnot server6.example.com. It also matches server-.example.com.

For example, server[^12].example.com does not match server1.example.com or server2.example.com, butwill match server8.example.com.

<n1-n2> Matches numbers in a given range. Both n1 and n2 must be strings of digits, which represent nonnegativeinteger values. The matching characters are a non-empty string of digits whose value, as a nonnegativeinteger, is greater than or equal to n1 and less than or equal to n2. If either end of the range is omitted, nolimitation is placed on the accepted number.

For example, 98.49.<1-100>.10 matches a range of IPv4 addresses from 98.49.1.10 through98.49.100.10.

Example of an omitted high end of the range: <50-> matches any string of digits with a value greater thanor equal to 50.

Example of an omitted low end of the range: <-150> matches any value between zero and 150.

For a more subtle example: The pattern <1-10>* matches 1, 2, up through 10, with * matching nocharacters. Similarly, it matches strings like 9x, with * matching the trailing x. However, it does not match11, because <1-10> always extracts the longest possible string of digits (11) and then matches only if thenumber it represents is in range.

| Matches alternatives. For example,”ab|bc|cd” without spaces matches exactly the three following strings:“ab”, “bc”, and “cd”. A | as the first or last character of a pattern accepts an empty string as a match.

Example with spaces “ab | bc” matches the strings “ab” and “ bc”.

\ Removes the special status, if any, of the following character. Backslash (\) has no special meaning withina set ([set]) or range (<n1-n2>) construct.

Special characters for compound wildcard patterns are summarized in Compound wildcard patterns.


& “And Also” for a compound wildcard pattern. If a component basic wildcard pattern is preceded by & (or is thefirst basic wildcard pattern in the compound wildcard pattern), it must successfully match.

Example: *NY*&*Router* matches all strings that contain NY and also contain Router.

Example: <1-100>&*[02468] matches even numbers between 1 and 100 inclusive. The <1-100> componentonly passes numbers in the correct range and the *[02468] component only passes numbers that end in aneven digit.

Example: *A*|*B*&*C* matches strings that contain either an A or a B, and also contain a C.

~ “Except” for a compound wildcard pattern (opposite function of &).If a component basic wildcard pattern ispreceded by ~, it must not match.

Example: 10.20.30.*~10.20.30.50 matches all devices on network 10.20.30 except 10.20.30.50.

Example: *Router*~*Cisco*&*10.20.30.*~10.20.30.<10-20>* matches a Router, except a Cisco router, with anaddress on network 10.20.30, except not 10.20.30.10 through 10.20.30.20.


VMware, Inc. 38