Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Group commands

add

Use the add command to create a new group.

If the group already exists, AKIPS will not update it.

You cannot change a group's type once created.

Use the following syntax:

add {type} group {group name}

Examples

Add a group:

add device group core-routers

Add an interface group:

add interface group uplinks

Add an ipsla group:

add ipsla group Jitter-tests

Add device and super groups:

add device group SFO-BuildingA-Fl01
add device group SFO-BuildingA-Fl02
add device group SFO-BuildingA-Fl03
...
add device group SFO-BuildingB-Fl01
add device group SFO-BuildingB-Fl02
add device group SFO-BuildingB-Fl03
...
add super group SFO-BuildingA
add super group SFO-BuildingB
add super group SFO-Campus

Add interface and super groups:

add interface group SFO-BuildingA-switch-uplinks
add super group SFO-Campus-switch-uplinks

You can also use the add command to create a new profile group. Use the following syntax:

add profile group {group name}

Example

add profile group WAN-Tech-Support

assign

Use the assign command to assign groups.

Use the following syntax:

assign group {group name} = {super group name}

assign {type} {parent regex} [{child regex} [{attribute regex}]] [value {text|integer|/regex/|ipaddr}] [profile {profile name}] [any|all|not group {group name} ...] = {target group} ...

Examples

Create vendor groups and assign devices to them based on attribute values:

add device group Cisco
add device group Extreme
assign * * sys SNMPv2-MIB.sysDescr value /Cisco/ = Cisco
assign * * sys SNMPv2-MIB.sysDescr value /Cabletron/ = Extreme
assign * * sys SNMPv2-MIB.sysDescr value /Enterasys/ = Extreme
assign * * sys SNMPv2-MIB.sysDescr value /Extreme/   = Extreme

Put different models into groups using sysDescr:

add device group Cisco-3600
add device group Cisco-3700
add device group Cisco-7200
assign * * sys SNMPv2-MIB.sysDescr value "/Cisco IOS 3600/" = Cisco-3600
assign * * sys SNMPv2-MIB.sysDescr value "/Cisco IOS 3700/" = Cisco-3700
assign * * sys SNMPv2-MIB.sysDescr value "/Cisco IOS 7200/" = Cisco-7200

Put different models into groups using sysObjectID:

add device group Cisco-3600
add device group Cisco-3700
add device group Cisco-7200
assign * * sys SNMPv2-MIB.sysObjectID value /CISCO-PRODUCTS-MIB.cisco36/ = Cisco-3600
assign * * sys SNMPv2-MIB.sysObjectID value /CISCO-PRODUCTS-MIB.catalyst37xxStack/ = Cisco-3700
assign * * sys SNMPv2-MIB.sysObjectID value /CISCO-PRODUCTS-MIB.cisco72/ = Cisco-7200

Create some device groups:

add device group routers
add device group switches
add device group core-routers
add device group regional-routers
add device group core-switches
add device group regional-switches

Create some interface groups:

add interface group core-links
add interface group core-switch-uplinks
add interface group regional-links
add interface group servers

Assign interfaces to a group:

add interface group serial-links
assign interface * /^Se/ = serial-links27

Assign all links with a specific ifAlias to a group:

add interface group Switch-Uplinks
assign interface * * IF-MIB.ifAlias value /uplink/ = Switch-Uplinks

Create a group hierarchy:

add device group central-office-fl01
assign device /central-office-fl01-.*/ = central-office-fl01

add device group central-office-fl02
assign device /central-office-fl02-.*/ = central-office-fl02

add super group central-office
assign group central-office-fl01 = central-office
assign group central-office-fl02 = central-office

add super group Brisbane
assign group central-office = Brisbane

add super group Queensland
assign group Brisbane = Queensland

add super group Australia
assign group Queensland = Australia

You can also use the assign command to assign a user or group to a profile group.

Use the following syntax:

assign user {user name} = {profile name}
assign {type} group {group regex} = {profile name}
assign group {group regex} = {profile name}

Examples

Allow a profile to access a device group:

assign device group Alcatel = Support

Allow a profile to access an interface group:

assign interface group ifspeed_10G = Support

Assign a user to a location profile:

assign user a.jager = Building02

Create a profile group and allow it to access specific devices:

