Skip Navigation Links
Exit Print View
| Oracle Solaris Cluster Reference Manual Oracle Solaris Cluster 4.1

Search Scope:

- This Document
- Entire Library

### clsnmpmib

### , clmib

- administer Oracle Solaris Cluster SNMP MIBs

### Synopsis

    /usr/cluster/bin/clsnmpmib  -V

    /usr/cluster/bin/clsnmpmib  [subcommand] -?

    /usr/cluster/bin/clsnmpmib  [subcommand] [options]
     -v [mib]

    /usr/cluster/bin/clsnmpmib disable  [-n node[,…] ]
     {+ |  mib ...}

    /usr/cluster/bin/clsnmpmib enable  [-n node[,…] ]
     {+ |  mib ...}

    /usr/cluster/bin/clsnmpmib export  [-n node[,…] ]
     [-o  {- |  clconfigfile}] [+ |  mib ...]

    /usr/cluster/bin/clsnmpmib list  [-n node[,…] ]
     [+ |  mib ...]

    /usr/cluster/bin/clsnmpmib set  [-p name=value] […]
     [-n node[,… ] {+ |  mib ...}

    /usr/cluster/bin/clsnmpmib show  [-n node[,…] ]
     [+ |  mib ...]

## Description

The `clsnmpmib` command administers existing Oracle Solaris Cluster Simple Network Management Protocol (SNMP) Management Information Bases (MIBs) on the current node. To create SNMP hosts that can administer the MIBs, see the `clsnmphost`(1CL) man page. To define SNMP Version 3 (SNMPv3) users who can access the MIBs when using the SNMPv3 protocol, see the `clsnmpuser`(1CL) man page.

The general form of this command is as follows:

`clsnmpmib` [subcommand] [options] [operands]

You can omit subcommand only if options specifies the option `-?` or `-V`.

Each option of this command has a long form and a short form. Both forms of each option are provided with the description of the option in the OPTIONS section.

See the `Intro`(1CL) man page for more information.

### Oracle Solaris Cluster MIBs

Oracle Solaris Cluster currently supports one MIB, the Event MIB. The Oracle Solaris Cluster SNMP Event MIB notifies an SNMP manager of cluster events in real time. When enabled, the Oracle Solaris Cluster Event MIB automatically sends trap notifications to all hosts that are defined by the `clsnmphost` command. The Oracle Solaris Cluster Event MIB sends trap notifications on port 11162. The SNMP tree is viewed on port 11161.

Because clusters generate numerous event notifications, only events with a severity of `warning` or greater are sent as trap notifications. The MIB maintains a read-only table of the most current 50 events for which a trap has been sent. This information does not persist across reboots.

You can use this command only in the global zone.

## SUBCOMMANDS

The following subcommands are supported:

`disable`

  Disables one or more of the cluster MIBs on the specified nodes.

  You can use this subcommand only in the global zone.

  If you do not specify the `-n` option, only MIBs on the current node are disabled. When a MIB is disabled, you cannot access the MIB tables, and the MIB does not send any trap notifications.

  Users other than superuser require `solaris.cluster.modify` role-based access control (RBAC) authorization to use this subcommand. See the `rbac`(5) man page.

`enable`

  Enables one or more cluster MIBs on the specified node.

  You can use this subcommand only in the global zone.

  If you do not specify the `-n` option, only MIBs on the current node are enabled. To limit the MIBs that are enabled, use the `mib` operand.

  When you enable a MIB, you enable all of its functionality. However, some further configuration might be necessary for all of the MIB features to be fully functional. For example, the MIB cannot send trap notifications if no hosts have been configured. For information about configuring the SNMP host, see the `clsnmphost`(1CL) man page man page.

  Users other than superuser require `solaris.cluster.modify` RBAC authorization to use this subcommand. See the `rbac`(5) man page.

`export`

  Exports the cluster MIB configuration information.

  You can use this subcommand only in the global zone.

  Use the `-n` option to specify one or more nodes from which to export the MIB configuration information. If you use `export` without the `-n` option, the subcommand exports only MIB configuration information from the current node. By default, this subcommand exports configuration information from all MIBs on the current node. To refine the output further, specify the name of one or more MIBs for which you need configuration information.

  For more information about the output format from the `export` subcommand, see the `clconfiguration`(5CL) man page. By default all output is sent to the standard output. Use the `-o` option followed by a file name to redirect the output to the file.

  Users other than superuser require `solaris.cluster.read` RBAC authorization to use this subcommand. See the `rbac`(5) man page.

`list`

  Displays a list of cluster MIBs on the specified nodes.

  You can use this subcommand only in the global zone.

  Use the `-n` option to specify the nodes for the cluster MIBs that you want to list. If you use the `list` subcommand without the `-n` option, the subcommand lists only the MIBs on the current node. To limit the MIBs that are listed, specify the name of one or more MIBs that you want to list.

  Users other than superuser require `solaris.cluster.read` RBAC authorization to use this subcommand. See the `rbac`(5) man page.

`set`

  Changes the SNMP protocol setting that is used on one or more of the MIBs on the specified nodes.

  You can use this subcommand only in the global zone.

  By default, this subcommand changes all MIBs on the nodes. If you do not specify the node, only the SNMP protocol for the MIBs on the current node is modified. You must specify the SNMP protocol by using the `-p` option. All MIBs use SNMPv2 as the default protocol setting. The `set` subcommand changes the protocol setting of all the MIBs, unless you use the `mib` operand to specify MIB names.

  Users other than superuser require `solaris.cluster.modify` RBAC authorization to use this subcommand. See the `rbac`(5) man page.

`show`

  Displays information for MIBs on the specified nodes.

  You can use this subcommand only in the global zone.

  The `show` subcommand displays the name of the MIB and its SNMP protocol version. By default, this subcommand shows information for all MIBs on the nodes.

  Users other than superuser require `solaris.cluster.read` RBAC authorization to use this subcommand. See the `rbac`(5) man page.

## Options

The following options are supported:

`-?`
`--help`

  Displays help information.

  You can specify this option with or without a subcommand.

  - If you use this option without a subcommand, the list of available subcommands is displayed.

  - If you use this option with a subcommand, the usage options for that subcommand are displayed.

  When you use this option, no other processing is performed.

`-n` node[,…]
`--node[s]` node`-[,…]`

  Specifies a node or a list of nodes. You can specify each node as a node name or a node ID. All forms of the `clsnmpmib` command accept this option. You can use the `-n` option to specify on which node[s] you want the action to be performed. Without the `-n` option, the command assumes the current node.

`-o` {- | clconfigfile}
`--output {- |` clconfigfile`-}`

  Specifies the location where information about the cluster MIB configuration is to be written. This location can be a file or the standard output. To specify the standard output, specify the minus sign (`-`) instead of a file name. If you specify the standard output, all other standard output for the command is suppressed. If you do not specify the `-o` option , the output is sent to the standard output. You can specify this option only with the `export` subcommand.

  Configuration information is written in the format that is defined in the `clconfiguration`(5CL) man page.

`-p` name=value
-`-property=`name`-=`value
-`-property` name`-=`value

  Specifies the version of the SNMP protocol to use with the MIBs. Oracle Solaris Cluster supports the SNMPv2 and SNMPv3 protocol versions.

  Multiple instances of `-p` name=value are allowed.

  You can set the following property with this option:

  `version`

    Specifies the version of the SNMP protocol to use with the MIBs. You specify value as follows:

    - `version=SNMPv2`

    - `version=snmpv2`

    - `version=2`

    - `version=SNMPv3`

    - `version=snmpv3`

    - `version=3`

`-V`
`--version`

  Displays the version of the command.

  Do not specify this option with subcommands, operands, or other options because they are ignored. The `-V` option displays only the version of the command. No other operations are performed.

`-v`
`--verbose`

  Prints verbose information to the standard output.

  You can specify this option with any form of the command, although some subcommands might not produce expanded output. For example, the `export` subcommand does not produce expanded output when you specify the verbose option.

## Operands

The following operands are supported:

mib

  Specifies the name of the MIB or MIBs to which to apply the subcommand. If you do not specify this operand, the subcommand uses the default plus sign (`+`), which means all MIBs. If you use the `mib` operand, specify the MIB in a space-delimited list after all other command-line options.

+

  All cluster MIBs.

## Exit Status

If the command is successful for all specified operands, it returns zero (`CL_NOERR`). If an error occurs for an operand, the command processes the next operand in the operand list. The returned exit code always reflects the error that occurred first.

This command returns the following exit status codes:

`0` `CL_NOERR`

  No error

  The command that you issued completed successfully.

`1` `CL_ENOMEM`

  Not enough swap space

  A cluster node ran out of swap memory or ran out of other operating system resources.

`3` `CL_EINVAL`

  Invalid argument

  You typed the command incorrectly, or the syntax of the cluster configuration information that you supplied with the `-i` option was incorrect.

`6` `CL_EACCESS`

  Permission denied

  The object that you specified is inaccessible. You might need superuser or RBAC access to issue the command. See the `su`(1M) and `rbac`(5) man pages for more information.

`18` `CL_EINTERNAL`

  Internal error was encountered

  An internal error indicates a software defect or other defect.

`35` `CL_EIO`

  I/O error

  A physical input/output error has occurred.

`36` `CL_ENOENT`

  No such object

  The object that you specified cannot be found for one of the following reasons:

  - The object does not exist.

  - A directory in the path to the configuration file that you attempted to create with the `-o` option does not exist.

  - The configuration file that you attempted to access with the `-i` option contains errors.

## Examples

Example 1 Listing MIBs

The following command lists all MIBs on the cluster node.

    # clsnmpmib list
    Event

Example 2 Enabling a MIB

The following command enables the Event MIB on the current node.

    # clsnmpmib enable event

The names of cluster MIBs are not case sensitive.

Example 3 Changing the Protocol

The following command changes the protocol of the `Event` MIB on cluster node `phys-cluster-2` to `SNMPv3`.

    # clsnmpmib set -n phys-cluster-2 -p version=SNMPv3 Event

If you use the `-n` option, you can alternatively use the node ID instead of the node name.

Example 4 Showing the Configuration

The following command displays the configuration information on cluster nodes `phys-cluster-1` and `phys-cluster-2`.

    # clsnmpmib show -n phys-cluster-1,phys-cluster-2
    --- SNMP MIB Configuration on myhost ---

    SNMP MIB Name:                 phys-cluster-1
      State:                         Event
      Enabled:                       yes
      Protocol:                      SNMPv3

    SNMP MIB Name:                 phys-cluster-2
      State:                         Event
      Enabled:                       yes
      Protocol:                      SNMPv3

## Attributes

See `attributes`(5) for descriptions of the following attributes:

ATTRIBUTE TYPE | ATTRIBUTE VALUE
--- | ---
Availability | ha-cluster/system/core
Interface Stability | Evolving

## Files

`/usr/cluster/lib/mib/sun-cluster-event-mib.mib`

  Oracle Solaris Cluster SNMP Event MIB definition file

## See Also

`clsnmphost`(1CL), `clsnmpuser`(1CL), `Intro`(1CL), `cluster`(1CL), `sceventmib`(1M), `scha_calls`(3HA), `attributes`(5), `rbac`(5), `clconfiguration`(5CL)

## Notes

The superuser can run all forms of this command.

All users can run this command with the `-?` (help) or `-V` (version) option.

To run the `clsnmpmib` command with other subcommands, users other than superuser require RBAC authorizations. See the following table.

Subcommand | RBAC Authorization
--- | ---
`disable` | `solaris.cluster.modify`
`enable` | `solaris.cluster.modify`
`export` | `solaris.cluster.read`
`list` | `solaris.cluster.read`
`set` | `solaris.cluster.modify`
`show` | `solaris.cluster.read`

Copyright © 2000, 2012, Oracle and/or its affiliates. All rights reserved. Legal Notices |