chapter 5: managing groups...chapter 5-1 administration of cisco prime lan management solution 4.2...

Administratio

OL-25947-01

C H A P T E R 5
Managing Groups
LMS 4.2 combines the device grouping with a new attribute list.

The other grouping services that are available in LMS are:

• Fault Group - supports 50 groups

• IPSLA Collector Group - supports 100 groups

• Port and Module Group - supports 100 groups

The numbers of groups that LMS supports will vary according to the SKU that you use. For more details, see Application Scaling Numbers section in the Installing and Migrating to Cisco Prime LAN Management Solution 4.2 guide.

This chapter explains the following:

• Groups - Components and Basic Concepts

• Groups in Single-Server and Multi-Server Setup

• Device Group Administration

• DCR Mode Changes and Group Behavior

• Port and Module Group Administration

• Working with Fault System-defined Groups

• Working with Customizable Groups

• Managing Fault Groups

• Viewing Fault Group Details

• Viewing Fault Membership Details

• Refreshing Fault Membership

• Deleting Fault Groups

• Understanding Collector Group Rules

• IPSLA Collector Group Administration Process

• Understanding IPSLA Collector Group Administration

• Working with User-Defined Collector Groups

• Operation-Based Collector Groups (System-Defined)

5-1n of Cisco Prime LAN Management Solution 4.2

Chapter 5 Managing Groups Groups - Components and Basic Concepts

Groups - Components and Basic ConceptsThis section explains the components of a group and the basic concepts of a group.

Components

The following are the components of a group:

• Group Server:

Manages groups of devices. It helps you to create, edit, delete, and refresh groups to be shared by the application. It interfaces with an application service adapter (ASA) to evaluate group rules and retrieve devices of a particular group.

• Application Service Adapters (ASAs):

Application-specific information repository that serves as source of the devices and attributes that are grouped by the Groups Server.

Till LMS 3.2, ASA was an interface between applications and Groups Server.

In LMS 4.2, there is only a single ASA.

• Group Admin:

Allows you to interact with the Groups Server to create and manipulate groups using Group Admin.

Basic Concepts

The following are the basic concepts of a group:

• Group Class:

Representation of a set of devices belonging to DCR. In this context a device in Device and Credential Repository (DCR) is a single instance of a class. Each instance (device) will have a set of attributes and a unique device ID.

• Group Object:

Device in a group class. Each device in the group will have a set of attributes stored in DCR. Associated with every device is a unique and immutable device ID.

• Group:

Named aggregate entity comprising a set of devices belonging to a single class or a set of classes, with a common superclass. Groups can be shared between users or applications, subject to access-control restrictions. The membership of a group is determined by a rule.

• Group Rule:

Consists of one or more rule expressions combined by operators, which can be AND, OR or EXCLUDE. A rule always evaluates to objects of a particular class defined in an application schema.

5-2Administration of Cisco Prime LAN Management Solution 4.2

OL-25947-01

Chapter 5 Managing Groups Groups in Single-Server and Multi-Server Setup

Groups in Single-Server and Multi-Server SetupThis section has the following subsections:

• Groups in Single Server Scenario

• Groups in Multi-Server Scenario

Groups in Single Server Scenario

The devices you see in the Group Administration UI in depends on whether the devices are being managed by LMS or not, and not on any application like CS, RME, CM.

In LMS 3.2, if there are Common Services, LMS, and RME installed on a server, you can see the following groups in the Groups UIs of the applications.

• CS@hostname

• RME@hostname

• Campus@hostname

In LMS 4.2, there are no separate applications and there are four types of groups:

• Device Groups

The device group name is LMS@hostname, instead of CS@hostname, RME@hostname, and Campus@hostname. LMS supports 200 device groups.

• Fault Groups

These groups are created by the Fault Management module in LMS, and consist of interface, trunk port, and access port groups. Each group has a set of properties (such as a name, description, and permission.), and are defined by the rules associated with the group.

• IPSLA Collector Groups

You can group IPSLA collectors based on a set of criteria such as operation name, operation type, source address, target address.

• Port and Module Groups

You can group ports and modules for easy port and module selection in various configuration workflows.

Groups in Multi-Server Scenario

Groups you create in LMS groups UI in the Master get synchronized with the Slave.

If you create a subgroup under LMS@Master hostname in one server, it appears under LMS@Slave hostname in the peer server.

However, in the Master server, if you create a subgroup under LMS@Master hostname, it will always appear under LMS@\Slave hostname\, in the Slave. That is, the subgroup created in the Master appears under the shared group of the application in the Slave.

When the user-defined group under master and the user-defined group under slave has the same group name, then when doing master slave setup, the master group will be retained in slave. The slaves group will get deleted.


OL-25947-01

Chapter 5 Managing Groups Device Group Administration

Once the master slave setup is done, when we add a group in master it will be synced with slave only after OGS process is restarted. The direct sync up will be done only during the setup. After setup, both the OGS will act as a individual servers.

Note You can create groups in LMS even if the server on which it is installed is in Slave mode.

If you have created a subgroup under LMS@Master hostname , in S, you can see this subgroup under LMS@Slave hostname.

In a cluster, if you have M as the Master, and S1 and S2 as M’s slaves, and you want to evaluate S1’s groups from S2, you need to import the certificate of S1 to S2 and vice versa.

Device Group AdministrationThe Group Administration UI helps you to create, edit, view, delete, export, import, and refresh groups. The UI displays a Group Selector that contains the following predefined higher-level groups:

• System-defined Groups

• User-defined Groups

The System-defined Groups shows subgroups only after Device and Credential Repository is populated.

The predefined sub-groups under System-defined Groups are:

• Cisco Interfaces and Modules

• Network Management

• Non Cisco Devices

• Routers

• Switches and Hubs

• Subnet Based Groups

Contains sub folders representing subnets (one folder per subnet) discovered in the network. Each folder contains the devices corresponding to those subnets.

Note Subnets groups will appear only after a successful Data Collection.

• Voice and Telephony

• Unknown Device Type

• Universal Gateways and Access Servers

• Wireless

You can create subgroups only under User-defined Groups. You cannot create them under System-defined Groups. However, you can view the details of a subgroup under System-defined Groups and refresh the group.

Note Group Administration UI will be enabled only on servers in which DCR is in Master or Standalone mode. The groups created in DCR Master will be copied to Group Administration instances on servers where DCR is in Slave mode.


OL-25947-01


The following sections provide information on how to perform group administrative tasks in LMS 4.2:

• Migrating Device Groups from Previous Releases of LMS

• Creating Groups

• Viewing Group Details

• Modifying Group Details

• Refreshing Groups

• Deleting Groups

• Exporting Groups

• Importing Groups

• Overview of Subnet Based Groups

Migrating Device Groups from Previous Releases of LMS

The following table explains migration of device groups from previous releases of LMS, in the table. In this example, Group A is an application group created separately in CS, RME, and CM, in earlier versions of LMS:

Creating Groups

This section contains:

• Specifying Group Properties

• Defining Group Rules

• System Defined Attributes

• Assigning Group Membership

You can create device groups using this feature.

To create a new device group:

LMS VersionCommon Services UDG/SDG RME UDG/SDG Campus Manager UDG/SDG

3.2.1 Group A Group A Group A

4.2 After migration to LMS 4.2, Group A is Available

After migration to LMS 4.2, Group A is not available

After migration to LMS 4.2, Group A is not available

3.2.1 — Group A Group A

4.2 — After migration to LMS 4.2, Group A will not be available

After migration to LMS 4.2, Group A will not be available

3.2.1 — — Subnet-based groups

4.2 You must create new subnet-based groups after a successful Data Collection

— After migration to LMS 4.2, CM Subnet-based groups will not be available.


OL-25947-01


Step 1 Either:

• Select Admin > System > Group Management > Device.

The Group Administration page appears.

Or

• Select Inventory > Group Management > Device.


The Group Administration in the Group Administration page provides you with Group Selector.

Step 2 Select the group from the groups listed in Group Selector to create a new subgroup.

The Group Info fields on the right, display details of the selected group.

The group you select here is the Parent group for the new group that you are about to create. You can change the Parent group later, if required. You cannot create groups under System-defined Groups but you can view details and refresh the group.

Users in admin role have read-write access to User-Defined groups based on the visibility scope (Public or Private). If you have the required permissions, you can create subgroups under groups.

Step 3 Click Create to create a new group.

The Group Administration Creation wizard is launched and guides you through the process of creating a new group.

Perform the following tasks using the Groups Create wizard.

a. Specify group properties. See Specifying Group Properties for information.

b. Define group rules. See Defining Group Rules for information.

c. Assign group membership. See Assigning Group Membership for information.

The first page in the wizard is the Properties:Create window. While creating a new group you must complete all of the above three tasks in this sequence to create a group.

If you exit the wizard at any stage by clicking Cancel, the details you have specified will be lost and the group will not be created.

The recommended limit for creating User-Defined group is 200, but you are allowed to create upto 600 User-Defined groups in LMS.

Example

To create a group of all Energywise capable devices:

Step 1 Either:



Or



The Group Administration in the Group Administration page provides you with Group Selector.

Step 2 Select User Defined Groups from the groups listed in Group Selector to create a new subgroup.


OL-25947-01


Step 3 Click Create to create a new group.

The Properties page appears.

Step 4 Enter the name Energywise_capable devices in the Group Name field in the Properties:Create dialog box.

Note See Specifying Group Properties for more details.

Step 5 Click Next.

The Rule Dialog box appears.

Step 6 Create an expression in the Rules:Create dialog box by entering:

a. Select Variable as EnergyWise.EnergyWisestate

b. Select Operator as =

c. Enter the Value as EnergyWise_capable

Step 7 Click Add Rule Expression.

The rule is added into the Rule Text.

You can also check the syntax of the group rule entered.

Note See Defining Group Rules for more details.

Step 8 Click Next.

The Group Membership Assigning page appears.

Step 9 Select one or more devices in Available Objects From Parent Group column.

To select multiple devices, hold the Ctrl or Shift keys down and click on the devices.

Step 10 Click Add.

The selected devices are removed from the Available Objects From Parent Group and added to the Object Matching Membership Criteria column.

Note See Assigning Group Membership for more details.

Step 11 Click Next.

The Summary page appears.

Step 12 Click Finish.

Specifying Group Properties

While specifying group properties, you can enter the properties such as name and description, and modify the parent group, if required, and update membership, and specify the visibility scope.

To complete the tasks in this phase:

Step 1 Either:


OL-25947-01


• Select Admin > System > Group Management > Device. Click


Or



Step 2 Click the Create button in the Group Administration.


Step 3 Enter a name for the group in the Group Name field in the Properties:Create dialog box.

The group name should be unique within the Parent group. However, it need not be so across groups. The same group name cannot be used in the same group hierarchy.

For example, if you have a group /LMS@Servername/User Defined Groups/MyView, you cannot create another group with the same name “MyView” under /LMS@Servername/User Defined Groups.

Step 4 Click Select Group, if you want to copy the attributes of an existing group.

The Replicate Attributes dialog box appears.

Step 5 Select the group you need from the Replicate Attributes list and click OK. To return to the Properties page, click Cancel.

Step 6 Click Change Parent, to change the Parent group.

The Group Selector page appears.

Step 7 Select the group you need from the Select Parent list.

Step 8 Click OK.

The Group Administration wizard changes the Parent group to the one you selected. To return to the Properties page, click Cancel.

Step 9 Enter a description for the group.

Typically, you can enter a detailed description of the group that identifies its characteristics in this field.

Step 10 Select the Membership Update mode for the group.

The modes of membership updates available are:

• Automatic:

The membership of the group is updated when you add a new device to the group, and each time the group is invoked.

• Only Upon User Request:

The membership of the group is recomputed only when an explicit request is made, using the Refresh option.

If you select Automatic, the group will be a Dynamic group. If you select Only Upon User Request, the group will be a Static group.

Step 11 Select either Public or Private to specify the visibility scope.

• Private

The group created can be viewed only by user who creates the group.

• Public

The group created can be viewed by all users.


OL-25947-01


Step 12 Click Next to get to the Rule:Create dialog box. See Defining Group Rules to define simple and composite group rules.

Defining Group Rules

In the Rules:Create dialog box, you can define the rules for the group. The rules you define in this phase determine the contents of the group. The rules you specify here determine the devices to be included in the group.

In the Rules:Create dialog box, you can either enter the rules directly in the Rule Text field, or select the components of the rule from the Rule Expression fields, and form a rule.

The rule expression has the following components:

Object.Variable operator “value”

If you have created the group by copying the attributes of another group, the rules specified for that group appear in the Rule Text field. You can retain these and add more rules, or delete these rules and create a new set of rules.

The Rules:Create dialog box allows you to check the syntax in the Rules Text field. You can use this facility to validate the rules you have created. If you leave the rule blank, it creates a Container group.

Click View Parent Rules to display the rules defined for its ancestor groups.

This section explains:

• Defining a Group Rule

• Defining Composite Group Rules

• Using IP Address Range Operator

• Examples

• System Defined Attributes

Before you launch the Rule:Create dialog box, ensure that you have completed all the tasks in Properties:Create dialog box. See Specifying Group Properties for more information.

Defining a Group Rule

To create a group rule:

Step 1 Complete all the tasks in the Properties page. See Specifying Group Properties for more information.

Step 2 Delete the rules displayed in the Rule Text field, if any.

Step 3 Select appropriate parameters for the following:

• Object Type — Denotes the object type used for forming a group. All expressions start with the string Device.

• Variables — Denotes the device attributes, which are used to form a device group.

See System Defined Attributes for details on the variables.