add profile group WAN-Tech-Support
add device group WAN-Devices
assign * * sys SNMPv2-MIB.sysDescr value /Cisco/ = WAN-Devices
add report group WAN-Reports
assign * * config vendor value /Cisco/ = WAN-Reports
assign group WAN-Devices = WAN-Tech-Support
assign group WAN-Reports = WAN-Tech-Support

Create a profile group, assign a user and allow access to devices with a specific sysName:

add profile group Helpdesk-Profile
assign user fred = Helpdesk-Profile
add device group Helpdesk-Devices
assign * /-swt|-rtr/ = Helpdesk-Devices
assign group helpdesk-devices = Helpdesk-Profile

clear

Use the clear command to remove group assignments.

Use the following syntax:

clear group {group name} = {super group name}

clear {type} {parent regex} [{child regex} [{attribute regex}]] [value {text|/regex/|integer|ipaddr}] [profile {profile name}] [any|all|not group {group name} ...] = {target group} ...

Example

Assign devices to a group and then clear switches:

assign * * sys SNMPv2-MIB.sysDescr value /Cisco/ = Cisco

clear * * sys SNMPv2-MIB.sysDescr value "/Cisco IOS C3560/" = Cisco

You can also use the clear command to remove entities from a profile group.

Use the following syntax:

clear user {user name} = {profile name}
clear group {group name} = {profile name}
clear {type} group {group regex} = {profile name}

Examples

Remove a user from a profile group:

clear user a.jager = Cisco-Only

Remove a profile group's access to a device group:

clear group WAN-Device = WAN-Tech-Support

count

Use the count command to return the number of entities in a group.

Use the following syntax:

count {type} group {group regex}

Example

Count the number of interfaces in a group:

count interface group uplinks

1069

delete

Use the delete command to remove a single group. Use the following syntax:

delete {type} group {group name}

Examples

Delete a device group:

delete device group core-routers

Delete an interface group:

delete interface group uplinks

Delete a super group:

delete super group SFO-Campus

get

Use the get command to check if a group exists. Use the following syntax:

get group {group name}

Example

get group Cisco

device

You can also use the get command to check if a profile group exists.

Use the following syntax:

get profile user {user name}

Example

Show the profile allocated to a user:

get profile user a.jager

Support

list

Use the list command to see the groups in a specific type.

Use the following syntax:

list {type} group [{parent name} [{child name} [{attribute name}]]] [profile {profile name}] [super {super group name}]

Examples

list profile group

list device group

list * group

You can also use the list command to find the profile groups associated with an entity.

Use the following syntax:

list profile {type} {parent name} [[{child name}] {attribute name}]

Examples

Find the groups associated with a profile group:

list * group profile Support

super,Australia
super,Brisbane
super,central-office
device,Cisco
device,Dell
interface,ifspeed_1
interface,ifspeed_1.4G
interface,ifspeed_1.5M
interface,ifspeed_1.8

Find the devices associated with a profile group:

list device group profile Support

Cisco
Dell

Find the interfaces associated with a profile group:

list interface group profile Support

ifspeed_1
ifspeed_1.4G
ifspeed_1.8G
ifspeed_100G
...

Find all the super groups that a profile group can access:

list device super group profile Support

Australia
Brisbane
central-office

mget

Use the mget command to retrieve large amounts of configuration information for a profile group. Use the following syntax:

mget {type} [{parent regex} [{child regex} [{attribute regex}]]] [value {text|integer|/regex/|ipaddr}] [profile {profile name}] [any|all|not group {group name} ...]

Example

Show every device that a profile group can access:

mget device profile Cisco-Only

cisco-132-0-1
cisco-132-0-10
...

mlist

Use the mlist command to find entities associated with a profile group.

Use the following syntax:

mlist {type} [profile {profile name}]

Example

Show which devices a profile group can access:

mlist device profile fred

mtype

Use the mtype command to return an entity type for a profile group.

Use the following syntax:

mtype {type} [profile {profile name}]

Example

Show which entity types a profile group can access:

mtype * profile Fred

prune

Use the prune command to remove empty groups.

Use the following syntax:

prune {type} group [{group regex}]

Examples

Remove all empty device groups:

prune device group

Remove all empty interface groups:

prune interface group

rename

Use the rename command to rename a group. This will retain all of its associations.

Use the following syntax:

rename {type} group {existing group name} {new group name}

Examples

Rename a profile group:

rename profile group Support Network-Support

Rename a device group:

rename device group core-routers USA-Core-Routers

Rename an interface group:

rename interface group uplinks Switch-Uplinks