mcollinfo

The mcollinfo command retrieves information about collectors loaded in a cell. Information consists of collector name, permission settings, referenced classes, and subcollectors. The complete collector tree is retrieved and reported in a hierarchical form. As an option, specific information about selected collectors can be retrieved instead of the whole tree.

mcollinfo syntax

The following figure shows the syntax for mcollinfo:

mcollinfo syntax

mcollinfo [-a <Amount>] [-c <ConfigFile>] [-i UserID[/Password][@Host[/Port]]]
[-h|-?] {-p <Var Value>} [-n <cellName> | -n @Host[/Port[#Key]]]
[-l <HomeLocation>] [-r] [-o <OutputFile>] [-v] [-q] [-z]
(-d | [-g] [-s] (Collector | -f InputFile))

The -n option is required if the cell is remote or if cellName differs from Host. See Using the -n option for more information.

The following table lists the command-specific options for mcollinfo. For a list of common command options that apply to all CLI commands, see Event management common command options.

mcollinfo options

Option	Description
`-a Amount`	Specifies the amount of information (0, 1, 2); the default is 2. For more information, see Information amount for mclassinfo.
`-d`	Reports collector definitions
`-f InputFile`	Reads collectors from InputFile instead of from command line
`-g`	Reports collector object identifier (OID)
`-o OutputFile`	Produces the output in a file called OutputFile, instead of using standard output
`-r`	Produces raw output for programs
`-s`	Reports collector status and severity counters
`Collector`	Specifies the collector name or OID with optional + suffix for closure

mcollinfo output

You can request output in raw format for parsing by a program. You can also request standard output formatted for users, including verbose output that provides additional information. See the preceding table for the available options.

Raw output format

Raw output consists of the collector tree, as shown in the following figure. The collector tree is reported depth-first, left-to-right, as CollInfo.

Raw output format for mcollinfo

CollInfo = CollCompCount (CollCompInfo)*CollCompCount
CollCompInfo = CollName CollPerm CollClassCount (CollClass)*CollClassCount CollInfo
CollPerm : CollPermR CollPermW CollPermX
CollPerm_ : CollRoleCnt (CollRole)*CollRoleCnt

Standard output format for mcollinfo

Standard output is essentially the same as raw output, but standard output does not report the counts. Standard output represents the tree structure through indentation.

By default, it reports permissions as a sequence of role numbers. Classes are reported as object identifiers (OIDs). In verbose-formatted output, it reports roles and classes with their names instead of numbers or OIDs.

Information amount for mcollinfo

The amount of reported information is limited as described in the following table:

Information amount limitation options for mcollinfo

Option	Description
`-a 0`	Reports only collector names
`-a 1`	Add permissions
`-a 2`	Add referenced classes