• Operators — Denotes the various operators to be used with the rule. The list of operators includes equals, contains, startswith and endswith. The list of operators changes dynamically with the value of the variable selected.


OL-25947-01


For the ManagementIpAddress variable, you can select a range operator other than the standard list of operators. See Using IP Address Range Operator for more information.

• Value — Denotes the value of the variable. The value field changes dynamically based on the value of the variable and operator selected, and the field type can be a text field or a list box.


The Group Administration wizard creates the rule based on the parameters you specified and adds the rule to the Rules Text field.

For example, the rule type:Device.DisplayName equals "joe"

will select the device with the DisplayName joe.

The Rules:Create dialog box refreshes and displays the Boolean operator field before the Object Type field in Rules Expression.

You can form composite rules using the OR, AND, or EXCLUDE options in the Boolean operator field. See Defining Composite Group Rules for more information.

You can validate rules that are entered directly into the Rules Text field, or rules formed using the Add Rules Expression option in the dialog box.

• To check whether the syntax is valid, click Check Syntax.

• To view the rules defined for the parent groups, click View Parent Rules.

Step 5 Click Next.

The wizard takes you to the Membership:Create dialog box, where you can further refine the group definition by adding or deleting specific devices from the group. See Assigning Group Membership for more information.

If you have entered an invalid IP Address range or invalid values in the Value field, an error message will be displayed. You should correct the values and then navigate to the Membership:Create dialog box.

Defining Composite Group Rules

A Composite rule contains more than one rule expression separated by a Boolean operator.

The Boolean Operators OR, AND, or EXCLUDE appear in the Rules:Create dialog box only when you have entered at least one rule expression.

When the composite rule has more than two simple rule expressions, you can adjust priorities among the expressions using opening and closing parenthesis.

To create a composite rule:

Step 1 Delete the rules displayed in the Rule Text field and click any other field.

Step 2 Form a simple rule. See Defining a Group Rule for details.


The Group Administration wizard creates the rule based on the parameters you specified and adds the rule to the Rules Text field.

The Rules:Create dialog box refreshes and displays the Boolean operator field before the Object Type field in Rules Expression.

Step 4 Select a Boolean Operator from the drop-down list.


OL-25947-01


Step 5 Select the appropriate parameters for Object Type, Variables, and Operators.

Step 6 Enter a value in the Value field.


You can validate rules that are entered directly into the Rules Text field or rules formed using the Add Rules Expression option in the dialog box.

• To check whether the syntax is valid, click Check Syntax.

• To view the rules defined for the parent groups, click View Parent Rules.

Step 8 Click Next.

The wizard takes you to the Membership:Create dialog box, where you can further refine the group definition by adding or deleting specific devices from the group. See Assigning Group Membership for more information.

Using IP Address Range Operator

The range operator enables you to group the devices of the specified range of IP Addresses. You can select the range operator only for the ManagementIpAddress and IP.Address variables.

You should enter the range of IP Addresses in the Value field, to create a group rule based on IP Address ranges.

When you enter the IP Address range in the text field, you should:

• Specify the range with permissible values for one or more octets in the IP Address.

The minimum limit in the range is 0 and the maximum limit is 255.

• Use the hyphen character (-) as a separator between the numbers that indicate a range.

• Specify the range of IP Addresses within the [and] characters to create a group rule.

For example, you can enter 10.10.10.[0-255] or 10.10.[0-255].[0-255] in the Value field.

You should not:

• Enter numbers less than 0 and greater than 255 in the IP Address range.

• Enter any characters other than the range separator (-).

• Enter the value of the highest limit in the range as less than the value of smallest limit number. For example, you should not enter 10.10.10.[8-4].

See Behavior of IP Address Range Based Device Groups in Multi-Server Setup for more information on the IP Address Range based device groups in a multi-server setup.

Examples


• Example to Create a Simple Group Rule

• Example to Create a Composite Group Rule

• Example to Create a Group Rule Using Range Operator

Example to Create a Simple Group Rule

To create a group of all devices ending with the hostname Test, you should:


OL-25947-01



a. Select Variable as HostName

b. Select Operator as endswith

c. Enter the Value as Test




Example to Create a Composite Group Rule

If you want to group all the devices in the network that match the following criteria:

• Device Name of the device should contain TestDevice

• Category of the device should be equal to Routers or IP Address of the device should starts with 10.77

To create this composite rule:


a. Select Variable as DisplayName

b. Select Operator as contains

c. Enter the Value as TestDevice



Step 3 Create another rule expression by entering:

a. Select AND as the Boolean operator

b. Select Variable as Category

c. Select Operator as equals

d. Enter the Value as Routers


The rule is appended into the Rule Text.

Step 5 Create another rule expression by entering:

a. Select OR as the Boolean operator

b. Select Variable as ManagementIPAddress/IP.Address

c. Select Operator as startswith

d. Enter the Value as 10.77


The following composite rule is formed in the Rule Text Area:

Device.DisplayName contains “TestDevice” ANDDevice.Category equals “Routers” ORDevice.ManagementIpAddress startswith “10.77”


OL-25947-01


Step 7 Edit the rule expression in the text area to adjust the priorities among the group expressions.

You should place two rule expressions together within an opening and a closing parentheses. Ensure that you leave a space between the parenthesis and the group expressions.

The edited composite rule is:

Device.DisplayName contains "TestDevice" AND( Device.Category equals "Routers" ORDevice.ManagementIpAddress startswith "10.77" )


Step 8 Click Next to proceed further.

Example to Create a Group Rule Using Range Operator

To group all devices whose IP Addresses are within the range 10.10.0.207 to 10.10.212.247, you should:


a. Select Variable as ManagementIPAddress/IP.Address

b. Select Operator as range

c. Enter the Value as 10.10.[0-212].[207-247]



You can also check the syntax of the group rule entered

System Defined Attributes

The following table provides details on some of the System Defined attributes that are available in LMS. These are predefined attributes, available by default.

Note In LMS 4.2, the attributes State (Device.State) and System.SystemOID (Device.System.SystemOID) are not available. If you backup and restore any group created in older versions of LMS using these attributes, the groups will not be restored.


OL-25947-01


Table 5-1 Group Attributes in LMS

Attribute Description Example

Asset.CLE_Identifier CLE identifier of the asset. To create a group of all devices having asset CLE identifier CLE12:

• Select the variable Asset.CLE_Identifier

• Select the operator equals.

• Enter the value CLE12.

Asset.Part_Number Orderable part number of the asset. To create a group of all devices having asset part number PN123:

• Select the variable Asset.Part_Number


• Enter the value PN123.

Asset.User_Defined_Identifier User-defined identifier of the asset To create a group of all devices having user defined asset identifier UD34:

• Select the variable Asset.User_Defined_Identifier.


• Enter the value UD34.

Category Category into which the device falls. The first level entries in the Device Type tree in DCR Device Management UI.

To create a group of all routers in the network.

• Select the variable Category.

• Select the operator contains.

• Enter the value router.

Chassis.Model_Name Name of the model. To create a group of all devices containig chassis model name WS-C6506:

• Select the variable Chassis.Model_Name


• Enter the value WS-C6506.

Chassis.Number_Of_Slots Number of slots in that chassis. To create a group of all devices containig 10 chassis slots.

• Select the variable Chassis.Number_Of_Slots

• Select the operator =.

• Enter the value 10.


OL-25947-01


Chassis.Port_Count Total port count of the chassis. To create a group of all devices having chassis port count more than 5.

• Select the variable Chassis.Port_Count.

• Select the operator >.


Chassis.Serial_Number Serial number of the chassis. To create a group of all devices containing chassis serial number SSI1.

• Select the variable Chassis.Serial_Number.


• Enter the value SSI1.

Chassis.Vendor_Type Vendor type of the chassis. To create a group of all devices containing chassis vendor type cevChassisN5k.

• Select the variable Chassis.Vendor_Type.


• Enter the value cevChassisN5k.

Chassis.Version Version number of the chassis. To create a group of all devices containing chassis version 0.102.

• Select the variable Chassis.Version.


• Enter the value 0.102.

DeviceName Device name, as you want it to be represented in reports or graphical displays. This can be derived from Host Name, Management IP Address or Device Identity.

To create a group of all devices having Device Name starting with 10.77.132.

• Select the variable DeviceName.

• Select the operator startswith

• Enter the value 10.77.132.

DomainName Domain name of the device. To create a group of all Cisco.com devices.

• Select the variable DomainName.


• Enter the value Cisco.com.




OL-25947-01


EnergyWise.Domain_Name Name of the EnergyWise domain. To create a group of all devices having EnergyWise Interfaces Information.

• Select the variable EnergyWise.Domain_Name.


• Enter the value Interfaces Information.

EnergyWise.EnergyWiseState EnergyWise status of the device, for example, EnergyWise-capable devices, EnergyWise-enabled devices, EnergyWise-hardware-incapable devices and EnergyWise-software-incapable devices.

To create a group of all EnergyWise-capable devices.

• Select the variable EnergyWise.EnergyWiseState.


• Enter the value EnergyWise-capable devices.

EnergyWise.Importance EnergyWise Importance of the device.

This value prioritizes the devices in a domain based on their power usage.

To create a group of all devices having EnergyWise importance 2.

• Select the variable EnergyWise.Importance.



EnergyWise.Keyword A word that will help you identify a specific device or group of devices in the EnergyWise domain.

To create a group of all devices having EnergyWise keyword switch.

• Select the variable EnergyWise.Keyword.


• Enter the value switch.

EnergyWise.Role Role or function of the device in the EnergyWise domain.

To create a group of all devices having EnergyWise role router.

• Select the variable EnergyWise.Role.


• Enter the value router.

Flash.File_Name Location of Flash file. To create a group of all devices having Flash file name /20-oct.cfg.

• Select the variable Flash.File_Name.


• Enter the value /20-oct.cfg.




OL-25947-01


Flash.File_Size Flash file size in MB. To create a group of all devices having Flash file size greater than 20 KB.

• Select the variable Flash.File_Size.



Flash.Model_Name Model name of the Flash device. To create a group of all devices having Flash model name starting with c3725-i.

• Select the variable Flash.Model_Name.

• Select the operator startswith.

• Enter the value c3725-i.

Flash.Partition_Free Free space in MB. To create a group of all devices having Flash free space greater than 50 MB.

• Select the variable Flash.Partition_Free.



Flash.Partition_Name Flash partition name. To create a group of all devices having Flash partition name flash:1.

• Select the variable Flash.Partition_Name.


• Enter the value flash:1.

Flash.Partition_Size Flash partition size in MB. To create a group of all devices having Flash partition size less than or equal to 20 MB.

• Select the variable Flash.Partition_Size.

• Select the operator <=.


Flash.Size Total Flash device size in MB. To create a group of all devices having Flash size greater than or equal to 50 MB.

• Select the variable Flash.Size.

• Select the operator >=.





OL-25947-01


HostName Device Host name. To create a group of all devices ending with the hostname 3750:

• Select the variable HostName

• Select the operator endswith.


Image.ROM_Sys_Version System ROM software version To create a group of all devices having system ROM software version 12.4(25):

• Select the variable Image.ROM_Sys_Version.


• Enter the value 12.4(25).

Image.ROM_Version Version of ROM. To create a group of all devices having ROM image version 12.2(8r)T2:

• Select the variable Image.ROM_Version.


• Enter the value 12.2(8r)T2.

Image.Sys_Description Image system description To create a group of all devices having ROM image version 12.2(8r)T2:

• Select the variable Image.Sys_Version.


• Enter the value 12.2(8r)T2.

Image.Version Running device image version. To create a group of all running devices having image version 12.4(25):

• Select the variable Image.Version.


• Enter the value 12.4(25).

ImageVersion Software version running on the device. To create a group of all devices having image version 12.2(52)SE:

• Select the variable ImageVersion.


• Enter the value 2.2(52)SE.

IP.Address Device IP address. To group all devices whose IP Addresses are within the range 10.10.0.0 to 10.10.50.255

• Select the variable IP.Address.

• Select the operator range.

• Enter the value 10.10.[0-50].[0-255].




OL-25947-01


IP.Address_Type Version of IP, IPv4 or IPv6 To group all IPv6 devices:

• Select the variable IP.Address_Type.


• Select IPv6.

IP.Network_Mask Network mask address To group all devices having network mask address starting with 255.255.255:

• Select the variable IP.Network_Mask.


• Enter the value 255.255.255.

IPv4.Subnet IPv4 subnet of a device. To create a group of all devices having subnet 32:

• Select the variable IPv4.Subnet.



IPv4.SubnetMask IPv4 subnet mask of a device. To create a group of all devices having subnetmask starts with 255.

• Select the variable IPv4.SubnetMask.



IPv6.Subnet IPv6 subnet of a device. To create a group of all devices having subnet 32

• Select the variable IPv6.Subnet.



IPv6.SubnetMask IPv6 subnet mask of a device. To create a group of all devices having subnetmask starts with 255.

• Select the variable IPv6.SubnetMask.



ManagementIpAddress IP Address used to access the device. Both IPv4 and IPv6 address types are supported.

To group all devices having Management IP address starting with 10.77.215:

• Select the variable ManagementIpAddress.


• Enter the value 10.77.215




OL-25947-01


MDFId Normative name for the device type as described in Cisco Meta Data Framework (MDF) database. Each device type has a unique normative name defined in MDF.

To create a group of all devices having MDF ID 323.

• Select the variable MDFID.



Memory.Free Free memory in MB. To create a group of all devices having free Memory greater than 83 MB.

• Select the variable Memory.Free.



Memory.Name Name of the memory. To create a group of all devices having Memory name starting with workspace:

• Select the variable Memory.Name.


• Enter the value workspace.

