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.
scprivipadm 1M "23 Jun 2006" "Sun Cluster 3.2" "System Administration Commands"
NAME
scprivipadm - administer the private IP address range
SYNOPSIS

scprivipadm -c netaddr=netaddr[,netmask=netmask]

scprivipadm -c netaddr=netaddr[,maxnodes=nodes,maxprivatenets=privnets]

scprivipadm -c netaddr=netaddr[,netmask=netmask,maxnodes=nodes,maxprivatenets=privnets]

scprivipadm -p

scprivipadm -R
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 scprivipadm command modifies the current IP address range that is assigned to the Sun Cluster private interconnect.

All nodes in the cluster must be in noncluster mode before you run any form of this command. Run this command from one node in the cluster.

The scprivipadm command takes as input the private network address. Optionally, the command also takes one or both of the following:

The netmask

The maximum number of nodes and the maximum number of private networks that are ever expected to be in the cluster

The command then performs the IP address assignment for the physical adapters and the per-node IP addresses.

You can use this command only in the global zone.

OPTIONS

The following options are supported:

.na -c .ad Modifies the IP address range that is currently assigned to the cluster. Run the -c option on each node of the cluster. You can use this option only in the global zone. The -c option supports the following suboptions:

.na netaddr=netaddr .ad Specifies the private network address

.na netmask=netmask .ad Specifies the netmask

.na maxnodes=nodes .ad Specifies the maximum expected number of nodes in the cluster

.na maxprivatenets=privnets .ad Specifies the maximum expected number of private networks in the cluster The -c option performs the following tasks for each combination of suboptions:

If you specify the netaddr suboption alone, the command assigns the default netmask, 255.255.248.0, to the private interconnect. The default IP address range accommodates a maximum of 64 nodes and 10 private networks.

If you also specify the netmask suboption, the value that you specify must be equal to or greater than the default netmask. If the specified netmask is less than the default netmask, the command fails and exits with an error. If the specified netmask is equal to or greater than the default netmask, the command assigns the specified netmask to the private interconnect. The resulting IP address range can accommodate a maximum of 64 nodes and 10 private networks. To assign a smaller IP address range than the default, specify the maxnodes and maxprivatenets suboptions.

If you also specify the maxnodes and maxprivatenets suboptions, the command calculates the minimum netmask to support the specified number of nodes and private networks. The command then assigns the calculated netmask to the private interconnect. The maximum value for nodes is 64 and the minimum value is 2. The maximum value for privnets is 128 and the minimum value is 2.

If you also specify the netmask suboption as well as the maxnodes and maxprivatenets suboptions, the command calculates the minimum netmask that supports the specified number of nodes and private networks. The command compares that calculation to the specified netmask. If the specified netmask is less than the calculated netmask, the command fails and exits with an error. If the specified netmask is equal to or greater than the calculated netmask, the command assigns the specified netmask to the private interconnect. The maximum value for nodes is 64 and the minimum value is 2. The maximum value for privnets is 128 and the minimum value is 2. If the -c option fails, you must run the -R option on each node to repair the configuration before you rerun the -c option. Users other than superuser require solaris.cluster.modify Role-Based Access Control (RBAC) authorization to use this subcommand. See the rbac(5) man page.

.na -R .ad Repairs the cluster configuration. Use this option if the command fails while modifying the IP address range on the cluster nodes and the failure results in inconsistent cluster configuration on the nodes. You can use this option only in the global zone. Run the -R option on each node of the cluster. The -R option repairs the cluster configuration and removes any inconsistencies that were caused by a failure to modify the IP address range on all nodes. If you attempt to rerun the -c option without first running the -R option, the configuration change might again fail. Users other than superuser require solaris.cluster.modify Role-Based Access Control (RBAC) authorization to use this subcommand. See the rbac(5) man page.

.na -p .ad Displays the current private network address that is assigned to the private interconnect. Run the -p option from any node. You can use this option only in the global zone. The -p option prints the following information:

The private network address

The IP address range in the form of a netmask

The maximum number of nodes and the maximum number of private networks that can be supported by the IP address range Users other than superuser require solaris.cluster.read Role-Based Access Control (RBAC) authorization to use this subcommand. See the rbac(5) man page. To display the current private network address from a node that is in cluster mode, instead run the scconf -p command or the cluster show-netprops command.

EXAMPLES

Example 1 Calculating a Custom Private IP Address Range

The following command specifies the private network address 172.16.0.0 and calculates the netmask. The command specifies that the calculated netmask must support up to sixteen nodes and up to four private networks in the cluster.

# scprivipadm -c netaddr=172.16.0.0,maxnodes=16,maxprivatenets=4

Example 2 Specifying a Private Network Address and Netmask

The following command specifies the private network address 172.16.0.0 and the netmask 255.255.248.0.

# scprivipadm -c netaddr=172.16.0.0,netmask=255.255.248.0
EXIT STATUS

The scprivipadm command returns with a non-zero value if either of the following conditions occur:

Invalid arguments were provided.

The command was unable to successfully modify the IP address range on all nodes of the cluster.

ATTRIBUTES

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

ATTRIBUTE TYPEATTRIBUTE VALUE
AvailabilitySUNWscu
Interface StabilityEvolving
SEE ALSO

Intro(1CL), cluster(1CL), scconf(1M), scinstall(1M), netmasks(4), networks(4), rbac(5)

Sun Cluster Software Installation Guide for Solaris OS, Sun Cluster System Administration Guide, System Administration Guide: IP Services

NOTES

The superuser can run all forms of this command. Users other than superuser require RBAC authorizations. See the following table.

OptionRBAC Authorization
-csolaris.cluster.modify
-Rsolaris.cluster.modify
-psolaris.cluster.read