NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXAMPLES | EXIT STATUS | ATTRIBUTES | SEE ALSO | NOTES
The scconf utility manages the Sun Cluster software configuration. You can use scconf to add items to the configuration, to change properties of already configured items, and to remove items from the configuration. scconf can also print a listing of the current configuration.
scconf can only be run from an active cluster node. As long as the node is active in the cluster, it makes no difference which node is used to run the command. The results of running the command should always be the same, regardless of the node used.
Any form of the command which would result in an update to the configuration must be run as root. Non-root users may only use scconf to list the configuration or print help information.
All forms of the scconf command accept the -H option. Specifying the -H displays help information and all other options are ignored. Help information is also printed when scconf is invoked without options.
For each of the three forms of the command designed to update the configuration, options are processed in the order in which they are given on the command line. All updates associated with each option must complete successfully before the next option is considered.
The following option is common to all forms of the scconf command:
If this option is given anywhere on the command line, help information is printed and all other options are ignored. Help information is also printed if scconf is invoked with no options.
The following options direct the basic form and function of the scconfcommand. None of these options can be combined on the same command line.
Specify the add form of the scconf command. It can be used to add or initialize most of the items used to define the software configuration of a Sun Cluster. Additional options are used with -a to specify items to be added and their associated propterties. Any number of these additional options may be combined on the same command line, as long as they are all intended for use with the -a option.
Specify the change form of the scconfcommand. It is used to change properties of items already configured as part of the Sun Cluster software configuration. Additional options are used with -c to specify the new properties or changes. Any number of these additional options may be combined on the same command line, as long as they are all intended for use with the -c option.
Specify the remove form of the scconf command. It is used to remove items from the Sun Cluster software configuration.
Additonal options are used with -r to specify which items to delete from the configuration. Any number of these additional options may be combined on the same command line, as long as they are all intended for use with the -r option.
Specify the print form of the scconf command. This form of the command prints a listing of the current Sun Cluster configuration, items configurable through scconf and their properties. This option may be combined with one or more -v options to print more verbose listings.
The following options are additional options which can be combined with one or more of the basic options described above. Refer to the SYNOPSIS section for additional detail on which of these options are legal with which forms of scconf.
The additional options are as follows:
Add, remove, or change the properties of a cluster transport adapter. The node on which the given adapter is hosted need not be active in the cluster in order for these operations to succeed. The -A adapter_options for each of the three forms of the command which accept -A are as follows:
Use the following to specify -A adapter_options for the add form of the command:
–A trtype=type,name=name,node=node[,other_options] |
Use the following to specify -A adapter_options for the change form of the command:
–A name=name,node=node[,state=state][,other_options] |
Use the following to specify -A adapter_options for the remove form of the command:
–A name=name,node=node |
The -A option supports the following suboptions:
Specify transport type. This suboption must always be included when -A is used with the add form of the command.
Examples of transport types are rsm and dlpi. See sctransp_rsm(7P) and sctransp_dlpi(7P).
Specify the name of an adapter on a particular node. This suboption must be included with each occurrence of the -A option.
adaptername is constructed from a device name, immediately followed by a physical-unit number (for example., hme0).
Specify the name of an adapter on a particular node. A node option is required for each occurrence of the -A option.
The node may be given either as a node name or node ID.
Change the state or adapter. You can use this suboption with the change form of the command. The state can be set to either enabled or disabled.
When an adapter is added to the configuration, it's state is always set to disabled. By default, adding a cable (see -m) to any of the ports on an adapter changes the state of both the port and the adapter to enabled. See -m.
Disabling an adapter also has the effect of disabling all ports associated with that adapter. However, enabling an adapter does not result in the enabling of it's ports. To enable an adapter port, it is necessary to enable the cable to which the port is connected.
If other options are available for a particular adapter type, they may be used with -A in the add and change forms of the command. Refer to the individual cluster transport adapter man pages (for example, scconf_transp_adap_hme(1M), scconf_transp_adap_eri(1M), and scconf_transp_adap_sci(1M)) for information on special options.
Add, remove, or change the properties of a cluster transport junction.
Examples of such devices can include, but are not limited to, ethernet hubs, other switches of various types, and rings.
Use the following to specify -B junction_options for the add form of the command:
–B type=type,name=name[,other_options] |
Use the following to specify -B junction_options for the change form of the command:
–B name=name[,state=state][,other_options] |
Use the following to specify -B junction_options for the remove form of the command:
–B name=name |
The -B option supports the following suboptions:
Specify a cluster transport junction type. This suboption must always be included when -B is used with the add form of the command.
The suboption is used to s Ethernet hubs and SCI switches are examples of cluster transport junctions which are both of type switch. See scconf_transp_jct_dolphinswitch(1M) and scconf_transp_jct_etherswitch(1M).
Specify the name of a cluster transport junction. A name suboption must always be included with each occurrence of the -B option.
name can be up to 256 characters in length. It is made up of either letters or digits, with the first character being a letter. Each transport junction name must be unique across the namespace of the cluster.
Change the state of a cluster transport junction. This suboption can be used with a -B change command. state can be set to either enabled or disabled.
When a junction is added to the configuration, its state is always set to disabled. By default, adding a cable to any of the ports on a junction changes the state of both the port and the junction to enabled. See -m.
Disabling a junction also has the effect of disabling all ports associated with that junction. However, enabling a junction does not result in the enabling of it's ports. To enable a junction port, it is necessary to enable the cable to which the port is connected.
When other options are available for a particular junction type, they can be used with the -B option and the add and change forms of the command.
Refer to the individual cluster transport junction man pages (for example., scconf_transp_jct_dolphinswitch(1M), and scconf_transp_jct_etherswitch(1M)) for information on special options.
Change the name of the cluster itself. This option can only be used with the change form of the command. It is used to change the name of the cluster itself.
Specify cluster_options for the change form of the command as follows:
-C cluster=clustername cluster=clustername |
This changes the name of the cluster to clustername.
Add disk device groups to the configuration, to change or reset properties of already existing device groups, and to remove groups from the Sun Cluster device groups configuration. Other disk device group options (otheroptions) play a crucial role in adding or changing device groups and their options. Pay special attention to the type dependent disk device groups options man pages (for example, scconf_dg_vxvm(1M), scconf_dg_sds(1M), scconf_dg_svm(1M), and scconf_dg_rawdisk(1M)) when configuring any device group. Not all device group types support all three forms of the -D option. For example, sds device groups can normally only be used with the change form of the command to change certain attributes, such as the ordering of the node preference list.
The add form of the command can be used to either create new device groups or to add nodes to already existing device groups. For some device group types, it may also be used to add devices to a group. The change form of the command registers updates to change certain attributes associated with a group. The remove form of the command is used to either remove an entire device group or one or more of a group's components.
The -D devicegroups_options for each of the three forms of the scconf command which accept -D are as follows:
add: –D type=type,name=name[,nodelist=node[:node]...] [,preferenced={true | false}] [,numsecondaries=integer] [,failback={enabled | disabled}][,otheroptions] change: –D name=name[,nodelist=node[:node]...] [,preferenced={true | false}] [,numsecondaries=integer] [,failback={enabled | disabled}][,otheroptions] remove: –D name=name[,nodelist=node[:node]...] |
The type option must be used with the add form of the command to indicate which type of disk device group to create (for example, vxvm, sds, svm, or rawdisk).
The name of the disk device group must be supplied with all three forms of the command.
For some disk device group types, a list of potential primary nodes for the device group is required when adding a group to the cluster. Refer to the type dependent disk device group man pages for more information.
With the add form of the command, the nodelist is, by default, an ordered list indicating the preferred order in which nodes should attempt to take over as primary for a disk device group. However, if preferenced is set to false, the first node to access a device in the group automatically becomes primary for that group. It is not legal to use the preferenced option when adding nodes to an already existing device group. However, it may be given when creating the group for the first time, or with the change form of the command.
To change the primary order preference, you must specify the complete list of cluster nodes in the nodelist in the new order you prefer. You must also set the preferenced option to true.
When used with the remove form of the command, the nodelist option is used to remove the indicated nodes from the device group. Only by not giving a nodelist at all can the entire device group be removed. Simply removing all of the nodes from a device group does not necessarily remove that group.
As long as preferenced is not set to false, nodelists for newly created device groups describe a preferred order in which nodes will attempt to take over as primary for a disk device group.
If the preferenced suboption is not given at all with an add used to create a new device group, it is, by default, false. However, if it is not specified with a change, it is, by default set to true when nodelist is given.
It is not legal to specify preferenced with an add used to add nodes to an already established device group. In this case, the already established node preference list setting is used.
This option allows system administrators to dynamically change the desired number of secondary nodes for a device group. A device group is a HA service which requires one node to act as a primary and one or more nodes to act as secondaries. The secondary nodes of a device group are able to take over and act as primary if the current primary node fails.
This integer value should be set greater than 0 but less than the total number of nodes in the specified group. The default is 1.
A system administrator can use the numsecondaries option to change the number of secondaries for a device group while maintaining a given level of availability. If a node in a device group is removed from the secondaries list, it will not be able to take over and act as a primary until it is converted back to a secondary. Before making a change to the number of secondaries, you need to assess the impact on the secondary global filesystem.
The numsecondaries option only applies to nodes in a device group that are currently in cluster mode and can be used together with the node preference option. If a device's preferenced flag is enabled, the nodes that are least preferred will be removed from the secondaries list first. If no node in a device group are flagged as preferred, the cluster will pick the node to be removed on a random basis.
When a device group's actual number of secondaries drops to less that the desired level due to node failures, nodes that were removed from the secondaries list will be added back to the secondary list of nodes if they are currently in a cluster, belong to the device group, and are not currently a primary or secondary. The conversion starts with the node in the device group with the highest preference until the number of desired secondaries is matched.
If a node in the device group with higher preference that an existing secondary joins the cluster, the node with the least preference will be removed from the secondary list and will be replaced by the newly added node. This replacement only occurs when there are more actual secondaries than the desired level.
To set the desired number of secondaries to the system default (without having to know the default value), issue:
scconf -aD type=vxvm,name=foo,numsecondaries= |
scconf -cD name=foo,numsecondaries= |
The numsecondaries option can only be used with -a option during device group creation time. The numsecondaries can not be used with the -a option to add a host into an existing device group.
The failback behavior of a disk device group can be enabled or disabled with either the add or change forms of the command.
This option is used to specify the behavior of the system should a disk device group primary leave the cluster membership and later return.
When the node leaves the cluster membership, the disk device group will fail over to the secondary. When the failed node rejoins the cluster membership, the disk device group can either continue to be mastered by the secondary, or failback to the original primary.
If failback is enabled, the disk device group will become mastered by the original primary. If failback is disabled, the disk device group will continue to be mastered by the secondary.
By default, failback is disabled.
Other disk device group type dependent options may be available for use with either the add or change forms of the command. Refer to the appropriate man pages for more information (for example, scconf_dg_vxvm(1M), scconf_dg_sds(1M), scconf_dg_svm(1M), and scconf_dg_rawdisk(1M)).
Add or remove a node from the cluster configuration database. When used with the add form of scconf, both the the new name and an internally generated node ID are added to the cluster configuration database. In addition, the new node is given a disk reservation key and a quorum vote count of zero. The name assigned to access the node over the cluster interconnect is initialized to clusternode<nodeid>-priv. See the -p option.
scconf cannot be used by itself to add a new node to the cluster. All that this form of the command is able to do is to update the configuration database itself. It does not arrange to copy the configuration database onto the new node or to create the necessary node identifier on the new node. scinstall(1M) is the preferred command to add a node to a cluster.
When used with the remove form of scconf, all references to the node, including the last transport cable, all resource group references, and all device group references, must be removed before scconf can be used to completely remove the node from the cluster configuration.
The node to be removed must not be configured for any quorum devices. In addition, you cannot remove a node from a three node cluster unless there is at least one shared quorum device configured.
See the administration procedures in the Sun Cluster AnswerBook documentation for the complete procedure to remove a cluster node.
Specify cluster_options for the change form of the command command as follows:
You must specify the node=nodeoption with any occurrence of the -h option. For the add form of the command, the given node must be a node name.
Use the following to specify the -h node_options for the add form of the command:
–h node=nodename |
You must specify the node=nodeoption with any occurrence of the -h option.
For the remove form of the command, the node can be given either as a node name or node ID. Use the following to specify the -h node_options for the remove form of the command:
–h node=node |
Help to establish the cluster interconnect topology by configuring the cables connecting the various ports found on the cluster transport adapters and junctions. Each new cable typically maps a connection either between two cluster transport adapters or between an adapter and a port on a transport junction. The -m cable_options for each of the forms of the command which accept -m are as follows:
Use the following to specify the -m cable_options for the add form of the command:
–m endpoint=[node:]name[@port], endpoint=[node:]name[@port][,noenable] |
Use the following to specify the -m cable_options for the change form of the command:
–m endpoint=[node:]name[@port], state=state |
Use the following to specify the -m cable_options for the remove form of the command:
–m endpoint=[node:]name[@port] |
The following suboptions are supported:
An endpoint suboption must always be included with each occurrence of the -m option. For the add form of the command, two endpoint options must be specified.. The name component of the option argument is used to specify the name of either a cluster transport adapter or cluster transport junction at one of the endpoints of a cable. If a node component is given, the name is the name of a cluster transport adapter; otherwise, it is the name of a cluster transport junction.
If a port component is not given, an attempt is made to assume a default port name. The default port for an adapter is always 0; and, the default port name for a junction endpoint is equal to the node ID of the node attached to the other end of the cable. Please refer to the individual cluster transport adapter and cluster transport junction man pages for more information regarding port assignments and other requirements (e.g., scconf_transp_adap_hme(1M), scconf_transp_adap_eri(1M), scconf_transp_adap_sci(1M), scconf_transp_jct_etherswitch(1M), and scconf_transp_jct_dolphinswitch(1M)). Before a cable can be added, the adapters and junctions at each of the two endpoints of the cable must already be configured (see -A and -B).
This suboption may be used to change the state of a cable and the two end points to which it is connected. When a cable is enabled, the cable, its two ports, and the adapters or junctions associated with those two ports are all enabled. However, when a cable is disabled, only the cable and its two ports are disabled; the state of the adapters or junctions associated with the two ports remains unchanged. By default, the state of a cable, and its endpoints, is always set to enabled at the time that it is added to the configuration. But, to add a cable in the disabled state, noenable can be used as part of an add.
The noenable suboption may be used when adding a cable to the configuration. By default, adding a cable causes the cable, the two ports to which it is connected, and the the adapters or junctions on which the ports are found to all have their states set to enable. But, if noenable is given when adding a cable, the cable and its two endpoints are added in the disabled state. The state of the adapters or junctions on which the ports are found remains unchanged.
Use this option with either the add or change forms of the command to specify a hostname alias to use for IP access of a given node over the private cluster interconnect, or transport. If not otherwise assigned, or if reset, the default private hostname is clusternode<nodeid>-priv.
Private hostnames should never be stored in the hosts(4) database. A special nsswitch facility (see nsswitch.conf(4)) performs all hostname lookups for private hostnames.
Both the add and change forms of scconf behave identically with regards to -P. The -P privatehostname_options for each of the two forms of the command which accept -P are as follows:
add: –P node=node[,privatehostname=hostalias] change: –P node=node[,privatehostname=hostalias] |
This option gives the name or ID of the node to be assigned the private hostname, or host alias, supplied with the privatehostname suboption.
This option supplies the host alias to be used for accessing a node over the private cluster interconnect, or transport. If no privatehostname option is given, the private hostname for the given node is reset to the default.
Use this option for managing shared cluster quorum devices and various cluster quorum properties. The add and remove forms of the command are used to add and remove shared quorum devices to or from the configuration. The change form of the command is used for changing various cluster quorum configuration propterties or states. The -q quorum_options available for each of the three forms of the command which can be used to change the cluster quorum configuration are as follows:
add: –q globaldev=devicename[,node=node,node=node[,...]] change: –q node=node,{maintstate | reset} change: –q globaldev=devicename,{maintstate | reset} change: –q reset change: –q installmode remove: –q globaldev=devicename |
When scconf is interrupted or fails while performing quorum-related operations, quorum configuration information can become inconsistent in the cluster configuration database. If this occurs, either run the same scconf command again or run it with the reset option to reset the quorum information.
This option is used to specify the name of a global disk device to use when adding or removing a shared quorum device to or from the cluster. It can also be used with the change form of the command to change the state of a quorum device.
Each quorum device must be connected, or ported, to at least two nodes in the cluster. It is not possible to use a non-shared disk as a quorum device.
With the add form of the command, if a globaldev is given without a node list, the quorum device is added with a port defined for every node to which the device is attached. But, if a node list is given, at least two nodes must be provided. And, each node in the list must be ported to the device.
The change form of scconf can be used with -q globaldev to either put the device into a maintenance state or to reset the device's quorum configuration to the default. While in maintenance state, the device takes on a vote count of zero and, so, does not participate in forming quorum. When reset to the default, the vote count for the device is changed to N-1, where N is the number of nodes with non-zero vote counts which have ports to the device.
This option can be used with the add form of the command to select which nodes should be configured with ports to the shared quorum device being added. It can also be used with the change form of the command to change the quorum state of a node.
When the node option is used with the change form of the quorum update command, it is used to either place a node into maintenance state or to reset the node's quorum configuration to the default.
You must shut down a node before you can put it into maintenance state. scconf will return an error if you attempt to put a cluster member into maintenance state.
While in maintenance state, the node takes on a vote count of zero and, so, does not participate in quorum formation. In addition, any shared quorum devices configured with ports to the node have their vote counts adjusted down by one to reflect the new state of the node. When the node is reset to the default, it's vote count is reset to one and the shared quorum device vote counts are re-adjusted back up. Unless the cluster is in installmode, the quorum configuration for each node is automatically reset at boot time.
A node may be given either as a node name or node ID.
This option may be used as a flag with the change form of the command, for either the globaldev or node options, in order to put a shared quorum device or node into a quorum maintenance state. When in maintenance state, a shared device or node no longer participates in quorum formation. This can be useful when a node or device must be shut down for an extended period in order to perform maintenance. Once a node boots back into the cluster, it will normally remove itself from maintenance mode.
It is not legal to specify both maintstate and reset with the same -q option.
This option is used as a flag with the change form of the command in order to reset the configured quorum vote count of a shared quorum device or node. The option may be combined with either the globaldev or node options, or it may stand by itself.
If used by itself, the entire quorum configuration is reset to the default vote count settings. In addition, if installmode is set, it is cleared by a global quorum configuration reset. installmode cannot be reset on a two node cluster unless at least one shared quorum device has been successfully configured.
This option can be used to force the cluster back into installmode. While in installmode, nodes do not attempt to reset their quorum configurations at boot time. Also, while in this mode, many administrative functions are blocked. When a cluster is first installed, it is set up with installmode set. Once all of the nodes have joined the cluster for the first time, and shared quorum devices have been added to the configuration, a quorum config scconf reset command should be issued to reset the vote counts to their defaults and to clear the installmode setting.
Establish authentication policies for nodes attempting to add themselves to the cluster configuration. Specifically, when a machine requests that it be added to the cluster as a cluster node (see scinstall(1M)), a check is made to determine whether or not the node has permission to join; and, if so, the joining node is authenticated. The default is to allow any machine to add itself to the cluster (see scinstall(1M)).
The -T authentication_options for each of the three forms of the command which accept -T are as follows:
add: –T node=nodename[,...][,authtype=authtype] change: –T authtype=authtype remove: –T {node=nodename[,...] | all} |
At least one node suboption is required for the add form of the command and is optional for remove. It is used to add or remove host names from the list of nodes that are able to install and configure themselves as nodes in the cluster. If the authentication list is empty, any host may request that it be added to the cluster configuration; however, if the list has at least one name in it, all such requests are authenticated using the authentication list.
Illegal nodenames are accepted, including the node name of dot (.). The dot character is special in that if a nodename of . is added to the authentication list, all other names are removed. This prevents any host from attempting to install and configure itself into the cluster.
The list may be cleared of all node names by giving all as the argument to -T with the remove form of the command. A cleared authentication list means that any node may attempt to install and configure itself into the cluster.
The authtype suboption may be given with either the add or change forms of the command.
The only currently supported authtypes are des, and sys (or, unix). The default authentication type is sys, offering the least amount of secure authentication.
When des, or Diffie-Hellman, authentication is used, entries should be added to the publickey(4) database for each cluster node to be added before actually running scinstall(1M) to add the node.
The -v, or verbose, option can be used with the print form of the command to request a more detailed listing of the cluster configuration. If used with other options, additional information may be printed when an error is encountered.
The following commands provide an example of a typical set of post-installation setup operations which might be performed on a new two-node cluster. These commands add a shared quorum device to the cluster, clear installmode, configure a second set of cluster transport connections, and secure the cluster against other machines which might attempt to add themselves to the cluster:
phys-red# scconf -a -q globaldev=d0 phys-red# scconf -c -q reset phys-red# scconf -a \ -A trtype=dlpi,name=hme1,node=phys-red \ -A trtype=dlpi,name=hme1,node=phys-green \ -m endpoint=phys-red:hme1,endpoint=phys-green:hme1 phys-red# scconf -a -T node=.
See attributes(5) for descriptions of the following attributes:
ATTRIBUTE TYPE |
ATTRIBUTE VALUE |
---|---|
Availability |
SUNWscu |
scconf_dg_sds(1M),scconf_dg_svm(1M), scconf_dg_vxvm(1M), scconf_dg_rawdisk(1M), scconf_transp_adap_hme(1M), scconf_transp_adap_eri(1M), scconf_transp_adap_sci(1M), scconf_transp_jct_etherswitch(1M), scconf_transp_jct_dolphinswitch(1M), hosts(4), nsswitch.conf(4), publickey(4), attributes(5), sctransp_rsm(7P), sctransp_dlpi(7P)
You should either backup the root filesystem on every node after changing the configuration using scconf, or keep a log of all changes so that if you need to recover configuration changes between normal system backups, you can use the log to return to the most recent configuration.
Option lists given with scconf command are always considered in the order given on the command line. But, whenever possible, certain transport options (-A, -B, and -m) are processed by scconf as a single transaction against the cluster configuration database. It is always best to try to group all related options of this type together on a single command line, in order to reduce overhead to the cluster.
NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXAMPLES | EXIT STATUS | ATTRIBUTES | SEE ALSO | NOTES