Memory.Size Total RAM size in MB. To create a group of all devices having Memory size greater than 512 MB.

• Select the variable Memory.Size



Memory.Type Memory type. To create a group of all devices having processorMemory.

• Select the variable Memory.Type


• Enter the value processorMemory.

Memory.Used Used memory in MB. To create a group of all devices having Memory used size less than 30 MB.

• Select the variable Memory.Used

• Select the operator <.


Model Model of the device. The third level entries in the Device Type tree in DCR Device Management UI.

For example, the model Cisco 3101 Router falls under the Cisco 3100 Series Routers, which comes under the category Routers.

To create a group of all Cisco 3101 Routers.

• Select the variable Model


• Enter the value Cisco 3101 Routers.




OL-25947-01


Module.HW_Version Module hardware version. To create a group of all devices having Module hardware version 3.x

• Select the variable Module.HW_Version.



Module.Model_Name Name of the model. To create a group of all devices having model name starting with NM-16.

• Select the variable Module.Model_Name.


• Enter the value NM-16.

Module.Port_Count Total ports on that module. To create a group of all devices having 16 port modules.

• Select the variable Module.Model_Count.



Module.Serail_Number Serial number of the module. To create a group of all devices having module serial number starting with FOC08.

• Select the variable Module.Serail_Number.


• Enter the value FOC08.

Module.Vendor_Type Vendor type of the module. To create a group of all devices having module vendor type starting with cevPwr.

• Select the variable Module.Vendor_Type.


• Enter the value cevPwr.

Processor.Model_Name Name of the model. To create a group of all devices having pentium processor.

• Select the variable Processor.Model_Name.


• Enter the value pentium.




OL-25947-01


Processor.NVRAM_Size Size of the processor NVRAM in MB. To create a group of all devices having NVRAM greater than 512 KB.

• Select the variable Processor.NVRAM_Size.



Processor.NVRAM_Used Size of the processor NVRAM that has been utilized, in MB.

To create a group of all devices with NVRAM used size greater than 23 KB.

• Select the variable Processor.NVRAM_Used.



Processor.Port_Count Total port count of the processor To create a group of all devices having 24 ports processor.

• Select the variable Processor.Port_Count.



Processor.RAM_Size Size of the processor RAM in MB. To create a group of all devices having processor RAM of 0f 128 MB.

• Select the variable Processor.RAM_Size.



Processor.Serial_Number Serial number of the processor. To create a group of all devices containing processor serial number JAE081.

• Select the variable Processor.Serial_Number.


• Enter the value JAE081.

Processor.Vendor_Type Vendor type of the processor. To create a group of all devices containing processor vendor type cevCpu37252fe.

• Select the variable Processor.Vendor_Type.


• Enter the value cevCpu37252fe.




OL-25947-01


Series Series to which the device belongs. The second level entries in the Device Type tree in DCR Device Management UI.

To create a group of Cisco 3100 Series Routers.

• Select the variable Series.


• Enter the value Cisco 3100 Series Routers.

System.ASP_Capability Groups devices according to their Auto Smartport capability

To create a group of all ASP_Enabled devices.

• Select the variable System.ASP_Capability.


• Select the value ASP_Enabled.

System.Contact Device contact person name. To create an User Defined group whose member devices have a common system contact person, J Smith

• Select the variable System.Contact.


• Enter the value J Smith.

System.Description Description of the system. To create a group of all devices having Cisco IOS software.

• Select the variable System.Description.


• Enter the value Cisco IOS software.

System.DomainName Device domain name. To create a group of all Cisco.com devices.

• Select the variable System.DomainName.


• Enter the value Cisco.com.

System.Identity_Capability Groups devices according to their Identity capability

To create a group of all Identity_Enabled devices.

• Select the variable System.Identity_Capability.


• Select the value Identity_Enabled.




OL-25947-01


The User-Defined Fields (UDFs) available in the variable drop-down list is taken from DCR. You can create UDFs at Admin > Network > Device Credential Settings > User Defined Fields. For details, see Adding User Defined Fields.

If you create a UDF that is similar to one of the predefined System Defined attributes, an _UDF suffix is appended to the User-Defined Field you add, to distinguish these two attributes.

For example if you create a UDF called DisplayName (which is one of the predefined attributes present in the Variable drop-down list), this will be displayed as DisplayName_UDF.

Note You should not create a UDFs in the format System Defined Field_UDF, where System Defined Field stands for any attribute listed in the above table.

System.Location Device location information. To create a System Defined Group whose member devices are located in Bldg 1 Devices

• Select the variable System.Location.


• Enter the value Bldg 1 Devices.

System.Name Name of the device as configured by the Administrator.

To create a group of all devices whose system name has NDX

• Select the variable System.Name.


• Enter the value NDX.

System.OSTYPE Type of the operating system. To create a group of all devices having UNIX OS.

• Select the variable System.OSTYPE.


• Enter the value UNIX.

System.Smart_Install_Directors Groups devices according to their Smart Install capability

To create a group of all Smart Install software incapable devices.

• Select the variable System.Smart_Install_Directors.


• Enter the value Smart Install_SW_Incapable.

SystemObjectID SysObjectID of the device as configured by the Administrator. It may be UNKNOWN in the case the facility that populates the repository does not know the value.

To group all devices whose systemObjectID starts with 1.3.6.1.4.1.9

• Select the variable SystemObjectID.


• Enter the value 1.3.6.1.4.1.9.




OL-25947-01


By default, four UDFs are available. You can create an additional six UDFs in DCR. The maximum number of UDFs that can be added in the Variable drop-down list is 10.

Assigning Group Membership

You can include more devices or exclude devices using this option. To decide the devices that will be available to the group you have created, the wizard uses the details of the parent members and rules you have already specified.

These devices appear in Available Objects From Parent Group column based on the properties and rules you have already specified in the Properties:Create and Rule:Create dialog boxes. See Specifying Group Properties and Defining Group Rules for more information.

Note You can add devices from the list of available objects in the parent group even if they do not match membership criteria.

To add devices to the group you have created:

Step 1 Select one or more devices in Available Objects From Parent Group column.


Step 2 Click Add.

The selected devices are removed from the Available Objects From Parent Group and added to the Object Matching Membership Criteria column.

Note The newly added devices will not be included in the jobs scheduled prior to their addition to the group. You must reschedule the job and select the group again.

To remove devices from the group:

Step 1 Select one or more devices in Object Matching Membership Criteria column.


Step 2 Click Remove.

The selected devices are removed from the Object Matching Membership Criteria column and added to Available Objects From Parent Group.

Step 3 Click Next.

The Summary:Create window appears. It displays the group name, the parent group, description, the membership update type, group rules, and the visibility scope of the group you created.

If you want to change the parameters, click Back to go back to the previous windows and make changes.

Step 4 Click Finish to create the group based on the parameters specified.


OL-25947-01


Viewing Group Details

You can view the details of a group using this feature.

To view the details of a group:

Step 1 Either:



Or



Step 2 Select a group from the Group Selector pane.

The Group Info pane on the right side displays the high-level properties of the selected group.

Step 3 Click Details.

The Group Administration wizard displays the details of the group in Properties:Details window.

• Click View Parent Rules to display the rules set for the parent group.

The rules set for the parent group are displayed in the Show Parent Rules window.

• Click Membership Details to display a list of devices and their corresponding object types.

The membership details are displayed in Membership:Details window.

In the Membership:Details window, you can:

– Click on the column headers to sort the entries in the table.

– Select the number of rows to be displayed in the table in the Rows per page option.

• Click Property Details to return to the Property:Details window.

Step 4 Click Cancel to return to the Group Administration and Configuration page.


OL-25947-01


Modifying Group Details

You can modify some of the details for a group using this feature.

To modify the details of a group:

Step 1 Either:



Or




The Group Info fields on the right side displays details of the selected group.

Step 3 Click Edit.

The Group Administration wizard guides you through the process of editing a group. It displays the details of the group in Properties:Edit window.

Step 4 Change the Group Name, Description, Membership Update, and Visibility Scope in the Properties:Edit dialog box.

You cannot change the Parent group or copy attributes from a different group in Edit mode.

Step 5 Click Next.

The wizard takes you to the Rules:Edit window.

Step 6 Change the rules as required. For details on creating the rules, see Defining a Group Rule.

Step 7 Click Next.

The wizard takes you to the Membership:Edit window.

Step 8 Add or remove devices from the list of objects in Objects Matching Membership Criteria as required. For details on creating the rules, see System Defined Attributes.

Step 9 Click Next.

The wizard takes you to the Summary window.

If you want to change the parameters specified, click Back to go back to the previous windows and make changes to the properties or rules.

Step 10 Click Finish to modify the group.

Step 11 Click OK.

The Group Administration wizard copies the attributes of the selected group and displays it in the corresponding fields in Properties:Create window.

Note that the Parent group you have selected for the group does not change even if you are copying attributes from a group that belongs to a different Parent group.


OL-25947-01


Refreshing Groups

You can recompute the membership of a group by re-evaluating the group rule. The membership of Automatic groups is recomputed dynamically.

The membership of Only-upon-user-request groups is recomputed only when explicitly refreshed with this option.

Note Only users with read-write access can refresh the Only-upon-user-request groups.

To refresh a group:

Step 1 Either:



Or




The Group Info fields on the right pane displays details of the selected group.

Step 3 Click Refresh.

The Group Administration popup window prompts you for confirmation.

Step 4 Click Yes.

The selected group is recomputed and the window, refreshed.

Whenever you delete devices from a group, refresh the group so that group membership is recomputed.

Deleting Groups

You can delete a group from the Group Selector. When you delete a group, all the child groups under the group are also deleted. You can also delete the stale groups (groups that belong to users removed from Cisco Prime).

To delete a group:

Step 1 Either:



Or



Step 2 Select the group from the Group Selector.


OL-25947-01

The Group Info fields on the right pane displays details of the selected group.

Step 3 Click Delete.

The Group Administration prompts you for confirmation.

Step 4 Click Yes.

The selected group is deleted.

See Deleting Stale Groups Using CLI for more information on how to delete stale groups using CLI.

Exporting Groups

This feature helps you to export a User-defined group hierarchy into a file.

You can export a selected User-defined group hierarchy or all User-defined groups in a LMS Server to an output file.

Private User-defined groups created by other users will not be exported. However, the privateUser-defined groups created by you will be exported.

You must have Network Administrator, System Administrator or Super Admin privileges to export groups.

In a Multi-server setup, you can export the User-defined groups installed in all LMS Servers of the same DCR domain. You can do this from a DCR Master Server and a Slave server.

Grouping Services supports exporting User-defined groups to an XML format only. CSV file formats are not supported.

See Sample Export Groups Output File for sample XML file generated by the Grouping Services export utility.

Note We recommend that you use the file generated by the Grouping Services export utility for import operations and do not edit the XML file.

You can:

• Exports Groups from the User Interface. See Exporting Groups From User Interfacefor details.

or

• Export Groups through the CLI. See Exporting Groups Through CLI for details.


• Sample Export Groups Output File

• Exporting Groups From User Interface

Sample Export Groups Output File

<?xml version="1.0" encoding="UTF-8"?><ogs-groups> <server name="LMS@server-name"> <ogs-group-definition> <name>/CS@server-name/User Defined Groups/CSDyna</name>


OL-25947-01


<description> </description> <rule/> <evaluation-type>2</evaluation-type> <scope>PUBLIC</scope> <tags> <tag tag-name="__VIRTUAL_ROOT" tag-value="LMS@server-name"/> <tag tag-name="USER_DEFINED" tag-value="TRUE"/> <tag tag-name="__GROUP_ID" tag-value="CS$216"/> <tag tag-name="__GROUP_OWNER" tag-value="admin"/> </tags> </ogs-group-definition> <ogs-group-definition> <name>/CS@server-name/User Defined Groups/CSStat</name> <description/> <rule>:CMF:DCR:Device.DisplayName contains "77"</rule> <evaluation-type>1</evaluation-type> <scope>PUBLIC</scope> <tags> <tag tag-name="__VIRTUAL_ROOT" tag-value="LMS@server-name"/> <tag tag-name="USER_DEFINED" tag-value="TRUE"/> <tag tag-name="__GROUP_OWNER" tag-value="admin"/> <tag tag-name="__GROUP_ID" tag-value="CS$221"/> </tags> </ogs-group-definition> </server></ogs-groups>

Exporting Groups From User Interface

To export device groups from the user interface:

Step 1 Select Admin > System > Group Management > Device.


Step 2 Select a User-defined Group hierarchy from the Group Selector.

Step 3 Click Export.

The Export Groups dialog box appears.

Step 4 Select either one of the following options:

• Export the selected User-defined Group hierarchy— Exports the selected User-defined Group and its child groups.

Or

• Export All Applications User-defined Groups —Exports all User-defined Groups from all applications installed on all LMS Server in the same DCR domain.

The browser-specific File Download window appears prompting you to open or save the output XML OGSExport.xml file.

Step 5 Click either of the following buttons:

• Open to open the XML file

Or

• Save to store the file on the client system with the same or a different filename.


OL-25947-01


Importing Groups

This feature helps you to import User-defined group hierarchies from an input XML file to the LMS Server.

Note You cannot import User-defined groups from older versions of LMS to LMS 4.0 and later versions.

You can import User-defined groups from an input file to the LMS Server.

The private User-defined groups in the input XML file will be imported as your private User-defined groups in LMS Server. They will not be visible to other users.

You must have Network Administrator, System Administrator or Super Admin privileges to import groups.

In a Multi-server setup, you can import User-defined groups from a DCR Master Server and a Slave server.

Note We recommend that you use the file generated by the Grouping Services export utility for import operations and do not edit the XML file.

You can:

