Man Pages

This section discusses errors, omissions, and additions in the Sun Cluster man pages.

ccp(1M)

The following revised Synopsis and added Options sections of the ccp(1M) man page document the addition of Secure Shell support to the Cluster Control Panel (CCP) utilities:

SYNOPSIS

$CLUSTER_HOME/bin/ccp [-s] [-l username] [-p ssh-port] {clustername | nodename}

OPTIONS

The following options are supported:

-l username

Specifies the user name for the ssh connection. This option is passed to the cconsole, crlogin, or cssh utility when the utility is launched from the CCP. The ctelnet utility ignores this option.

If the -l option is not specified, the user name that launched the CCP is effective.

-p ssh-port

Specifies the Secure Shell port number to use. This option is passed to the cssh utility when the utility is launched from the CCP. The cconsole, crlogin, and ctelnet utilities ignore this option.

If the -p option is not specified, the default port number 22 is used for secure connections.

-s

Specifies using Secure Shell connections to node consoles instead of telnet connections. This option is passed to the cconsole utility when the utility is launched from the CCP. The crlogin, cssh, and ctelnet utilities ignore this option.

If the -s option is not specified, the cconsole utility uses telnet connections to the consoles.

To override the -s option, deselect the Use SSH checkbox in the Options menu of the cconsole graphical user interface (GUI).

cconsole(1M), crlogin(1M), cssh(1M), and ctelnet(1M)

The following revised Synopsis and added Options sections of the combined cconsole, crlogin, cssh, and ctelnet man page document the addition of Secure Shell support to the Cluster Control Panel utilities:

SYNOPSIS

$CLUSTER_HOME/bin/cconsole [-s] [-l username] [clustername… | nodename…]
$CLUSTER_HOME/bin/crlogin [-l username] [clustername… | nodename…]
$CLUSTER_HOME/bin/cssh [-l username] [-p ssh-port] [clustername… | nodename…]
$CLUSTER_HOME/bin/ctelnet [clustername… | nodename…]

DESCRIPTION

cssh

This utility establishes Secure Shell connections directly to the cluster nodes.

OPTIONS

-l username

Specifies the ssh user name for the remote connections. This option is valid with the cconsole, crlogin, and cssh commands.

The argument value is remembered so that clusters and nodes that are specified later use the same user name when making connections.

If the -l option is not specified, the user name that launched the command is effective.

-p ssh-port

Specifies the Secure Shell port number to use. This option is valid with the cssh command.

If the -p option is not specified, the default port number 22 is used for secure connections.

-s

Specifies using Secure Shell connections instead of telnet connections to node consoles. This option is valid with the cconsole command.

If the -s option is not specified, the utility uses telnet connections to the consoles.

To override the -s option from the cconsole graphical user interface (GUI), deselect the Use SSH checkbox in the Options menu.

clnode(1CL)

• The description of the remove subcommand implies that the command will not work when certain conditions exist. Instead, the command will execute in these conditions but the results might adversely affect the cluster. The following is a more accurate description of the remove subcommand requirements and behavior:

  To remove a node from a cluster, observe the following guidelines. If you do not observe these guidelines, the removal of a node might compromise quorum in the cluster.

  • Unconfigure the node to be removed from any quorum devices, unless you also specify the -f option.

  • Ensure that the node to be removed is not an active cluster member.

  • Do not remove a node from a three-node cluster unless at least one shared quorum device is configured.

  The clnode remove command attempts to remove a subset of references to the node from the cluster configuration database. If the -f option is also specified, the subcommand attempts to remove all references to the node.

• Before you can successfully use the clnode remove command to remove a node from the cluster, you must first use the claccess add command to add the node to the cluster authentication list, if it is not already in the list. Use the claccess list or claccess show command to view the current cluster authentication list. Afterwards, for security use the claccess deny-all command to prevent further access of the cluster configuration by any cluster node. For more information, see the claccess(1CL) man page.

clresource(1CL)

• The following option is missing from the clresource(1CL) man page:

  -u

  Specifies that the command operates on resources whose resource group is suspended, if you specify the + operand. If you do not also specify the u option when you specify the + operand, the command ignores all resources whose resource group is suspended.

  The -u option is valid when the + operand is specified to the clear, disable, enable, monitor, set, and unmonitor subcommands.

