NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXAMPLES | EXIT STATUS | FILES | ATTRIBUTES | SEE ALSO
The scinstall utility performs a number of Sun Cluster node initialization, installation, and upgrade tasks, as follows.
The install form (-i) of scinstall installs and initializes a node as a new Sun Cluster member. It either establishes the first node in a new cluster (-F) or adds a node to an already-existing cluster (-N).
This form of the scinstall utility must always be run from the node that is being installed or added to the cluster.
The set up install server form (-a) of scinstall creates an install-dir on any Solaris machine from which the command is run and then copies a Sun Cluster CD-ROM to that directory. Typically, you would create the target directory on an NFS server which has also been set up as a Solaris install server (see setup_install_server(1M)).
The add install client form (-c) of scinstall establishes the given nodename as a custom JumpStart client in the jumpstart-dir on the machine from which the command is run. Typically, the jumpstart-dir is located on an already-established Solaris install server configured to JumpStart the Solaris nodename install client (see add_install_client(1M)).
The remove form (-r) of scinstall removes cluster configuration information and uninstalls Sun Cluster software from a cluster node.
The upgrade form (-u) of scinstall, which has several modes and options, upgrades a Sun Cluster node. This form of the scinstall command must always be run from the node being upgraded.
The print release form (-p) of scinstall prints release and package versioning information for the Sun Cluster software installed on the node from which the command is run.
Without options, scinstall attempts to run in interactive mode.
All forms of the command other than the print release form (-p) must be run as superuser.
scinstall is located in the Tools directory on the Sun Cluster CD-ROM. If the Sun Cluster CD-ROM has been copied to a local disk, cdrom-mnt-pt is the path to the copied Sun Cluster CD-ROM image. The SUNWscu software package also includes a copy of scinstall.
The following options direct the basic form and function of the command.
None of the following options can be combined on the same command line.
Specify the set up install server form of the scinstall command. It is used to create an install-dir on any Solaris machine from which the command is run and then copy a Sun Cluster CD-ROM to that directory.
If the install-dir already exists, scinstall returns an error message. Typically, the target directory is created on an NFS server which has also been set up as a Solaris install server (see setup_install_server(1M)).
Specify the add install client form of the scinstall command. This establishes the given nodename as a custom JumpStart client in the jumpstart-dir on the machine from which the command is run.
Typically, the jumpstart-dir is located on an already-established Solaris install server configured to JumpStart the nodename install client (see add_install_client(1M)).
This form of the command enables fully-automated cluster installation from a JumpStart server by helping to establish each cluster node, or nodename, as a custom JumpStart client on an already-established Solaris JumpStart server. The command makes all necessary updates to the rules file in the given jumpstart-dir. And, if not already installed, special JumpStart class files and finish scripts supporting cluster initialization are added to the jumpstart-dir. Configuration data used by the Sun Cluster-supplied finish script is established for each node set up using this method.
Users can customize the Solaris class file installed by using the -c option to scinstall by editing it directly in the normal way. However, it is always important to ensure that the Solaris class file defines an acceptable Solaris installation for a Sun Cluster node. Otherwise, the installation might need to be restarted.
Both the class file and finish script installed by this form of the command are located in the following directory:
jumpstart-dir/autoscinstall.d/3.1 |
The class file is installed as autoscinstall.class, and the finish script is installed as autoscinstall.finish.
For each cluster nodename set up with the -c option as an automated Sun Cluster JumpStart install client, a configuration directory is set up as the following:
jumpstart-dir/autoscinstall.d/nodes/nodename |
Options for specifying Sun Cluster node installation and initialization are saved in files located in these directories. These files should never be edited directly.
You can customize the JumpStart configuration in the following ways.
A user-written finish script can be added as the file name:
jumpstart-dir/autoscinstall.d/nodes/nodename/finish |
User-written finish scripts are run after the finish script supplied with the product.
If the directory
jumpstart-dir/autoscinstall.d/nodes/nodename/archive |
exists, all files in that directory are copied to the new installation. In addition, if an etc/inet/hosts file exists in that directory, the hosts information found in that file is used to supply name-to-address mappings when a name service (NIS/NIS+/DNS) is not used.
If the directory
jumpstart-dir/autoscinstall.d/nodes/nodename/patches |
exists, all files in that directory are installed by the patchadd(1M) command. This directory is intended for Solaris software patches and any other patches that must be installed before Sun Cluster software is installed.
You can create these files and directories individually or as links to other files or directories created under jumpstart-dir.
See add_install_client(1M)) and related JumpStart documentation for more information on setting up custom JumpStart install clients.
This form of the command should be run from the install-dir (see the -a form of scinstall) on the JumpStart server used for initializing the cluster nodes.
Before using scinstall to set up a node as a custom Sun Cluster JumpStart client, each node must also first be established as a Solaris install client. The JumpStart directory used with the -c option to add_install_client(1M) should be the same as that used with the -c option to scinstall. However, the scinstall jumpstart-dir does not have a server component to it, since scinstall must be run from a Solaris JumpStart server.
Removing a node as a custom Sun Cluster JumpStart client simply involves removing it from the rules file.
Specify the install form of the scinstallcommand. It can both install Sun Cluster software and initialize a node as a new cluster member. The new node is the node from which scinstall is run.
If the -F option is used with -i, scinstall will establish the node as the first node in a new cluster.
If the -N option is used with -i, scinstall will add the node to an already-existing cluster.
If the -s option is given and the node is an already-established cluster member, only the indicated srvc (data service) is installed.
Print release and package versioning information for the Sun Cluster software installed on the node from which the command is run. This is the only form of scinstall which can be run as a non-root user.
Remove cluster configuration information and uninstall Sun Cluster software from a cluster node. You can then reinstall the node or remove the node from the cluster. You must run the command on the node that you uninstall, from a directory that is not used by the cluster software, and the node must be in non-cluster mode.
Upgrade Sun Cluster software on the node executing the scinstall command. The upgrade form of scinstall will have several different modes of operation, depending upon the releases involved, as specified by upgrade-mode. See Upgrade Options below for information specific to the type of upgrade that you intend to perform.
Additional options can be combined with the basic options to modify the default behavior of each form of the command. Refer to the SYNOPSIS section for additional details on which of these options are legal with which forms of scinstall .
These following additional options are supported:
This option is only legal with the install (-i) form of the command.
If this option is given, no attempt is made to install the Sun Cluster software packages. Without this option, the default is to install any cluster packages which are not already installed.
This option is legal with all forms of the command other than the interactive and print release (-p) forms.
This option is used to specify an alternate directory location for finding the CD-ROM images of the Sun Cluster product and unbundled Sun Cluster data services. If this option is not specified, the default is the parent of the product directory (that is, /SunCluster_3.1) from under which the current instance of scinstall was started.
The -F option can only be used with the install (-i), upgrade (-u), or add install client (-c) forms of the command.
The -F option is only used to establish the first node in the cluster. The installation of secondary nodes will block until the first node is fully installed, instantiated as a cluster member, and prepared to perform all necessary tasks associated with adding new cluster nodes.
This option is used with the add install client (-c) form of the command. The nodename is the name of the cluster node (that is, JumpStart install client) to set up for custom JumpStart installation.
The -N option can only be used with the install (-i), add install client (-c), remove (-r), or upgrade (-u) forms of the command.
When used with the -i, -c, or -u option, the -N option is used to add additional nodes to an existing 3.1 cluster. The given cluster-member is typically the name of the first cluster node established for the cluster. However, it can be the name of any cluster node already participating as a cluster member. The node being initialized is added to the cluster of which cluster-member is already an active member. The process of adding a new node to an existing cluster involves updating the configuration data on the given cluster-member, as well as creating a copy of the configuration database onto the local file system of the new node.
When used with the -r option, the -N option specifies the cluster-member, which can be any other node in the cluster that is an active cluster member. scinstall contacts the specified cluster-member to make updates to the cluster configuration. If the -N option is not given, scinstall makes a best attempt to find an existing node to contact.
This option can only be used with the install (-i), upgrade (-u), or add install client (-c) forms of the command to install or upgrade given srvc (data service package).
If a data service package cannot be located, a warning message is printed, but installation otherwise continues to completion.
This option can only be used with the print release (-p) form of the command to specify verbose mode. In the verbose mode of print release, the version string for each installed Sun Cluster software package is also printed.
The config-options which can be used with the -F option or -N cluster-member option are as follows.
cdrom-mnt-pt/SunCluster_3.1/Sol_release/Tools/scinstall [ -i | -c jumpstart-dir -h nodename ] [ -F [ -C clustername ] [ -G {special | mount-point} ] [ -T authentication-options ] [ -A adapter-options ] [ -B junction-options ] [ –m endpoint=[this-node]:name[@port],endpoint= \ [node:]name[@port] ] [-w netaddr-options ] ] [-N cluster-member [ -C clustername ] [ -G {special | mount-point} ] [ -A adapter-options ] [ -B junction-options ] [ -m endpoint=[this-node]:name[@port],endpoint= \ [node:]name[@port] ] ] |
This option is only legal when the -F or -N option is also given.
It is used to specify the name of the cluster. If this is the first node in a new cluster, the default clustername is the same as the name of the node being installed (or when upgrading, if it exists, the current cluster's clustername will be used as the default clustername). If this is a node being added to an already-existing cluster, the default clustername is the name of the cluster to which cluster-member already belongs.
It is an error to specify a clustername which is not the name of the cluster to which cluster-member belongs.
This option is only legal when the -F, -N, or -r option is also given.
When used with the -F or -N option, the -G option specifies the raw special disk device or the file system to use. Each cluster node must have a local file system mounted globally on /global/.devices/node@nodeID before the node can successfully participate as a cluster member. However, since the node ID is not known until scinstall(1M) is run, scinstall(1M) attempts to add the necessary entry to the vfstab(4) file when it does not find a /global/.devices/node@nodeID mount.
By default, scinstall(1M) looks for an empty file system mounted on /globaldevices. If such a file system is provided, scinstall(1M) makes the necessary changes to the vfstab(4) file. These changes create a new /global/.devices/node@nodeID mount point and remove the default /globaldevices mount point. However, if /global/.devices/node@nodeID is not mounted and an empty /globaldevices file system is not provided, the -G option must be given to specify the raw special disk device or the file system mount-point to use in place of /globaldevices.
If a raw special disk device name is given and /global/.devices/node@nodeID is not mounted, a file system is created on the device using newfs(1M). It is an error to supply the name of a device with an already-mounted file system.
As a guideline, this file system should be at least 100 Mbytes in size. If this partition or file system is not available, or is not large enough, it might be necessary to re-install the Solaris operating environment.
When used with the -r option, the -G mount-point option specifies the new mount-point name to use to restore the former /global/.devices mount point. If the -G option is not specified, the mount point is renamed /globaldevices by default.
This option is only legal when the -F option is also given.
This option is used to 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, a check is made to determine whether or not the node has permission to join; if the joining node has permission, it is authenticated.
The -T option can only be used with scinstall when setting up the very first node in the cluster. If the authentication list or policy needs to be changed on an already-established cluster, scconf(1M) can be used.
The default is to allow any machine to add itself to the cluster.
The -T authentication-options are as follows.
-T node=nodename[,...][,authtype=authtype] |
At least one node suboption is required when -T is given. It is used to add host names to 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 can 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. This list of nodes can be modified or cleared at any time by using the scconf(1M) command from one of the active cluster nodes.
The only currently-supported authtypes are des and sys (or, unix). If no authtype is given, sys is the default.
When Diffie-Hellman, or des, authentication is used, entries should be added to the publickey(4) database for each cluster node to be added before actually running scinstall(1M).
The authentication type can be changed at any time by using the scconf(1M) command from one of the active cluster nodes.
This option is only legal when the -F or -N option is also given. Each occurrence of the -A option is used to configure a cluster transport adapter attached to the node from which scinstall is run.
If no -A options are given, an attempt is made to use a default adapter and transport type. The default transport type is dlpi. In Sun Cluster 3.1 for SPARC, the default adapter is hme1.
When the transport type is dlpi, it is not necessary to use the trtype suboption. And so, either of the two following forms can be used for specifying the -A adapter-options.
–A [trtype=type,]name=adaptername[,other-options] -A adaptername |
The trtype option can be used with each occurrence of -A and is used to specify a transport type for the adapter. Examples of transport types are rsm and dlpi (see sctransp_rsm(7P) and sctransp_dlpi(7P)).
The default transport type is dlpi.
An adaptername option must be given with each occurrence of -A. An adaptername is constructed from a device name, immediately followed by a physical-unit number (for instance, hme).
If no other suboptions are needed with -A, the adaptername can be given as a standalone argument to -A (that is, -A adaptername).
When other options are available for a particular adapter type, they can be used with -A. Refer to the individual cluster transport adapter man pages (for instance, scconf_transp_adap_hme(1M), scconf_transp_adap_eri(1M), and scconf_transp_adap_qfe(1M)) for information on special options which might be used with them.
This option is only legal when the -F or -N option is also given. Each occurrence of the -B option is used to configure a cluster transport junction. Examples of such devices can include, but are not limited to, Ethernet hubs, other switches of various types, and rings.
If no -B options are given, an attempt is made add a default junction at the time that the first node is instantiated as a cluster node. When additional nodes are added to the cluster, additional junctions are not added by default; however, they can be added explicitly. The default junction is named hub1, and it is of type switch.
When the junction type is type switch, it is not necessary to use the type suboption. And so, either of the two following forms can be used for specifying the -B junction-options.
-B [type=type,]name=name[,other-options] -B name |
If a cluster transport junction is already configured for the given name, a message is printed and the -B option is ignored.
In the case of directly-cabled transport adapters, it might not be necessary to configure any junctions whatsoever. To avoid configuring default junctions, the following special -B option can be given.
-B type=direct |
The type option can be used with each occurrence of -B and is used to specify a junction type. Ethernet hubs and SCI switches are examples of cluster transport junctions which are both type switch (see scconf_transp_jct_dolphinswitch(1M) and scconf_transp_jct_etherswitch(1M)).
The type can also be set to direct, in order to suppress the configuration of any default junctions. Junctions do not exist in a transport configuration made up of only directly-connected transport adapters. So, when type is set to direct, it is not necessary to include a name suboption.
Unless the type is direct, a name must be always be given with each occurrence of the -B option, in order to specify the name of a cluster transport junction. The name can be up to 256 characters in length and 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.
If no other suboptions are needed with -B, the junction name can be given as a standalone argument to -B (that is, -B name).
When other options are available for a particular junction type, they can be used with -B. Refer to the individual cluster transport junction man pages (for instance, scconf_transp_jct_etherswitch(1M)) and scconf_transp_adap_sci(1M) for information on any special options which might be used with them.
This option is only legal when the -F or -N option is also given.
The -m option helps 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 configured with scinstall(1M) establishes a connection from a cluster transport adapter on the current node to either a port on a cluster transport junction or an adapter on another node already in the cluster.
If no -m options are given, an attempt is made to configure a default cable. However, if more than one transport adapter or junction is configured with a given instance of scinstall(1M), it is not possible to construct a default. The default is to configure a cable from the singly-configured transport adapter to the singly-configured (or default) transport junction.
The -m cable-options are as follows.
–m endpoint=[this-node]:name[@port],endpoint= \ [node:]name[@port] |
Two endpoint options must always be given with each occurrence of the -m option. The name component of the option argument is used to specify the name of either a cluster transport adapter or a 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. The default port name for a junction endpoint is equal to the node ID of the node being added to the cluster. Refer to the individual cluster transport adapter and cluster transport junction man pages for more information regarding port assignments and other requirements (for instance, 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/or junctions at each of the two endpoints of the cable must also be configured (see -A and -B).
The first line in the synopsis given at the beginning of this subsection attempts to express that at least one of the two endpoints must be an adapter on the node being installed. And so, it is not necessary to include this-node explicitly. An example of adding a cable from scinstall(1M) follows.
-m endpoint=:hme1,endpoint=hub1 |
In this example, port 0 of the hme1 transport adapter on this node (the node which is being installed by scinstall(1M)) is cabled to a port on transport junction 4hub1; the port used on hub1 defaults to the node number of this node.
This option is only legal when the -F option is also given.
It is used to specify a private network address (networks(4)) and, optionally, netmasks(4)) for use on the private network. It should only be necessary to use this option when the default private network address collides with an address already in use within the enterprise. The default network address is 172.16.0.0, with a default netmask of 255.255.0.0.
The -w netaddr-options are as follows:
–w netaddr=netaddr[,netmask=netmask] |
The default netaddr for the private interconnect, or cluster transport, is 172.16.0.0. The last two octets of this address must always be zero.
The default netmask for the private interconnect is 255.255.0.0. The last two octets of the netmask must always be zero, and there cannot be any holes in the mask.
The -u upgrade-mode and the upgrade-options are as follows.
The -u update is used to upgrade a cluster node to a later Sun Cluster software release.
The upgrade-options to -u update are as follows.
cdrom-mnt-pt/SunCluster_3.1/Sol_release/Tools/scinstall -u update [ -s { srvc[,...] | all } [ -d cdimage-dir ] [ -O ] [ -S { interact | testaddr=testipaddr@adapter[,testaddr=...]} ]
If the -s option is not specified, only cluster framework software is upgraded. If the -s option is specified, only the specified data services are upgraded.
The following suboption to the -s option is specific to the update mode of upgrade:
This suboption to -s is only legal with the update mode.
This suboption upgrades all data services currently installed on the node, except those data services for which an update version does not exist in the update release.
The -s option is not compatible with the -S test address option.
This option overrides the hardware validation.
This option allows the user either to direct the command to prompt the user for the required IP Network Multipathing (IPMP) addresses or to supply a set of IPMP test addresses on the command line for the conversion of NAFO to IPMP groups. See “IP Network Multipathing (Overview)” in System Administration Guide: IP Services for additional information on IP Network Multipathing.
It is illegal to combine both the interact and the testaddr forms on the same command line.
The -S option is only required when one or more of the NAFO adapters in pnmconfig is not already converted to use IPMP.
The suboptions of the -S option are:
Prompts the user to supply one or more IP Network Multipathing test addresses individually.
Allows the user to specify one or more IP Network Multipathing test addresses without being prompted for the list.
The IP address or hostname (in /etc/inet/hosts) that will be assigned as routable, no-failover and deprecated test address to the adapter. IP Network Multipathing uses test addresses to detect failures and repairs. See “Administering Multipathing Groups With Multiple Physical Interfaces” in System Administration Guide: IP Services for additional information on configuring test addresses.
The name of the NAFO network adapter to be added to an IP Network Multipathing group.
The following sequence of commands installs and initializes a typical two-node cluster. Insert the Framework CD-ROM and issue the following commands:
node1# cd /cdrom/cdrom0/SunCluster_3.1/Sol_8/Tools node1# ./scinstall -i -F node2# cd /cdrom/cdrom0/SunCluster_3.1/Sol_8/Tools node2# ./scinstall -i -N node1 |
The following sequence of commands arranges to set up a Solaris install server to install and initialize a three-node SCI cluster. Insert the Framework CD-ROM and issue the following commands:
installserver# cd /cdrom/cdrom0/SunCluster_3.1/Sol_9/Tools installserver# ./scinstall -a /export/sc3.1 installserver# cd /export/sc3.1/SunCluster_3.1/Sol_9/Tools installserver# ./scinstall –c /export/jumpstart \ -h node1 -F -A hme2 installserver# ./scinstall –c /export/jumpstart \ -h node2 -N node1 -A hme2 installserver# ./scinstall –c /export/jumpstart \ -h node3 -N node1 -A hme2 |
The following sequence of commands upgrades the framework and data service software of a cluster to the next Sun Cluster release.
Do the following on each cluster node.
Insert the Framework CD-ROM and issue the following commands:
ok> boot -x # cd /cdrom/cdrom0/SunCluster_3.1/Sol_9/Tools # ./scinstall -u update -S interact # cd / # eject /cdrom/cdrom0 |
Insert the Data Services CD-ROM and issue the following commands:
# /usr/cluster/bin/scinstall -u update -s all \ -d /cdrom/cdrom0 # reboot |
The following sequence of commands places the node in non-cluster mode, then removes Sun Cluster software and configuration information from the cluster node and renames the global devices mount point to the default name /globaldevices and performs cleanup:
ok> boot -x node4# cd / node4# /usr/cluster/bin/scinstall -r |
See attributes(5) for descriptions of the following attributes:
ATTRIBUTE TYPE |
ATTRIBUTE VALUE |
---|---|
Availability |
Solaris CD-ROM, SUNWscu |
newfs(1M), setup_install_server(1M), add_install_client(1M), patchadd(1M), sccheck(1M), scconf(1M), scconf_transp_adap_ge(1M), scconf_transp_adap_hme(1M), scconf_transp_adap_eri(1M), scconf_transp_adap_qfe(1M), scconf_transp_adap_sci(1M), scconf_transp_jct_etherswitch(1M), scconf_transp_jct_dolphinswitch(1M), scconf_transp_adap_sci(1M), clustertoc(4), netmasks(4), networks(4), packagetoc(4), order(4), attributes(5), sctransp_rsm(7P), sctransp_dlpi(7P)
Sun Cluster 3.1 Software Installation Guide
NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXAMPLES | EXIT STATUS | FILES | ATTRIBUTES | SEE ALSO