• Importing Groups From User Interface

Or

• Importing Groups Through CLI


• Important Notes on Importing Groups

• Importing Groups From User Interface

Important Notes on Importing Groups

Read the following notes before importing User-defined groups:

• You must have the required file permissions to select a source XML file for import groups operation.

• After importing groups, the group selector may take some time to refresh and display the latest groups information.

You must launch the Groups Administration page again to view the newly imported groups.

To launch the Groups Administration page, select Admin > System > Group Management > Device.

• Importing groups from an input XML file fails if:

– The groups to be imported to the selected Grouping Server locations already exist.

– The User-Defined Fields (UDF) that are configured for the import group rules are not available in the Grouping Servers to which the groups are to be imported.

Importing Groups From User Interface

To import device groups from the user interface:


OL-25947-01


Step 1 Either:



Or



Step 2 Click Import.

The Import Groups - File Selection dialog box appears.

Step 3 Enter an input XML file name in the File Name field or click Browse to select a file from the client system.

The Import Groups dialog box appears with a list of import groups specified in the input XML file.

Step 4 Select the list of groups to be imported from the Import Groups From field.

Step 5 Select a server location to which the groups are to be imported in the Import Groups to Servers field.

You can select multiple Grouping Server locations or All to select all the Grouping Server locations.

This field is disabled on LMS Servers operating in the DCR Standalone mode.

Step 6 Click OK.

A message appears indicating if the groups were imported or not.

See Important Notes on Importing Groupsfor the possible causes of the import job failure.

See Using Group Administration Features Through CLI for more information on using group administration feature using CLI.

Overview of Subnet Based Groups

Subnet based groups are automatically created when devices are managed. These are a part of System defined groups. You cannot create, edit or delete them.

Subnet based groups help you work on smaller subsets of devices that are logically grouped. They are automatically deleted when all the devices in a subnet are deleted.

This topic covers:

• Accessing Subnet Based Groups

• Understanding Subnet Based Groups

• Creating Groups Based on Subnet

Accessing Subnet Based Groups

To access Subnet based groups:



Or


OL-25947-01

Chapter 5 Managing Groups DCR Mode Changes and Group Behavior



This displays the Group Management page. The Group Selector field displays two groups, System-defined Groups and User Defined Groups. The Subnet Based Groups are created under System Defined Groups.

Understanding Subnet Based Groups

The Subnet based groups use the following name format:

Subnet -- Subnet Mask.

The rule expression for Subnet Based Groups has the following components:

Class.attribute operator "value"

For example,

Device.IP.Subnet equals "172.20.104.192" AND Device.IP.SubnetMask equals "255.255.255.240"

The rule above will select all devices of subnet 172.20.104.192 and subnet mask 255.255.255.240.

Creating Groups Based on Subnet

When you need to create subnet based groups, you can do it under User defined groups.

For example, the following rules might be used to create two groups based on the IP address subnet:

Device.IP.Subnet equals "172.29.252.32"Device.IP.Subnet equals "172.29.252.64"

The examples provided here are simple. However, the Grouping Service allows complex rules to be arbitrarily formed by combining rule expressions with AND, OR or the EXCLUDE operators. This gives the administrator the power and flexibility to create view partitions tailored to the needs of their site.

DCR Mode Changes and Group BehaviorThe DCR modes have a bearing on how groups are displayed in the Groups UI. Also the DCR mode decides whether you can perform any operation on the groups.

In Standalone mode, you can create system-defined and user-defined groups.

In Slave mode, LMS allows you to preserve the user-defined groups, and create new system-defined device groups.

The port and module groups, Fault groups and Collector groups are not affected by the change in the DCR mode.

All DCR devices in the Slave are removed, and synchronized with the Master server. Therefore, in a cluster that has several Slaves and a Master, if you need to create LMS group, you need to go to the LMS Groups UI in the Master and create the group. The group you create there, will be synchronized with the Slaves.


OL-25947-01

Chapter 5 Managing Groups DCR Mode Changes and Group Behavior

The following table gives details of DCR mode changes and implications on Groups.

Unregistering a Slave

The Unregister Slave utility helps you unregister a Slave that is no longer a part of the domain.

The utility is useful in the following scenarios:

• Change in Slave mode because of Backup and Restore. That is, if data is restored from Standalone or Master belonging to a different domain.

• When you uninstall Cisco Prime from the Slave.

• Change in Slave mode, when master is not reachable. If the Master is down when the Slave mode changes, the Master will not be aware of the Slave mode change, when it comes up.

The Master will not receive any data from the Slave, but the Slave information will still be in its registry. A redundant group (such as LMS@Slave) will still appear in the Master Groups UI.

Mode Changed to:

The Initial Mode

Standalone Slave Master

Standalone Not applicable. Slave will get Master’s groups, both system-defined and user-defined groups.

You can also create new user-defined groups in the Slave. These groups will not be shared with the Master or other slaves in the domain.

Device Allocation Policy gets disabled (Inventory > Device Administration > Device Allocation Policy).

No change in the Group hierarchy.

Slave Device Allocation Policy gets enabled. The groups pertaining to Master and Slaves will be removed.

The existing Device Allocation Policy is retained.

Not applicable. Device Allocation Policy gets enabled. Groups pertaining to the previous Master and the associated Slaves will be removed.

Local groups will behave in the same manner.

The existing Device Allocation Policy is retained.

Master All dependent Slaves will switch to Standalone mode.

All groups pertaining to other machines will be removed. Device Allocation Policy will be enabled on all machines in the cluster.

If you select Inform current Slaves of new Master Hostname when you change the mode to Slave, all the Slaves in the domain, switch to the new Master.

In this case, the groups in the Master will be seen in the new Slave. Device Allocation Policy gets disabled.

If this check box is not selected, the new Slave will pickup the groups of the new Master. Other Slaves in the domain will move to Standalone mode.

Not applicable.


OL-25947-01

Chapter 5 Managing Groups Port and Module Group Administration

In the case of DCR, any device operation on Master will update the Slave list. However, this does not happen in the case of Groups.

You can run the UnregisterSlave utility to remove any unwanted slave information:

From the CLI, run:

NMSROOT/bin/perl NMSROOT/bin/UnregisterSlave.pl slave host name

You have to enter the hostname of the machine you want to unregister.

For information on effects of backup-restore on data, DCR modes, and Groups, see Effects of Backup-Restore on DCR and Effects of Backup-Restore on Groups.

Behavior of IP Address Range Based Device Groups in Multi-Server Setup

The range operator allows you to group devices within a specified range of IP addresses.

In a Master-Slave setup:

• When the Master server is using an earlier version of LMS, you cannot create device groups based on IP Address range.

• When the Slave server is using an earlier version of LMS, the IP Address Range based device groups information in the Master is synchronized with the Slave.

Even if you change the mode of Slave server to Standalone, the IP address range based device groups will remain as they were in the Groups Server.

However, you cannot retrieve the device group information from the Standalone LMS Server to view it in the user interface. To retrieve and view the device group information, you should either:

– Upgrade the LMS in Standalone LMS Server to LMS 4.2.

Or

– Change the mode of the LMS Server that has the earlier version of LMS 4.2 from Standalone to Slave for a DCR Master with the latest version of the software.

Port and Module Group AdministrationLMS allows you to create groups based on ports and modules for a selected set of devices or device groups using Port and Module Group Administration.

Notes for Port and Module Configuration

1. Port and Module configuration depends on the data collected by LMS Inventory. For the Port and Module configuration to work properly, the inventory collection for the devices must be successful.

2. You must trigger a fresh inventory collection to update all the port and module attributes.

3. If the data collection is not successful, then data will not be available for some attributes.

4. The following are the recommended number of ports in LMS:

1. The maximum number of ports supported in LMS is 500,000 ports.

2. The maximum number of ports supported in a port group is 100,000 ports.

3. The maximum number of ports supported in an LMS job is 250,000 ports.


OL-25947-01


4. In some devices, duplicate entries are returned for the ifName MIB. In such cases, only one entry for the ifName will be considered and the duplicate entries will be dropped.

5. The port information is fetched from the ifXtension MIB. If the ifXtension MIB is not supported in the device, then port configuration for the device will not work.

For example, if a device supports only SNMPv1, then ifXtension MIB will not be supported in the device. In this case, the port configuration for the device will not work.

The LMS Port and Module Group Browser window contains these fields. (See Table 5-2)

You can perform the following tasks from the LMS Port and Module Group Browser window:

• Creating Port and Module Groups

• Editing Port and Module Groups

Table 5-2 Fields on Port and Module Group Browser

Field/Button Description

Group Name Name of the group created.

By default, the following System-defined groups are displayed:

• 1 Gbps Ethernet Ports—Contains all 1 Gbps Ethernet ports in the network.

• 10 Gbps Ethernet Ports—Contains all 10 Gbps Ethernet ports in the network.

• 10 Mbps Ethernet Ports—Contains all 10 Mbps Ethernet ports in the network.

• 100 Mbps Ethernet Ports—Contains all 100 Mbps Ethernet ports in the network.

• Access Ports—Contains all the Access mode ports.

• DMP Ports—Contains all ports connected to DMP.

• End Hosts—Contains all ports connected to End Hosts.

• IP Phones—Contains all ports connected to IP Phones.

• IPVSC Ports—Contains all ports connected to IPVSC.

• Link Ports—Contains all ports connected to other devices.

Description Description of the group created.

Group Type Type of the group created. For example, Port or Module.

Created By User who created the group.

Last Modification Time.

Time at which the group settings were last modified.

Rows per page This page displays the number of rows you have set for display in the Rows per page field.

You can increase the rows to 500 for each page by selecting the Rows per Page drop-down list. You can navigate through the pages of the report using the navigation icons at the bottom right of this table.

Create Starts the Group Creation Wizard for creating a group, as described in the Creating Port and Module Groups.

Edit Starts the Group Edit Wizard for editing an existing group, as described in the Editing Port and Module Groups.

View Allows you to view the group details, as described in the Viewing Port and Module Group Details.

Delete Deletes the group, as described in the Deleting Port and Module Groups.


OL-25947-01


• Viewing Port and Module Group Details

• Deleting Port and Module Groups

Creating Port and Module Groups

Creating a Port and Module Group involves the following steps:

1. Entering the Port and Module Group Properties Details

2. Selecting Group Source

3. Defining Rule Expression for Port or Module Groups

4. Understanding the Summary

You must complete all tasks in this sequence to create a group. If you exit the wizard at any stage using Cancel, the details you have specified will be lost and the group will not be created.

Note Port and Module configuration depends on the data collected by the LMS Inventory. For the Port and Module configuration to work properly, the inventory collection for the devices must be successful.

Entering the Port and Module Group Properties Details

In this step, you will enter the name and description for the group.

The Port and Module Group Properties dialog box contains the following fields. (See Table 5-3)

To enter the values in Port and Module Group Properties dialog box:

Step 1 Either:

• Select Admin > System > Group Management > Port and Module.

The Port and Module Group Browser page appears, displaying the list of groups. (See Table 5-2).

Or

• Select Inventory > Group Management > Port and Module.


Step 2 Click Create.

The Group Properties page appears.

Step 3 Enter a unique name for the group in the Group Name field.

Step 4 Enter a description for the group in the Description field (optional).

Step 5 Click Next.

Table 5-3 Fields on the Port and Module Group Properties dialog box

Field Description

Group Name Name of the group you are creating.

Description Text description of the group.


OL-25947-01


The Select Group Source page appears, displaying the Device Selection dialog box.

Selecting Group Source

In this step, you need to select the Group source. This can be either devices or groups (System-defined or User-defined).

The Select Group Source page displays the Device Selection and Group Selection dialog box. The Device Selection and Group Selection dialog box contains the following fields. (See Table 5-4)

You must select either devices or device groups from Device Selector or Group Selector, respectively.

To select the group source:

Step 1 Either:

• Select Device Selector.

• Select the devices.

or

• Select Group Selector.

Table 5-4 Fields on the Device Selection dialog box

Fields Description

Device Selector Displays all LMS devices in the group.

Search Input Enter the search expression in this field.

You can enter single device names or multiple device names. If you are entering multiple device names, separate them with a comma. You can also enter the wildcard characters “*” and "?".

For example: 192.168.10.1*, 192.168.20.*

Search Use this icon to perform a simple search of devices based on the search criteria you have specified in the Search Input text field.

For information on Search, see Performing Simple Search.

Advanced Search Use this icon to perform an advanced search of devices based on the search criteria you have specified in the Search Input text field.

For information on Advanced Search, see Performing Advanced Search.

All Lists all User-defined and System-defined groups for all applications that are installed on LMS Server.

For more information, see Selecting Devices From All Tab.

Search Results Displays all the search results from Search or Advanced Search.

For more information, see Selecting Devices From Search Results.

Selection Lists all the devices that you have selected in the Search Results or All tab.

Using this tab, you can deselect devices from the list.

Group Selector Displays all groups in LMS.


OL-25947-01


• Select the groups.

Step 2 Click Next.

The Rule Express page appears.

Defining Rule Expression for Port or Module Groups

In this step, you will define the rules for creating port or module groups. The rules you define in this phase, determine the contents of the group. The rules you specify here, determine the ports and modules to be included in the group.

You can either enter the rules directly in the Rule Text field, or select the components of the rule from the Rule Expression fields, and form a rule.

The Rules Expression page contains the following fields:

Field/Buttons Description

Object Type Select the following object types to form a group:

• Module

• Port

Variable Object type attributes, based on which you can define the group.

See Rule Attributes for Port and Module Creation.

Operator Operator to be used in the rule. The list of possible operators change, based on the variable selected.

When using the equals operator the rule is case-sensitive.