• The description of the + operand should state that, when used with the clear, disable, enable, monitor, set, or unmonitor subcommand, the command ignores all resources whose resource group is suspended, unless you also specify the -u option.

• The example provided in the definitions of the + and - operands for the -p, -x, and -y options are incorrect. The definitions should be as follows:

  +

  Adds a value or values to a string array value. Only the set subcommand accepts this operator. You can specify this operator only for the properties that accept lists of string values, for example Resource_dependencies.

  –

  Deletes a value or values from a string array value. Only the set subcommand accepts this operator. You can specify this operator only for properties that accept lists of string values, for example Resource_dependencies.

clresourcegroup(1CL)

• The command syntax and description for the evacuate subcommand incorrectly states that you can evacuate more than one node or zone in the same command invocation. Instead, you can specify only one node or zone in the evacuate command

• The following option is missing from the clresourcegroup(1CL) man page:

  -u

  Specifies that the command operate on suspended resource groups, if you specify the + operand. If you do not also specify the u option when you specify the + operand, the command ignores all suspended resource groups.

  The -u option is valid when the + operand is specified to the add-node, manage, offline, online, quiesce, remaster, remove-node, restart, set, switch, and unmanage subcommands.

• The description of the + operand should state that, when used with the add-node, manage, offline, online, quiesce, remaster, remove-node, restart, set, switch, or unmanage subcommand, the command ignores all suspended resource groups, unless you also specify the -u option.

r_properties(5)

• The use of the Network_resources_used property has changed in the Sun Cluster 3.2 release. If you do not assign a value to this property, its value is updated automatically by the RGM, based on the setting of the resource-dependencies properties. You do not need to set this property directly. Instead, set the Resource_dependencies, Resource_dependencies_offline_restart, Resource_dependencies_restart, or Resource_dependencies_weakproperty.

  To maintain compatibility with earlier releases of Sun Cluster software, you can still set the value of the Network_resources_used property directly. If you do, the value of the Network_resources_used property is no longer derived from the settings of the resource-dependencies properties.

  If you add a resource name to the Network_resources_used property, the resource name is automatically added to the Resource_dependencies property as well. The only way to remove that dependency is to remove it from the Network_resources_used property. If you are not sure whether a network-resource dependency was originally added to the Resource_dependencies property or to the Network_resources_used property, remove the dependency from both properties. For example, the following command removes a dependency of resource r1 upon network resource r2, regardless of whether the dependency was added to the Network_resources_used property or to the Resource_dependencies property:

  # clresource set -p Network_resources_used-=r2 -p Resource_dependencies-=r2 r1

• The r_properties(5) man page contains incorrect descriptions of the Resource_dependencies, Resource_dependencies_offline_restart, Resource_dependencies_restart, and Resource_dependencies_weak properties. For correct descriptions of these properties, instead see Resource Properties in Sun Cluster Data Services Developer’s Guide for Solaris OS.

• The description of the Scalable resource property is missing a statement concerning support of scalable services on non-global zones. This support applies to resources for which the Failover property of the resource type is set to FALSE and the Scalable property of the resource is set to TRUE. This combination of property settings indicates a scalable service that uses a SharedAddress resource to do network load balancing. In the Sun Cluster 3.2 release, you can configure a scalable service of this type in a resource group that runs in a non-global zone. But you cannot configure a scalable service to run in multiple non-global zones on the same node.

rt_properties(5)

The description of the Failover resource-type property contains an incorrect statement concerning support of scalable services on non-global zones in the Sun Cluster 3.2 release. This applies to resources for which the Failover property of the resource type is set to FALSE and the Scalable property of the resource is set to TRUE.

Incorrect: You cannot use a scalable service of this type in zones.




Correct: You can configure a scalable service of this type in a resource group that runs in a non-global zone. But you cannot configure a scalable service to run in multiple non-global zones on the same node.

serialports(4)

The following information is an addition to the Description section of the serialport(4) man page:

To support Secure Shell connections to node consoles, specify in the /etc/serialports file the name of the console-access device and the Secure Shell port number for each node. If you use the default Secure Shell configuration on the console-access device, specify port number 22.

SUNW.Event(5)

The SUNW.Event(5) man page is missing the statement that, on the Solaris 10 OS, the Cluster Reconfiguration Notification Protocol (CRNP) runs only in the global zone.