objmap
Abstract
Displays a list of objects that match a selection criteria specified by one of several argument formats. The list can be limited to a single object, consist of a set of related objects, or include all objects.
Syntax
objmap all
objmap <type> [<pattern>]
objmap <objref> parents
objmap <objref> children [<type> [<pattern>]]
| Argument | Type | Description |
|---|---|---|
<objref> |
integer or string | numeric object ID or hierarchical name of the object-of-interest An object ID for this argument can be obtained by using the ODB command objid, or from a previous use of objmap. |
| parents | n/a | Display parents of the specified object. |
| children | n/a | Display children of the specified object. |
| all | n/a | Display all objects. |
<type> |
integer | type of the object(s)-of-interest Use the ODB command help objmap to see a list of object type keywords. |
<pattern> |
string | regular expression to be matched against the names of objects of the specified <type>. |
Details
The objects selected for the list are determined by the specified argument format:
- a single object is specified by its object reference
- all objects of a particular type are specified by an object type keyword
- all objects of a particular type with the same name are specified by an object type keyword and a name
- all objects having a parent/child hierarchical relationship with the object-of-interest are specified by an object reference and one of the relationship arguments (parents, children)
- all simulation objects are specified by the argument all. Multiple objects are listed in top-down order: for example, subnets, nodes, links, modules, and submodules.
Example
ODB> objmap pksw1.node0.proc
Obj ID Obj Name Obj Type Parent ID
------------------------------------------------------------------
54 top.pksw1.node0.proc processor 3
ODB> objmap 23 parents
Obj ID Obj Name Obj Type Parent ID
------------------------------------------------------------------
0 top subnetwork none
1 pksw1 subnetwork 0
2 hub fixed node 1
23 xmt0 pt-pt transmitter 2
ODB> objmap subnet
Obj ID Obj Name Obj Type Parent ID
------------------------------------------------------------------
0 top subnetwork none
1 top.pksw1 subnetwork 0
2 top.pksw2 subnetwork 0