Value Value of the rule expression. The possible values depend upon the variable and operator that you select. Depending on the operator selected, the value may be free-form text or a list of values.

Wildcard characters are not supported.

Add Rule Expression

(Button)

Adds the rule expression to the group rules.

Rule Text Displays the rule.

Check Syntax

(Button)

Verifies that the rule syntax is correct.

Use this button to verify the syntax of the rule that you have created before proceeding to the next step.


OL-25947-01


To define the group rule:

Step 1 Go to the Rules Expression page.

Step 2 Set the parameters for Object Type, Variable and Operator.

Step 3 Enter the desired value for the Variable you have selected.


The LMS Port and Module Group Administration creates the rule based on the parameters you have specified and adds it to the rules already present in the Rules Text field. You can use the same procedure to add more rules.

You can manually add or change any text in the Rule Text box.

Step 5 Click Include or Exclude.

• Include—A popup window appears, allowing you to include ports or modules for the group. See Table 5-5 for the descriptions of the fields in the Include List window.

• Exclude—A popup window appears, allowing you to exclude ports or modules for the group. See Table 5-5 for the descriptions of the fields in the Exclude List window.

Step 6 Click Check Syntax to validate the rules expression syntax.

• If the syntax is correct, an information box appears with a message, The rule syntax is valid.

• If the syntax is incorrect, an error box appears with a message, You have entered an invalid rule. Enter a valid rule. See the Help for examples of valid rules.

For examples on defining valid rules, see Examples for Port and Module Groups.

Step 7 Click Next.

The Summary page appears, displaying the group properties. See Understanding the Summary.

Include

(Button)

Include List popup opens and lists all the modules or ports from the selected devices that do not match the rule. You can choose to include those modules or ports for group creation.

The Include List popup will also list the modules or ports that match the rule but will not be enabled for selection.

Click Include to launch the Include List window. See Table 5-5 for descriptions of the fields in the Include List window.

You can also include modules or ports for the selected devices, without specifying a rule, by clicking Include.

Exclude

(Button)

Exclude List popup opens and lists all the modules or ports from the selected devices that match the rule. You can choose to exclude those modules or ports for group creation.

The Exclude List popup will also list the modules or ports that do not match the rule but will not be enabled for selection.

Click Exclude to launch the Exclude List window. See Table 5-5 for descriptions of the fields in the Exclude List window.



OL-25947-01


Note You can also include modules or ports for the selected devices, without specifying a rule, by clicking Include. If you include the ports or modules for the selected devices, and also exclude the same ports or modules, the exclude option will have a higher priority.

Rule Attributes for Port and Module Creation

The following table lists the available attributes that you can use to define rules to create port and module groups.

Object Type Attribute Description

Module AdminStatus Administrative status of the module. For example, Enabled/Commissioned.

FW_Version Firmware version of the module. For example, 12.1(27b)E1

ModuleName Name of the module. For example, Linecard

OperStatus Operational status of the module. For example, Dormant

SlotNumber Slot number of the module. For example, 6

SW_Version Software version of the module. For example, 12.1(27b)E1

VendorType Vendor type of the module. For example, cevAS53004ct1


OL-25947-01


Port AdminStatus Administrative status of the port. For example, Disabled/Decommissioned

CM.AccessStatus Whether the port is an Access port or not.

CM.Channel Whether the port is a channel port.

CM.Duplex The duplex mode of the port. The values could be unknown-duplex, full-duplex, half-duplex, default, disagree, auto-duplex.

CM.JumboFrameEnabled Whether the port is JumboFrame enabled or disabled.

CM.L2L3 Whether the port is in switched or routed mode.

CM.LinkStatus Link status of the port. Whether the link is up or down.

CM.Neighbor Whether the port is connected to a device, IP Phone, or End Host.

CM.TrunkStatus Whether the port is a Trunk port. If trunk is configured in the port, then it is a trunk port.

CM.VLAN_ID The index of the VLAN configured on the port.

CM.VLAN_NAME Name of the VLAN configured on the port.

CM.VTP_DOMAIN Name of the VTP Domain that the port is associated with.

EnergyWise_Importance EnergyWise Importance of the device.

This value prioritizes the devices in a domain based on their power usage.

EnergyWise_Role Role or function of the device in the EnergyWise domain.

EnergyWise_Keyword A word that will help you identify a specific device or group of devices in the EnergyWise domain.

FlexLink Whether the FlexLink status of the port is enabled or disabled.

IFIndex IFIndex of the port. For example, 10

IsEnergyWisePort Specifies if the port is EnergyWise-enabled.



OL-25947-01


Note For the port attributes that start with name “CM.” , the data collection for the attributes must be successful.

Examples for Port and Module Groups

This section shows examples of a valid rule.

The following are some examples for grouping tasks:

• Rule to select all the Ports whose Port Description contains the string: Ethernet

• Rule to select all the Ports that are connected to another device

• Rule to select all the Modules whose Slot number is 1

• Rule with OR Operator

• Rule with AND Operator

Rule to select all the Ports whose Port Description contains the string: Ethernet

This rule filters all ports whose Port description consists of the string Ethernet.

To provide rule expression for this scenario:

From the Create Rules dialog box:

Step 1 Select Port from the Object Type drop down listbox

Step 2 Select PortDescription from the Variable drop down listbox

Port (contd.)

Identity_Security_Mode Specifies the security mode, based on the level of security you wish to implement in your network. The three types of security modes are:

• Monitor Mode

• Low Impact Mode

• High Security Mode

MACsecStatus You can enable or disable MACsec on the interface. MACsec provides secure, encrypted communication on wired LANs.

OperStatus Operational Status of the port. For example, Stopped/Suspended

PortDescription Description of the port. For example, FastEthernet0/1

PortName Name of the port. For example, Fa0/1

SpanEnabled Whether the port is Span enabled.

Speed Speed of the port. For example, 10000000 (for 10 Mbps)

Type Enter the value for the port type.

For example, if you want to define a rule for the port type ethernetCsmacd, you need to enter 6 as the value.

For information on the port type values, see

http://tools.cisco.com/Support/SNMP/do/BrowseOID.do?objectInput=iftype&translate=Translate&submitValue=SUBMIT&submitClicked=true



OL-25947-01

http://tools.cisco.com/Support/SNMP/do/BrowseOID.do?objectInput=iftype&translate=Translate&submitValue=SUBMIT&submitClicked=true


Step 3 Select contains from the Operator drop down listbox

Step 4 Enter Ethernet in the Value textbox

Step 5 Click Add Rule Expression

The following rule gets added to the Rule Text:

Port.PortDescription contains "Ethernet"

Rule to select all the Ports that are connected to another device

This rule filters all Ports that are connected to another device.



Step 1 Select Port from the Object Type drop down listbox

Step 2 Select CM.LinkStatus from the Variable drop down listbox

Step 3 Select = from the Operator drop down listbox

Step 4 Select Configured in the Value drop down list box.



Port.CM.LinkStatus = "Configured"

Rule to select all the Modules whose Slot number is 1

This rule filters all the modules that are placed in slot number 1.



Step 1 Select Module from the Object Type drop down listbox

Step 2 Select SlotNumber from the Variable drop down listbox

Step 3 Select = from the Operator drop down listbox

Step 4 Enter 1 in the Value textbox



Module.SlotNumber = "1"

Rule with OR Operator

Rule to list all ports whose Port description contains the string as either Ethernet or FastEthernet.



OL-25947-01


Step 1 From the Create Rules dialog box:

a. Select Port from the Object Type drop down listbox

b. Select PortDescription from the Variable drop down listbox

c. Select StartsWith from the Operator drop down listbox

d. Enter Ethernet from the Value drop down listbox

e. Click Add Rule Expression


Port.PortDescription StartsWith "Ethernet"

Step 2 Select the OR option from the logical operator list box.


a. Select Port from the Object Type drop down listbox



d. Enter FastEthernet in the Value textbox


The following rule gets appended to the Rule Text:

Port.PortDescription StartsWith "Ethernet" OR

Port.PortDescription StartsWith "FastEthernet"

The OR logical operator evaluates if either or both of the conditions are satisfied. The ports are selected based on either or both of the matching criteria.

Rule with AND Operator

Rule to select all the FastEthernet Ports whose Operational status is up.



a. Select Ports from the Object Type drop down listbox

b. Select OperStatus from the Variable drop down listbox

c. Select = from the Operator drop down listbox

d. Select OK from the Value drop down listbox



Port.OperStatus = "OK"

Step 2 Select the AND option from the logical operator list box.


a. Select Ports from the Object Type drop down listbox




OL-25947-01


d. Enter FastEthernet in the Value textbox


The following rule gets appended to the Rule Text:

Port.OperStatus = "OK" AND

Port.PortDescription StartsWith "FastEthernet"

The AND logical operator evaluates if both the parameters are satisfied. Only devices that satisfy both the criteria are selected.

Include and Exclude

Table 5-5 describes the Include and Excludes window fields in the Rule Expression page of Port and Module Group Administration.

Table 5-5 Include and Exclude Window Fields Description

Window Fields/Buttons Description

Include List Device Selector Devices selected for group creation.

Port Name/Module Name Name of the port or module in the device.

For some of the devices, if ports or module names are not available in the device, the message Not Available will be shown.

Description/Vendor Type Description of the port or module.

For some of the devices, if ports description or module vendor type is not available in the device, the message Not Available will be shown.

Slot Number Slot number of the module.

This field is available only for modules.

Include

(Button)

The selected ports or modules are included for group creation.

Filter by Port/Module Name

Enter the filter expression and click Filter to filter the port or modules in the device.


OL-25947-01


Understanding the Summary

The final step in creating the port or module group is a summary page that displays the new group definition.

The Summary page contains the following information. (See Table 5-6):

After reviewing the group summary, either:

Step 1 Click Finish to complete the procedure for Creating Groups.

A confirmation box appears.

Step 2 Click OK.

You can view the newly created group in the Port and Module Group Browser page.

Or

Click Back to change the group properties.

Exclude List Device Selector Devices selected for group creation.

Port Name/Module Name Name of the port or module in the device.

For some of the devices, if ports or module names are not available in the device, the message Not Available will be shown.

Description/Vendor Type Description of the port or module.

For some of the devices, if ports description or module vendor type is not available in the device, the message Not Available will be shown.

Slot Number Slot number of the module.

This field is available only for modules.

Exclude

(Button)

The selected ports or modules are excluded from group creation.

Filter by Port/Module Name

Enter the filter expression and click Filter to filter the port or modules in the device.

Table 5-5 Include and Exclude Window Fields Description

Window Fields/Buttons Description

Table 5-6 Fields on the Summary page.

Field Description



Rule Rules used to filter the group.

Devices/Groups in Rule List of devices or groups to which the rule will be applied.


OL-25947-01


Viewing Port and Module Group Details

To view the existing port or module group details:

Step 1 Either:



Or



Step 2 Select the group name and click View.

The View Group Details page appears, displaying Group: Details dialog box with the following details:

Viewing Membership Details

You can view a list of the objects that belong to a group by accessing the Group: Details dialog box.

Step 1 Either:



Or




Group Name Name of the group you are viewing.

Parent Group Parent group of the group you are viewing.

Type Type of the objects that belong to the group.


Rule Rules used to create the group.

Created By User who created the group. This also displays the time at which the group was created.

Last Modified By User who last modified the group. This also displays the time at which the group was last modified.

Devices/Groups Devices or Device Groups that are part of the port or module group.

Membership Details

(Button)

Used to view the list of devices that belong to the group. See Viewing Membership Details.

Cancel

(Button)

Closes the page and takes you back to the Port and Module Group Browser page.


OL-25947-01


Step 2 Select the group name for which you want to view the membership details and click View.

The Group: Details dialog box appears.

Step 3 Click Membership Details.

The View Group Members dialog box appears with the following information:

Editing Port and Module Groups

You can edit all attributes that are defined while creating a group, except Group Name.

To edit a port and module group:

Step 1 Either:



Or



Step 2 Select the group by checking the check box.

Step 3 Click Edit.

The Group Properties page appears, displaying Port and Module Group Properties dialog box. See Entering the Port and Module Group Properties Details.

You cannot:

• Modify the Group Name field.

• Click Finish to complete the edit flow.


Device Selector Devices selected for group creation.

Port Name/Module Name Name of the port or module in the device that are part of the group.

Description Description of the ports or modules in the device that are part of the group.

Filter by Port/Module Name Enter the filter expression and click Filter to filter the port or modules in the device that are part of the group.

Close

(Button)

To close the View Group Members dialog box.


OL-25947-01


Step 4 Click Next.

The Select Group Source page appears, displaying either Device Selector or Group Selector dialog box.

• Device Selection

– If you have selected devices using Device Selector in the Create flow.

– If you have created the group by including the ports or modules without specifying the rule in the Create flow. In this case, only the devices for which you selected ports or modules are displayed.

Or

• Group Selection—If you have selected device groups using Group Selector in the Create flow.

You can modify the devices or groups that you have selected, based on your requirement.

Step 5 Click Next.

The Rules Expression page appears, displaying the rule previously set. See Defining Rule Expression for Port or Module Groups.

You can modify and define new rules.

If you include the ports or modules for the selected devices, and also exclude the same ports or modules, the exclude option will have the higher priority.

Step 6 Click Next.

The Summary page appears, displaying the group details. Understanding the Summary.

Step 7 Either:

Click Finish to complete the editing procedure for the group.

Or

Click Back to change the group properties.

Note You can click Finish at any point in the workflow.

Deleting Port and Module Groups

To remove an existing port or module group:

Step 1 Select Admin > System > Group Management > Port and Module.

The Port and Module Group Browser page appears, displaying the list of groups.

