Home | History | Annotate | Download | only in man1m
 te
CDDL HEADER START

The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.

You can obtain a copy of the license at CDDL.txt
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.

When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at CDDL.txt.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]

CDDL HEADER END
Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.
sceventmib 1M "9 Aug 2006" "Sun Cluster 3.2" "System Administration Commands"
NAME
sceventmib - manage Sun Cluster event MIB module
SYNOPSIS

sceventmib -a -c community -h host ...

sceventmib -a -t auth-type -u username [-f password-file]

sceventmib -d -s security-level -u username

sceventmib {-e | -n}

sceventmib -l protocol

sceventmib -m -t auth-type -u username

sceventmib -p {all | hosts | users}

sceventmib -r -c community -h host...

sceventmib -r -u username
DESCRIPTION

Note - Beginning with the Sun Cluster 3.2 release, Sun Cluster software includes an object-oriented command set. Although Sun Cluster software still supports the original command set, Sun Cluster procedural documentation uses only the object-oriented command set. For more information about the object-oriented command set, see the Intro(1CL) man page.

The sceventmib command enables, disables, and configures the Sun Cluster event Management Information Base (MIB) module. When you issue this command on a cluster node, it affects only the configuration of the MIB module on that node. Each cluster node MIB module runs independently of others in the cluster.

You can use this command to enable or disable the MIB module on a cluster node. You can also use this command to set configuration properties, such as the version of SNMP trap notifications or the host name for an IP address to which to send trap notifications. The Sun Cluster Event MIB sends trap notifications on port 11162. The SNMP tree is viewed on port 11161.

You can use this command only in the global zone.

OPTIONS
"Basic Options"

The following options direct the basic form and function of the command:

.na -a .ad Adds an entry for the specified SNMP host and community or for the specified user to the node configuration file. You can use this option only in the global zone.

.na -d .ad Sets the default security level and user that you want used when you specify the SNMPv3 protocol. You can use this option only in the global zone. You must specify a default user when you specify SNMPv3. SNMPv3 allows you to configure more than one user for the MIB module. Only a single default user can exist at any time. The first user that you add is automatically defined as the default user, regardless of the setting of this option. In this context, a default user is not necessarily the same as a Solaris OS user.

.na -e .ad Enables the Sun Cluster event MIB module on the node. This setting remains in effect until you change it, even after you reboot the node. You can use this option only in the global zone.

.na -l protocol .ad Sets the version of the SNMP protocol to use with the MIBs. You can use this option only in the global zone. You can specify either SNMPv2 or SNMPv3 for the protocol. You cannot specify the SNMPv3 protocol unless you have first configured at least one SNMPv3 user.

.na -m .ad Modifies the authentication type for an SNMP user. You can use this option only in the global zone.

.na -n .ad Disables the Sun Cluster event MIB module on the node. This setting remains in effect until you change it, even after you reboot the node. You can use this option only in the global zone.

.na -p {all | hosts | users} .ad Displays one of the following types of MIB configuration information:

.na all .ad All MIB module configuration information

.na hosts .ad Only the configuration information for SNMP hosts that are configured for use with the MIB module

.na users .ad Only the configuration information for SNMP users who are configured to use the MIB module You can use this option only in the global zone.

.na -r .ad Removes the entry for the specified SNMP host and community or for the specified SNMP user from the node configuration file. You can use this option only in the global zone.

"Additional Options"

You can combine additional options with the basic options to modify the default behavior of each form of the command. Refer to the SYNOPSIS section for additional details about which of these options are legal with which forms of sceventmib.

The following additional options are supported:

.na -c community .ad Specifies the name of the SNMP community that you want to add to or remove from the node configuration file.

.na -f password-file .ad Specifies the name of a password file that contains one or more SNMP user names and their corresponding passwords. Use the following syntax on every line that you include in the password-file file:

user:password
For example, specify the following lines for users Joseph Bloggs and Andrew Smith:
jbloggs:fgrxty_0
asmith:artfli!9

.na -h host .\|.\|. .ad Specifies the name of an SNMP host. You can specify either an IP address or a host name for host. You can include a host in more than one community. However, if a host with the same name in the same community already exists, an error is returned.

.na -s security-level .ad Specifies the security level of the specified SNMPv3 user. This setting determines the degree to which the user can access the SNMP MIB module. You can assign more than one security level to a user. You specify one of the following case-sensitive settings for security-level:

.na authNoPriv .ad Authentication security measure is required, but privacy security measure is not required.

.na authPriv .ad Both authentication and privacy security measures are required.

.na noAuthNoPriv .ad Authentication and privacy security measures are not required.

.na -t auth-type .ad Specifies the authentication encryption mechanism that you want to use. You can specify either MD5 or SHA for auth-type.

.na -u username .ad Specifies the name of an SNMPv3 user. If you add an entry for a user and the same user name and security level already exists, the information is overwritten. If you remove a default SNMPv3 user, the command automatically selects another default user.

EXAMPLES

Example 1 Enabling the Event MIB

The following command enables the event MIB.

# sceventmib -e

Example 2 Adding an SNMP Host to a Community

The following commands add a host to SNMP community public.

The first example specifies the host by its host name, sc-host.

# sceventmib -a -h sc-host -c public

The second example specifies the host by its IP address, 10.0.0.25.

# sceventmib -a -h 10.0.0.25 -c public

Example 3 Adding an SNMP User Without Providing a Password File

The following command adds the user jbloggs and specifies the MD5 authentication encryption mechanism. Because a password file is not specified, the command prompts the user to provide a password.

# sceventmib -a -t MD5 -u jbloggs
Enter password for user jbloggs: ********

Example 4 Adding an SNMP User and Providing a Password File

The following command adds the user jbloggs and specifies the MD5 authentication encryption mechanism and the password file pfile. Because a password file is specified, the command does not prompt the user to provide a password.

# cat pfile
jbloggs:fgrxty_0
# sceventmib -a -f pfile -t MD5 -u jbloggs 

Example 5 Displaying All SNMP Configuration Information

The following command displays all SNMP configuration information.

# sceventmib -p all 

Example 6 Displaying Only Configuration Information About SNMP Hosts

The following command displays only configuration information about SNMP hosts.

# sceventmib -p hosts 

Example 7 Setting the Version of SNMP Protocol

The following command sets the SNMP protocol version to SNMPv3.

# sceventmib -l SNMPv3 

Example 8 Setting the Default SNMP User

The following command sets the default SNMP user to the user jbloggs, with authentication and privacy security measures required.

# sceventmib -d -s authPriv -u jbloggs

Example 9 Modifying the Authentication Type of a User

The following command changes the authentication type of user jbloggs to SHA.

# sceventmib -m -t SHA -u jbloggs

Example 10 Removing an SNMP Host

The following command removes the SNMP host with IP address 10.0.0.25 in community public.

# sceventmib -r -c public -h 10.0.0.25 

Example 11 Removing an SNMP User

The following command removes SNMP user jbloggs.

# sceventmib -r -u jbloggs 
EXIT STATUS

This command returns the following exit status codes:

.na 0 .ad The command completed successfully.

.na nonzero .ad An error occurred.

ATTRIBUTES

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

ATTRIBUTE TYPEATTRIBUTE VALUE
AvailabilitySUNWsczu
Interface StabilityEvolving
FILES

.na /usr/cluster/lib/mib/sun-cluster-event-mib.mib .ad Sun Cluster SNMP Event MIB definition file

SEE ALSO

Intro(1CL), clsnmphost(1CL), clsnmpmib(1CL), clsnmpuser(1CL), attributes(5)

Sun Cluster 3.2 System Administration Guide