Step 2 Select the group to remove from the Port and Module Group Browser dialog box.


A confirmation dialog box shows that the group will be deleted.

Step 4 Click OK.


OL-25947-01

Chapter 5 Managing Groups Working with Fault System-defined Groups

Working with Fault System-defined GroupsThe group selector displays some groups such as Access Port Groups, Trunk Port Groups, and Interface Port Groups. See Fault System Defined Groups for more information.

You can control the polling and thresholds settings for these groups using Monitor > Threshold Settings > Fault. See Monitoring and Troubleshooting Online Help for more information.

These system defined groups can be used when searching for devices using the Advanced Search option in the device selector.


• LMS System-defined Groups

• Fault System Defined Groups

LMS System-defined Groups

The LMS system defined groups are visible to all Cisco Prime users, and are the factory default groups administered by LMS. Device Groups appear in the group selector when they have device members, that is, devices in the DCR that belong to that group.

The following are the LMS system defined groups:

• Broadband Cable

• Content Networking

• DSL and LRE

• Interfaces and Modules

• Network Management

• Non Cisco Devices

• Optical

• Routers

• Security and VPN

• Server Fabric Switches

• Storage Networking

• Switches and Hubs

• Server Fabric Switches

• Universal Gateways and Access Servers

• Unknown Device Types

• Voice and Telephony

• Wireless


OL-25947-01

Chapter 5 Managing Groups Working with Fault System-defined Groups

Fault System Defined Groups

The fault system defined groups are visible to all Cisco Prime users, and are the factory default groups that are administered by the Fault Management module in LMS 4.0.

The following are the Fault Management system defined groups:

• System defined access port groups:

– 1 GB Ethernet

– 10 GB Ethernet

– 10MB-100MB Ethernet

– ATM

– Others

• System defined interface groups:

– 1 GB Ethernet

– 10 GB Ethernet


– ATM

– Backup

– Dial-on-Demand

– FDDI

– ISDN B channel

– ISDN D channel

– ISDN physical interface

– Others

– Serial

– Token Ring

• System defined trunk port groups:

– 1 GB Ethernet

– 10 GB Ethernet


– ATM

– Others

A 10 GB Ethernet interface device, during an upgrade, behaves in the following ways:

• If the 10MB - 100MB group has been set to high priority when compared to 1 GB Ethernet group, then the 10GB device falls under the 10MB - 100MB group. In order to make it fall under 10 GB Ethernet Group, you must set the priority of the group to high.

• If the 10MB - 100MB group has been set to low priority when compared to 1 GB Ethernet group, then the 10GB device falls under 10 GB group.

For more information, see Setting Priorities in Monitoring and Troubleshooting Online Help.


OL-25947-01

Chapter 5 Managing Groups Working with Customizable Groups

Working with Customizable GroupsCustomizable groups are the only user-defined groups for which you can set polling and threshold parameters. They are provided so you can create groups that fit your needs. Fault Management in LMS 4.0 provides 28 customizable groups, which are divided into four categories:

• Access Port Groups

• Trunk Port Groups

• Interface Groups

• Device Groups

Table 5-7 lists the seven customizable groups that appear in each of the four categories.

You configure a customizable group to have the highest priority. To do so, see Setting Priorities section in Monitoring and Troubleshooting Online Help. You must add devices to the customizable groups before you can set polling parameters or threshold values for them. To do so, see Working with Customizable Groups.

Since you cannot change the rules for system defined groups, Fault Management provides groups that you can customize so that they contain devices, ports, or interfaces.

Port and interface containment is only seen and used by Polling and Thresholds (Monitor > Threshold Settings > Fault).

After you edit or create a group, you can determine whether other Cisco Prime users can view the group.

Table 5-7 Polling and Thresholds: Customizable Groups

Customizable Groups Intended Use

A

B

C

Consider reserving customizable groups A, B, and C to troubleshoot

Add one device to any of these groups when you need to test. For example, to test a changed threshold or interval value for a polling setting.

1

2

3

4

Consider using customizable groups 1, 2, 3, and 4 when you want to override polling settings and thresholds for more than one device.

Table 5-8 Fault Management Customizable Groups

Group NameUse this group to monitor...

Settings you can configure for this group:

Customizable Access Port Groups

Access ports Thresholds

Customizable Groups Devices Polling and thresholds

Customizable Interface Groups Interfaces Thresholds

Customizable Trunk Ports Groups

Trunk ports Thresholds


OL-25947-01

Chapter 5 Managing Groups Managing Fault Groups

For each of the parent groups listed in Table 5-8, Fault Management provides seven configurable subgroups. Table 5-9 describes the restrictions placed on the subgroups.

Managing Fault GroupsThe Fault Group Administration and Configuration page is where all group management activities take place.

To open the Group Administration and Configuration page:

Either:

Select Admin > System > Group Management > Fault.

Or

Select Inventory > Group Management > Fault.

Note If you are connecting to the LMS server for the first time, a Security Alert window is displayed when you select an option. Do not proceed without viewing and installing the self-signed security certificate.

See Editing and Creating Fault Groups for information on how to use Group Administration to create and edit groups. In addition to creating and editing groups, Group Management provides the following functions:

• Refreshing Fault Membership

• Deleting Fault Groups

Table 5-9 Fault Management Customizable Groups—Restrictions

Group Name Restrictions

Customizable Group A • Use to troubleshoot a single device (but can contain more than one device)

• Cannot be deleted

• Cannot have subgroups

• Cannot have name changed

Customizable Group B

Customizable Group C

Customizable Group 1 • Can contain multiple devices

• Cannot be deleted

• Cannot have subgroups

• Cannot have name changed

Customizable Group 2




OL-25947-01


Table 5-10 describes the fields in the Group Administration and Configuration page.

Editing and Creating Fault Groups

The processes for editing and creating groups are similar. Keep these points in mind:

• You can edit user defined customizable subgroups. For example, the subgroup Customizable Group 1 under Customizable Access Port Groups. These subgroups are listed in Working with Customizable Groups.

• You can create or edit user defined miscellaneous groups. These groups can be used with views in the Alerts and Activities display, or with notification groups in Notification Services.

You cannot edit or view groups created from the Alerts and Activities Defaults page.

This section contains information on:

• Editing a Fault Group

• Creating a Fault Group

• Understanding Rules

• Finalizing Fault Group Membership

• Viewing the Fault Group Summary

Table 5-10 Fields on Group Administration and Configuration Page


Group Selector Hierarchical display of all available groups.

Group Info When you select an item from the Group Selector, the Group Info pane displays the following information:

• Group Name—Name of the group you selected.

• Type—Type of objects in the selected group.

• Description—Text description of the group.

• Created By—Person who created the group.

• Last Modified By—Last person to modify the group settings.

Create Starts the Group Creation Wizard for creating a group, as described in Editing a Fault Group.

Edit Starts the Group Edit Wizard for editing user defined groups, as described in Editing a Fault Group. Not supported for view groups created from the Alerts and Activities Defaults page.

Details Opens the Properties: Details page, as described in Viewing Fault Group Details.

Refresh Refreshes a group memberships, as described in Refreshing Fault Membership. Not supported for port and interface groups.

Delete Deletes a group, as described in Deleting Fault Groups.


OL-25947-01


LMS uses the Group Creation Wizard to guide you through the steps required to create or edit a group. The wizard consist of four steps:

1. Setting properties (for details, see Editing a Fault Group)

2. Creating rules (for details, see Understanding Rules).

3. Modifying group membership (for details, see Finalizing Fault Group Membership).

4. Viewing the summary (for details, see Viewing the Fault Group Summary).

Editing a Fault Group

You can edit the properties of user defined customizable port, interface, and device groups. You can also edit miscellaneous user defined groups you created using Group administration.

Procedure

Step 1 Either:

• Select Admin > System > Group Management > Fault.

The Fault Group Administration and Configuration page appears.

Or

• Select Inventory > Group Management > Fault.


Step 2 In the Group Selector, select the group you want to edit, click Edit.

The Properties: Edit page appears.

You can modify the following in the Properties: Edit page:

• Group Name

Will be automatically populated when editing customizable subgroups; for example, Customizable Group 1 under Customizable Access Port Groups.

• Description

• Membership update type (not supported for port and interface groups)

The parent group is displayed, but it cannot be modified.

• Visibility Scope

Step 3 Click Next.

The Rules: Edit page appears. For more information on creating rules, see Understanding Rules.

To return to any of the previous pages in the wizard, click Back.

Note If you edit a device-type group, you can launch the Preview.


OL-25947-01



• Adding and Deleting Rules from the Rules:Edit Page

• Adding and Removing Objects from the Rules: Edit Page

Adding and Deleting Rules from the Rules:Edit Page

You can add new rules or delete existing rules in the Rules: Edit page.

To add a new rule:

Step 1 From the first list, select a logical operator (applicable when there are multiple rule expressions).

The list of logical operators is enabled after at least one rule expression is entered.+

Step 2 From the Object Type list, select an object type.

Step 3 From the Variable list, select a variable.

Step 4 From the Operator list, select an operator.

Step 5 In the Value field, enter a value.


The rule expression appears in the Rule Text box.

You can manually add or change any of the text in the Rule Text box. If you enter a single backslash (\), an error is displayed.

To enter a single backslash in the Rule Text box, you must type two backslashes (\\) in place of the single backslash. You should always check the syntax after changing a rule expression.

If you have added complex rules (containing both AND and OR conditions), you must manually enter parentheses, as in the following example:

(AccessPort.Mode equals ““ ORAccessPort.Mode contains “BACKUP” ORAccessPort.Mode contains “NORMAL”) ANDAccessPort.DuplexMode contains “HALFDUPLEX” ORAccessPort.DuplexMode contains “FULLDUPLEX”)

Step 7 Verify whether the syntax of the rule is correct by clicking Check Syntax.

A dialog box appears, stating that the syntax is valid.

Step 8 Click OK.

If you want to view the rules for the parent group, select View Parent Rules.

All rules assigned to a parent group also apply to any of its subgroups.

Step 9 Click Next.

The Membership: Edit page appears.


OL-25947-01


To delete a rule:

Step 1 In the Rule Text box, select the entire rule text and press the Delete key.

After deleting the rule, you must click the page so that the page can refresh, removing the list of logical operators.

Step 2 Click Next.

The Membership: Edit page appears.

Adding and Removing Objects from the Rules: Edit Page

You can add or remove specific objects from the group membership. This feature is not supported for port and interface groups.

The group's rule captures the list of objects that are added to or deleted from the group. The rule will contain an Includelist and an Excludelist section to reflect this.

Although it is acceptable for a rule to have more than one Includelist or Excludelist, the recommended practice is to consolidate them, forming one Includelist and one Excludelist. Check for duplicates across both lists and ensure that no device is both included and excluded.

You can add and remove objects from the Parent Group

To add an object:

Step 1 In the Available Objects from Parent Group column, select the device you want to add.

Step 2 Click Add.

Step 3 Click Next.

The group’s information appears in the Summary: Create page.


A dialog box appears, stating that changes to the group have been saved.

Step 5 Click OK.

To remove an object:

Step 1 In the Objects Matching Membership Criteria column, select the device you want to remove.


Step 3 Click Next.




Step 5 Click OK.


OL-25947-01


Creating a Fault Group

Creating fault groups is supported only for user defined miscellaneous groups. Once created, you can edit these groups.

Note When you create a fault group, at least one device must be in the managed state.

Procedure

Step 1 Either:



Or



Step 2 In the Group Selector, select User Defined Groups.

Step 3 Click Create.

The Properties: Create page appears.

Step 4 Enter a group name for the new group.

If you do not want to copy the attributes of an existing group to your new group, proceed to Step 6. If you want to copy the attributes of an existing group to the new group, do the following:

a. Click Select Group.

The Replicate Attributes page appears.

b. Select the group from which you want to copy the attributes.

c. Click OK.

All attributes except the group name are copied to the new group.

If you want to change the parent group (the location where the group will reside in the Group Selector), do the following:

a. Click Change Parent.

The Select Parent page appears.

b. Select the parent group.

Step 5 Click OK.

Enter a description. This is optional.

Step 6 Choose how you want the group membership updated.

This choice is not displayed for port and interface groups):

• If you want the membership for this group updated automatically, select Automatic.

• If you want the membership for this group updated only when the Refresh button is clicked, select Only Upon User Request.


OL-25947-01


Step 7 Select a Visibility Scope:

• Available to Created User Only

• Available to All Cisco Prime Users

Step 8 Click Next.

The Rules: Create page appears. (For more information on creating rules, see Understanding Rules.)

Step 9 Do one of the following:

• To create rules to apply to the group, go to Step 10.

• Click Next and select the objects on the Membership: Create page (not supported for port and interface groups). Then go to Step 10.

If you need to return to any of the previous pages in the wizard, click Back.

Step 10 Create all rules that you want to apply to the group:

a. Select a logical operator (applicable when there are multiple rule expressions).

The list of logical operators is enabled after at least one rule expression is entered.

b. Select an object type.

c. Select a variable.

d. Select an operator.

e. Enter a value.

f. Click Add Rule Expression.

The rule expression appears in the Rule Text box.

You can manually add or change any of the text in the Rule Text box. If you enter a single backslash (\), an error is displayed.

To enter a single backslash in the Rule Text box, you must type two backslashes (\\) in place of the single backslash. You should always check the syntax after changing a rule expression.

If you have added complex rules (containing both AND and OR conditions), you must manually enter parentheses, as in the following example:

(AccessPort.Mode equals ““ ORAccessPort.Mode contains “BACKUP” ORAccessPort.Mode contains “NORMAL”) ANDAccessPort.DuplexMode contains “HALFDUPLEX” ORAccessPort.DuplexMode contains “FULLDUPLEX”)

g. Verify that the rule syntax is correct by clicking Check Syntax.

A dialog box appears, stating the syntax is valid.

h. Click OK.

If you want to view the rules for the parent group, select View Parent Rules.

All rules assigned to a parent group also apply to any of its subgroups.

i. Click Next.

The Membership: Create page appears.


OL-25947-01


Adding and Removing Objects from the Rules: Create Page

You can add or remove specific objects from the group membership. This feature is not supported for port and interface groups.

The group's rule captures the list of objects that are added to or deleted from the group. The rule will contain an Includelist and an Excludelist section to reflect this.

Although it is acceptable for a rule to have more than one Includelist or Excludelist, the recommended practice is to consolidate them, forming one Includelist and one Excludelist. Check for duplicates across both lists and ensure that no device is both included and excluded.

You can add and remove objects from the Parent Group

To add an object:

Step 1 In the Available Objects from Parent Group column, select the device you want to add.

Step 2 Click Add.

Step 3 Click Next.




Step 5 Click OK.

To remove an object:

Step 1 In the Objects Matching Membership Criteria column, select the device you want to remove.


Step 3 Click Next.




Step 5 Click OK.


OL-25947-01


Understanding Rules

Every group is defined by a set of rules. A rule set contains a Boolean combination of individual rule expressions.

Rules are created to filter in the objects that you want to belong to the group, and to filter out those that you do not want in the group. When determining the objects that belong to a group, Group Management compares object information to the rule. If an object information satisfies all of the rule requirements, it is placed in the group.

One or more rule expressions can be applied to form a rule. Each rule expression contains the following:

Object Type.Variable Operator Value

For example:

Routers.Location equals "San Jose"

Complex rules that contain both OR and AND conditions require you to edit the rule manually. For example, all parentheses in the following rule must be added in the Rule Text field:

(AccessPort.Mode equals ““ ORAccessPort.Mode contains “BACKUP” ORAccessPort.Mode contains “NORMAL”) AND(AccessPort.DuplexMode contains “HALFDUPLEX” ORAccessPort.DuplexMode contains “FULLDUPLEX”)

Rules are defined through the Group Creation Wizard on the Rules: Create and Rules: Edit pages. You can define the following:

• Logical Operators

• Object Type

• Variable

• Operator

• Value

Logical Operators

The logical operator field appears when you are defining multiple rules. The logical operators can be:

• OR—Include devices that fulfill the requirements of either rule.

For interface, access port, and trunk port groups, this operator can only be used between the variables of the same type, as in the following valid rule:

AccessPort.DuplexMode equals “HALFDUPLEX” ORAccessPort.DuplexMode equals “FULLDUPLEX”

If you used an AND operator in the previous port rule, it would be invalid.

• AND—Include only objects that fulfill the requirements of both rules.

For interface, access port, and trunk port groups, this operator can only be used between the variables of different types, as in the following example:

AccessPort.Mode equals “” ANDAccessPort.DuplexMode equals “FULLDUPLEX”

If you used an OR operator in the previous rule, it would be invalid.


OL-25947-01


For device groups, this operator can only be used between variables of the same type, as in the following example:

Routers.Model equals "12816" ANDRouters.Model equals “12810”

The following would be an invalid rule for a device group:

Routers.Model equals "12816" ANDSwitchesAndHubs.Type equals "6509"

In the previous example, you would have to use the OR operator.

• EXCLUDE—Do not include these devices.

Object Type

The Object Type field lists the available objects that you can use to form a group.

Depending upon the type of group you are creating, the Object Type field may contain the following choices:

AccessPortTrunkPortInterfaceCableContentNetworkingDeviceDSLAndLREGroupInterfacesAndModulesNetworkManagementOpticalRoutersSecurityAndVPNServerFabricSwitchesStorageNetworkingSwitchesAndHubsUniversalGatewaysAndAccessServersUnknownVoiceAndTelephonyWireless

Variable

The Variable field lists the possible attributes for the selected object type to be used for the rule. The list of possible variables changes based on the object type that is selected. Some variables for port and interface groups are described in Table 5-11.

Operator

The Operator field defines the operator to be used in the rule. The list of possible operators changes based on the object type and the variable selected.

When using the equals operator, the rule is case-sensitive.

Value

The Value field describes the value of the rule expression. The possible values depend upon the object type, variable, and operator selected. Depending on the operator selected, the value may be free-form text or a list of values.


OL-25947-01


Most of the values that can be entered in the Value field of the Rules: Edit page are self-evident, but some of the objects in the Variables field have special meanings or restrictions on how to enter the related attribute in the Value field.

Table 5-11 describes the objects that appear in the Variable field of the Rules: Edit page that might need further explanation.

Note After you have defined the rule, you should verify the syntax. You can do this on the Rules: Edit page.

Table 5-12 describes the remaining fields on the Rules: Edit page of the Group Creation Wizard.

Table 5-11 Explanations for the Values of Special Variables

Variable Explanation

Description Interface or port description.

DuplexMode Duplex mode (FULLDUPLEX, HALFDUPLEX, or UNSPECIFIED).

InterfaceCode Interface types, protocols, or encapsulations.

MaxSpeed Maximum speed, in bits per second.

MaxTransferSpeed Speed of the largest datagram that can be sent or received, specified in octets.

For interfaces that use transmitting network datagrams, this is the speed of the largest network datagram that can be sent.

Mib2ifType Type of interface, distinguished according to the physical or link protocols immediately below the network layer in the protocol stack, represented as a digit.

Mode Intended purpose (for example, for interfaces, backup, dial-on-demand, and so forth).

Name Name of object.

SystemModel Name of the system.

SystemName Name of system containing this element.

SystemObjectID System Object Identifier associated with vendor of system.

SystemVendor Name of system supplier.

Type Type of element (for example, interface), distinguished according to the physical or link protocols immediately below the network layer in the protocol stack.

Table 5-12 Fields on the Rules: Edit Page


Add Rule Expression Used to add the rule expression to the group rules.

Rule Text Displays the rule. For complex rules (which contain both OR and AND conditions), you must manually add parentheses in this field. (In Editing a Fault Group, see Step 10 and Step 6.)


OL-25947-01


Examples of Rules

You want to create a group that contains all interfaces using full duplex mode in the Dallas location. Form the following rule:

Interface.Duplex.Mode contains "FULLDUPLEX" AND Location contains “Dallas”

• Interface

• Variable—Duplex.Mode

• Operator—Contains

• Value—“FULLDUPLEX”

• Logical Operator—And

• Variable—Location

• Operator—contains

• Value—“Dallas”

You want to create a group that contains all of the security and VPN devices in the San Jose location. Form the following rule:

SecurityAndVPN.Location contains "SanJose"

• Object Type—SecurityAndVPN

• Variable—Location

• Operator—Contains

• Value—“San Jose”

To understand the group rules, see the rules used for system defined groups. These rules appear in the Properties: Details page. For a description of the Properties: Details page, see Viewing Fault Group Details.

Finalizing Fault Group Membership

After the group rules have been defined, they are evaluated, and you can view the group members (except for port and interface groups, which are only used for polling and threshold purposes). In addition, the group membership can be modified by adding or removing specific objects.

The group rule will be automatically modified to reflect the objects that were added or removed from the group. You add or remove specific objects from a group membership in the Membership: Edit page of the Create Group Wizard.

Check Syntax Verifies that the rule syntax is correct.

View Parent Rules Used to view the parent group rules.

All parent group rules apply to the subgroups.

Table 5-12 Fields on the Rules: Edit Page (continued)



OL-25947-01


Viewing the Fault Group Summary

The final step in the Create Group Wizard is viewing a summary page that displays the new group definition. Table 5-13 describes the fields on the Group Summary page of the Group Creation Wizard.

Viewing Fault Group Details

Information about a group is displayed on the Properties: Details page.

To view the Fault group details:

Step 1 Either:



Or



Step 2 In the Group Selector, select the group for which you want to view details.


The Properties: Details page appears.

Table 5-13 Fields on the Group Summary Page

Heading/Button Description


Parent Group Parent group of the group you are creating.


Membership Update Automatic (updated whenever the group is accessed) or upon user request (updated only when you click the Refresh button).

Rules Rules used to filter group membership.

Visibility Scope Setting that determines whether all Cisco Prime users or only the created user can view the group.

Polling Overriding Group preview

Click to display the Preview page. This page displays the priorities of the Polling Overriding Groups.

Threshold Overriding Group preview

Click to display the Preview page. This page displays the priorities of the Threshold Overriding Groups.


OL-25947-01


Table 5-14 describes the fields on the Properties: Details page.

Viewing Fault Membership Details

You can view a list of the objects that belong to a group by accessing the Properties: Details page. Membership is not displayed for port and interface groups, which are used only for polling and threshold purposes.

Procedure

Step 1 Either:



Or



Step 2 In the Group Selector, select the group for which you want to view details.


The Properties: Details page appears.


The Membership: Details page appears.

Table 5-14 Fields on the Properties: Details Page






Membership Update Automatic (updated whenever the group is accessed) or upon user request (updated only when you click the Refresh button)

Created By Person who created the group.

Last Modified By Last person to modify the group.


View Parent Rules Used to view the parent group rules. All parent group rules apply to the subgroups.

Membership Details Used to view the list of devices that belong to the group. Does not apply to port and interface groups.

Cancel Closes the page and takes you back to the Group Administration and Configuration page.


OL-25947-01


Table 5-15 describes the fields on the Membership: Details page.

Refreshing Fault Membership

Refreshing a group membership forces the group to recompute its membership by reevaluating its rules and obtaining membership information from the data collectors. Port and interface group membership lists are not supported, because these groups are only used for polling and threshold purposes.

Procedure

Step 1 Either:



Or



Step 2 In the Group Selector, select the group you want to refresh.

Step 3 Click Refresh.

Step 4 In the confirmation dialog box, click Yes.

Step 5 In the next dialog box, click OK.

Table 5-15 Fields on the Membership: Details Page


Name Name of the device for which you want to view membership details.

Object Type Type of object for which you want to view details.

Property Details Takes you back to the Properties: Details page.

Cancel Closes the page and takes you back to the Group Administration and Configuration page.


OL-25947-01

Chapter 5 Managing Groups Understanding Collector Group Rules

Deleting Fault Groups

You can only delete user defined groups that are not one of the seven customizable groups.

Procedure

Step 1 Either:



Or



Step 2 In the Group Selector, select the group you want to delete.


Step 4 In the confirmation dialog box, click Yes.

Step 5 In the next dialog box, click OK.

Edit, Refresh, and Delete cause internal processes to start. For this reason, LMS could experience a period of high CPU utilization after these processes are triggered.

Understanding Collector Group RulesEvery group is defined by a set of rules. A rule set contains a Boolean combination of individual rule expressions.

You can access the IPSLA Collector groups using either:

• Select Admin > System > Group Management > IPSLA Collector.

The IPSLA Collector Group Administration page appears.

Or

• Select Inventory > Group Management > IPSLA Collector.

The IPSLA Collector Group page appears.

Rules are created to filter in the devices that you want to include in the group, and to filter out those that you do not want in the group.

While determining the devices that belong to a group, Group Management compares device information to the rule. If the information on a device satisfies all the requirements of the rule, it is placed in the group.

The devices are filtered based on the data present in the IPSLA Performance database.

One or more rule expressions can be applied to form a rule.

Each rule expression contains the following:

object type.variable operator value


OL-25947-01



• IPSLA Collector Group Administration Process

• Understanding IPSLA Collector Group Administration

Table 5-16 lists the various operators that can be used to create rules to group Collectors.

Table 5-16 Understanding Collector Group Rules


OR, AND, EXCLUDE, INCLUDE

Logical operators.

• OR—Include objects that fulfill the requirements of either rule.


• EXCLUDE—Do not include these objects.

• INCLUDE— Include these objects

The Rule Text field appears only after a rule expression is added.

Object Type Type of object (collector) that is used to form a group.

Variable Collector components, based on which you can define the group.

For more information, see Collector Components.

Operator Operator to be used in the rule. The list of possible operators changes based on the Variable selected.

When using the equals operator the rule is case-sensitive.


OL-25947-01


Value Value of the rule expression. The possible values depend upon the variable and operator selected. Depending on the operator selected, the value may be free-from text or a list of values.


The following are the values for the corresponding operations:

• 1 = echo

• 2 = pathEcho

• 5 = udpEcho

• 6 = tcpConnect

• 7 = http

• 8 = dns

• 9 = jitter

• 10 = dlsw

• 11 = dhcp

• 12 = ftp

• 14 = RTP

• 16 = icmpjitter

• 18 = VoipCallSetupPostDialDelay

• 19 = VoipGKRegDelay

• 1019-Ethernetping

• 1020-Ethernetjitter

• 1119-EthernetPingAutoIPSLA

• 1120-EthernetJitterAutoIPSLA



Check Syntax Verifies if the rule syntax is correct.

Use this button if you have entered the rules manually.



Table 5-16 Understanding Collector Group Rules



OL-25947-01


Collector Components

Table 5-17 lists the available group attributes that you can use for defining the User-Defined groups.

IPSLA Collector Group Administration Process

The IPSLA Collector Group Administration depends on the IPMOGSServer processes. If these processes are not running, then an error message appears:

Error in communicating with Group Administration Server.

It may be down or not yet up. Please make sure that the Group Administration Server is up and running, then refresh the page.

You can resolve this error by starting the IPMOGSServer process.

You can start this process using Admin > System > Server Monitoring > Processes.

The Process Management page appears with all Cisco Prime processes listed. In the Process Management page, select the IPMOGSServer and click Start.

If the IPMOGS Server is down, do the following:

You can start the IPMOGS Server either from the CLI, or from the LMS UI.

To start IPMOGS Server from the CLI:

Enter NMSROOT/bin/pdexec IPM OGSServer

where NMSROOT is the Cisco Prime installation directory.

To start IPMOGS server from the LMS UI:

Step 1 Select Admin > System > Server Monitoring > Processes.

The Process Management page appears with all Cisco Prime processes listed.

Step 2 Select IPM OGSServer in the Process Management dialog box.

Step 3 Click Start.

Table 5-17 Collector Components

Component Type Description

Source Address Device IP address.

Target Address Device IP address.

Operation Type All IPSLA operations available for LMS

Operation Name Name of a user-defined operation.

VRF Name of the VRF (Virtual Routing and Forwarding).


OL-25947-01


If the CMFOGS Server is down, do the following:

You can start the CMFOGS Server either from the CLI, or from the LMS UI.

To start CMF OGS Server from the CLI:

Enter NMSROOT/bin/pdexec CMFOGSServer

where NMSROOT is the Cisco Prime installation directory.

To start CMFOGS server from the LMS UI:

Step 1 Select Admin > System > Server Monitoring > Processes.

Step 2 Select CMFOGSServer in the Process Management dialog box.

Step 3 Click Start.

Understanding IPSLA Collector Group Administration

This section explains the various tasks that you can perform on the IPSLA Collector Group Administration.

Table 5-18 lists the Fields and buttons available in the Group Administration page.

Table 5-18 IPSLA Collector Group Administration Page


Group Selector Hierarchical display of all available groups.

Group Info Displays the following collector group information:

• Group Name—The name of the group you selected.

• Type—The type of objects in the selected group.

• Description—A text description of the group.

• Created By—The person who created the group. You can also view the time at which the group was created.

• Last Modified By—The last person to modify the group settings. You can also view the time at which the group was modified.

Create Starts the Group Creation Wizard for creating a group, as described in the Creating and Modifying User-Defined Collector Groups.

Edit Starts the Group Edit Wizard for editing an existing group, as described in the Creating and Modifying User-Defined Collector Groups.

Details Opens the Properties: Details page, as described in the Viewing Collector Group Details and Viewing Membership Details.

Refresh Refreshes a group membership, as described in the Refreshing User-Defined Collector Group Membership.

Delete Deletes a group, as described in the Deleting User-Defined Collector Groups.


OL-25947-01

Chapter 5 Managing Groups Working with User-Defined Collector Groups

Working with User-Defined Collector GroupsThese are collector groups created by the user based on a set of criteria such as operation name, operation type, source address, and target address.

For example, if you want to create a location-based collector groups, you must select the devices used by that location and define the collector groups based on the criteria mentioned above.

You can perform the following tasks on user-defined collector groups:

• Creating and Modifying User-Defined Collector Groups

• Deleting User-Defined Collector Groups

• Viewing User-Defined Collector Groups

• Refreshing User-Defined Collector Group Membership

Creating and Modifying User-Defined Collector Groups

LMS provides a single wizard-based approach that leads you through the procedure to create multiple user-defined collector groups. This wizard process involves the following four steps:

1. Setting Collector Group Properties

2. Defining Collector Group Rules

3. Assigning Collector Group Membership

4. Viewing the Collector Group Summary

You must complete all the four tasks in this sequence to create collector groups. If you exit the wizard at any stage using Cancel, the details you have specified will be lost and the collector groups will not be created.

Setting Collector Group Properties

In this step, you can enter the group properties such as name and description, copy the attributes from another group, change the parent group, and modify the parent group and membership update details, if required.


OL-25947-01


To set or edit the collector group properties:

Step 1 Either:



Or


The IPSLA Collector Group page appears.

Step 2 Select the required group from the Group Selector pane.

For example:

• If you want to create or edit a group, select the User Defined Group folder from the Group Selector pane.

• If you want to create or edit a subgroup, select the required collector group under the User Defined Groups folder.

Step 3 You can either:

• Click Create to create a group or subgroup.

Or

• Click Edit to edit a group or subgroup.


Step 4 Specify the collector group name and description in the Group Name and Description fields.

The Group Name must be unique within the parent group. However, you can specify the same name in some other groups.

For example, if you already have a group named ‘MyGroup’ in a group named ‘Views’ under User-Defined Groups, you cannot use the same name for another subgroup in the group ‘Views’. However, you can use the name 'MyGroup' for the subgroup of another group in User-Defined Groups.

After entering the group name and description, you can either copy the attributes of an existing group to the new group or proceed to Step 5.

To copy the attributes of an existing group to the new group, do the following:

a. Click Select Group.

The Replicate Attributes window appears.

b. Select the required collector group from the User Defined Groups folder.

c. Click OK.

All attributes except the group name are copied to the new group.

The parent group you have selected for the group does not change even if you are copying attributes from a group that belongs to a different parent group.


OL-25947-01


To change the parent group, do the following:

a. Click Change Parent.

The Select Parent window appears.

b. Select the required group.

c. Click OK.

The Properties page appears with the new parent group.

Step 5 Select the Membership Update and Visibility Scope for the group.

For more information, see Table 5-19.

Step 6 Click Next.

The Rules page appears.

Defining Collector Group Rules

In this step, you can define the rules for the collector groups. This rule determines the contents and the collectors to be included in the collector group.

This rule allows you to add collectors and VRFname based on the variables such as operation name, operation type, source address, and target address. You can use one or a combination of variables while defining the rule. The collectors that satisfy the rule will be added to the collector group.

If you have created the collector group copying the attributes of another group, the rules specified for that group appears in the Rule Text field. You can retain these and add more rules, or delete these rules and create a new set of rules.

Note All rules assigned to a parent group also apply to any of its subgroups.

Table 5-19 Setting Collector Group Properties

Field Description


Copy Attributes from Group

Copy the attributes of an existing group to your new group using Select Group.

Parent Group Parent group of the group you are creating. You can change the parent group using Change Parent.


Membership Update Group Membership is updated.

• Automatic: Updates whenever the group is accessed.

• Only Upon User Request: Click Refresh.

Visibility Scope • Private Groups: Visible only to users who created the group.

• Public: Visible to all users.


OL-25947-01


In the Rules page, you can either enter the rules directly in the Rule Text field or select the components of the rule from the Rule Expression fields and define a rule.

Table 5-20 lists the various Fields and Buttons available in the Rules page.

For group rule restrictions and examples, see Understanding Collector Group Rules.

Table 5-20 Defining Collector Group Rules


OR, AND, EXCLUDE Logical operators.

• OR—Include objects that fulfill the requirements of either rule.


• EXCLUDE—Do not include these objects.

The Rule Text field appears only after a rule expression is added.

Object Type Type of object (Collector) that is used to form a group. All IPSLA Collector group rule expressions begin with the same Object Type, IPM:Collector Management: Collector.

Variable Collector attributes, based on which you can define the group.

For more information, see Collector Components.

Operator Operator to be used in the rule. The list of possible operators change based on the Variable selected.

When using the Equals operator, the rule is case sensitive.

Value Value of the rule expression. The possible values depend upon the variable and operator selected. Depending on the operator selected, the value may be free-form text or a list of values.




Check Syntax Verifies that the rule syntax is correct.

Use this button if you have entered the rules manually.




OL-25947-01


To define the collector group rules:

Step 1 Either:



Or



Step 2 Select the Object Type from the drop-down list.

Step 3 Select the required variables from the Variable drop-down list. You can select one or a combination of variables.

The variables available are Operation Name, Operation Type, Source Address, VRF name, and Target Address.


Step 4 Select the Boolean operator from the Operator drop-down list.

The Boolean operators change based on the variable you have selected.


Step 5 Specify the Value for the variable you have selected.


The IPSLA Collector Group Administration creates the rule based on the parameters you specified and adds it to the rules already present in the Rules Text field. You can use the same procedure to add more rules.

If you want to delete a rule expression, you have to select the complete expression including the logical operator and press the Delete key on your keyboard.

Step 7 Click Check Syntax to validate the rules expression syntax.

If the Syntax is correct, a confirmation message appears, The rule syntax is valid. If the Syntax is incorrect, an error message appears with syntax error messages along with the line and column number.

Step 8 Click View Parent Rules to view the parent and group rules.

Step 9 Click Next.

The Membership page appears.

Assigning Collector Group Membership

The Membership page allows you to create a highly customized user-defined collector group. This page lists the collectors in two panes, namely Objects From Parent Group and Objects Matching Membership.

• Objects From Parent Group—Lists the collectors in the parent group.

• Objects Matching Membership—Lists the collectors that satisfy the rule defined by you. You can add or delete collectors from this pane. You can also add collectors from the parent group to create the collector group.


OL-25947-01


To assign collector group membership:

Step 1 Select the required collectors from the Objects From Parent Group pane.

Step 2 Click Add.

The selected collectors are added to the Objects Matching Membership pane.

Step 3 Click Next.

The Summary page appears with the User-Defined Group properties.

To remove collectors from the group:

Step 1 Select the required collectors from Objects Matching Membership pane.


The selected collectors are removed from the Objects Matching Membership pane and added to the Objects From Parent Group pane.

Step 3 Click Next.

The Summary page appears with the summary of the user-defined collector group.

Viewing the Collector Group Summary

The final step is the Summary page that displays the new group definition as in Table 5-21.

Table 5-21 Understanding Collector Group Summary

Field Description



Parent Group Parent group of the group you are creating. You can change the parent group using Change Parent.

You can select only IPSLA Collector User-Defined groups.

You cannot edit this field in the Edit flow.

Membership Update Updates group membership.

Membership updates can be automatic (updated every time the group is accessed) or upon user request only (updated only when you click Refresh).


Visibility Scope Describes if the group is public (all users) or private (only for the group owner).


OL-25947-01


To view the collector group summary:

Step 1 Click Finish to complete the procedure for creating collector groups.

A confirmation message appears.

Step 2 Click OK.

You can view the newly created user-defined collector group in the Group Selector pane.

Or

Click Back to modify the group properties.

Deleting User-Defined Collector Groups

In the The IPSLA Collector Group Administration page, you can use the Delete option to delete the user-defined collector groups. During the deletion process, only the collector group is deleted , and the associated collectors are not deleted. You cannot delete the system-defined collector groups.

To delete user-defined collector groups:

Step 1 Select the group for which you want to view details from the Group Selector pane.


A confirmation message appears.

Viewing User-Defined Collector Groups

This section explains how to view the group and membership details and refresh the same.

• Viewing Collector Group Details

• Viewing Membership Details

• Refreshing User-Defined Collector Group Membership

Viewing Collector Group Details

The Property Details page displays the group details.

To view the collector group details:

Step 1 Either:



Or




OL-25947-01




The Property Details page appears. For more information, see Table 5-22.

Viewing Membership Details

The Property Details page allows you to view a list of the objects that belong to a group.

To view the membership details:

Step 1 Either:



Or





The Property Details page appears.

Table 5-22 Viewing Collector Group Details






Membership Update How group membership is updated.

Created By Person who created the group. This also displays the time at which it was created.

Last Modified By Last person to modify the group. This also displays the time at which it was modified.


Visibility Scope Indicates whether the group is Public (visible to all users) or Private (visible only for the group owner).

View Parent Rules Allows you to view the parent group rules.


Membership Details Allows you to view the membership details.

Cancel Takes you back to the Group Administration page.


OL-25947-01



The Membership Details page appears. For more information, see Table 5-23.

Refreshing User-Defined Collector Group Membership

Refreshing a group membership forces the group to recompute its membership by reevaluating its rules and obtaining membership information from the data available.

To refresh the membership of the group:

Step 1 Either:



Or




Step 3 Click Refresh to refresh the membership of the selected group.

The Refresh Group Confirmation dialog box appears.

Step 4 Click OK.

A message appears that the selected group membership has been refreshed.

Or

Click Cancel to return to the Group Administration page.

Table 5-23 Viewing Membership Details


Name Name of the device.

Object Type Type of object.

Property Details Takes you back to the Property Details page.

Cancel Takes you back to the Group Administration page.


OL-25947-01

Chapter 5 Managing Groups Operation-Based Collector Groups (System-Defined)

Operation-Based Collector Groups (System-Defined)The operation-based collector groups are predefined groups available with IPSLA module in LMS by default. They are also referred as system-defined collector groups.

The various operation-based collector groups available are Echo, Path Echo, UDP Echo, ICMP Jitter, UDP Jitter, Call Setup Post Dial Delay, Gatekeeper Registration Delay, RTP, DNS, DHCP, HTTP, FTP, DLSW, TCP Connect, Ethernet Jitter, Ethernet Ping, Ethernet Jitter Auto IP SLA and Ethernet Ping Auto IP SLA.

You can perform the following tasks on operation-based collector groups:

• Viewing Operation-Based Collector Details

• Refreshing Operation-Based Collector Groups

To view the details of an operation-based collector group:

Step 1 Either:



Or



Step 2 Select the default operation name from the Group Selector pane for which you want to view the collector group details.


The system-defined collector group details appear.

Step 4 Click Membership Details to know the membership details of this system-defined collector group.

The Membership Details page appears.

To refresh the membership of an operation-based group:


Step 2 Click Refresh to refresh the membership of the selected group.

The Refresh Group Confirmation dialog box appears.

Step 3 Click OK.

A message appears that the selected group membership has been refreshed.

Or

Click Cancel to return to the Group Administration page.


OL-25947-01

Chapter 5 Managing Groups Operation-Based Collector Groups (System-Defined)


OL-25947-01

chapter 5: managing groups...chapter 5-1 administration of cisco prime lan management solution 4.2...

Documents