Go to main content

Reference for Oracle Solaris Cluster 4.4

Exit Print View

Updated: August 2018
 
 

clintr (8CL)

Name

clinterconnect, clintr - manage the Oracle Solaris Cluster interconnect

Synopsis

/usr/cluster/bin/clinterconnect -V
/usr/cluster/bin/clinterconnect [subcommand] -?
/usr/cluster/bin/clinterconnect subcommand [options] -v 
     [endpoint[,endpoint] …]
/usr/cluster/bin/clinterconnect add [-d] endpoint[,endpoint] …
/usr/cluster/bin/clinterconnect add -i {- | clconfigfile} [-d] 
     [-n node[,…]] {+ | endpoint[,endpoint] …}
/usr/cluster/bin/clinterconnect disable [-n node[,…]] 
     {+ | endpoint[,endpoint] …}
/usr/cluster/bin/clinterconnect enable [-n node[,…]] 
     {+ | endpoint[,endpoint] …}
/usr/cluster/bin/clinterconnect export [-o {- | configfile}] 
     [-n node[,…]] [+ | endpoint[,endpoint] …]
/usr/cluster/bin/clinterconnect remove [-l] endpoint[,endpoint] …
/usr/cluster/bin/clinterconnect show [-n node[,…]] 
      [-Z {zone-cluster-name | global}] [+ | endpoint[,endpoint] …]
/usr/cluster/bin/clinterconnect status [-n node[,…]] 
      [-Z {zone-cluster-name | global}] [+ | endpoint[,endpoint] …]

Description

The clinterconnect command manages configuration of the cluster interconnect and displays configuration and status information. The clintr command is the short form of the clinterconnect command. The clinterconnect command and the clintr command are identical. You can use either form of the command.

The cluster interconnect consists of two endpoints which are connected with cables. An endpoint can be an adapter on a node or a switch, also called a junction. A cable can connect an adapter and a switch or connect two adapters in certain topologies. The cluster topology manager uses available cables to build end-to-end interconnect paths between nodes. The names of cluster interconnect components that are supplied to this command should accurately reflect the actual physical configuration. Failure to do so will prevent the system from building end-to-end cluster interconnect paths. This lack of functional cluster interconnects would result in cluster nodes that are unable to communicate with each other, nodes that panic, and similar conditions.

You must run the clinterconnect command from a cluster node that is online and is in cluster mode.

The general form of this command is as follows:

clinterconnect [subcommand] [options] [operands]

You can omit subcommand only if options specifies the –? option or the – V option.

Each option of this command has a long form and a short form. Both forms of each option are given with the description of the option in the OPTIONS section of this man page.

You can use some forms of this command in a non-global zone. For more information about valid uses of this command, see the descriptions of the individual subcommands. For ease of administration, use this command in the global zone.

From the global cluster only, you can also use the –Z option with the show and status subcommands to specify the name of a particular zone cluster to which you want to restrict an operation.

SUBCOMMANDS

The following subcommands are supported:

add

Adds the new cluster interconnect components that are specified as operands to the command.

Use this subcommand only in the global zone.

The syntax of the operand determines whether you are adding a cable, a switch, or an adapter. Refer to the OPERANDS section of this man page for more information.

Use the add subcommand to configure an interconnect cable between an adapter and either an adapter on another node or an interconnect switch. The adapter or switch endpoints that constitute the cable do not need to already exist. You can also use this subcommand to add adapters or switches to the configuration.

When you add an adapter or a switch to the configuration, the command also enables the adapter or switch. When you add a cable, the command also enables each of the cable's endpoints, if the endpoints are not already enabled.

In a two-node cluster, if you add a cable with an adapter at each endpoint, a virtual switch is also created.

Use the –d option to add an endpoint in the disabled state.

If you specify a configuration file with the –i option, you can specify the plus sign (+) as the operand. When you use this operand, the command creates all interconnect components that are specified in the configuration file which do not already exist in the cluster.

Users other than the root role require solaris.cluster.modify authorization to use this subcommand.

For information about removing interconnect components, see the description of the remove command.

disable

Disables the interconnect components that are specified as operands to the command.

Use this subcommand only in the global zone.

The syntax of the operand determines whether you are disabling a cable, a switch, or an adapter. Refer to the OPERANDS section of this man page for more information.

If you attempt to disable an adapter or a switch that is connected to an enabled cable, the operation results in an error. You must first disable the cable before you attempt to disable the connected adapter or switch.

When you disable a cable, the command also disables each endpoint that is associated with the cable, which can be an adapter or a switch port. The command also disables the switch if all of the switch ports are in a disabled state.

If you attempt to disable the cable or an endpoint of the last cluster interconnect path of an active cluster node, the operation results in an error.

Users other than the root role require solaris.cluster.modify authorization to use this subcommand.

For information about enabling interconnect components, see the description of the enable subcommand.

enable

Enables the interconnect components that are specified as operands to the command.

Use this subcommand only in the global zone.

The syntax of the operand determines whether you are enabling a cable, a switch, or an adapter. Refer to the OPERANDS section of this man page for more information.

When you enable a cable, the command also enables each endpoint that is associated with the cable, which can be an adapter or a switch port.

For information about disabling interconnect components, see the description of the disable subcommand.

Users other than the root role require solaris.cluster.modify authorization to use this subcommand.

export

Exports the cluster interconnect configuration information.

Use this subcommand only in the global zone.

If you supply a file name with the –o option, the configuration information is written to that new file. If you do not use the –o option, the output is written to standard output.

Users other than the root role require solaris.cluster.read authorization to use this subcommand.

remove

Removes the cluster interconnect components that are specified as operands to the command.

Use this subcommand only in the global zone.

The syntax of the operand determines whether you are removing a cable, a switch, or an adapter. Refer to the OPERANDS section of this man page for more information.

The following behaviors apply when you remove a cable:

  • You must first disable a cable before you can remove the cable.

  • If you attempt to remove a cable that is enabled, the remove operation results in an error.

  • If you remove a disabled cable, the cable's endpoints are also removed except in the following circumstances:

    • The switch is in use by another cable.

    • You also specify the –l option.

The following behaviors apply when you remove an adapter or switch endpoint:

  • If you remove an endpoint that is not associated with a cable, the specified endpoint is removed.

  • If you attempt to remove an endpoint that is associated with a cable, the remove operation results in an error. This occurs regardless of whether the cable is enabled or disabled.

Users other than the root role require solaris.cluster.modify authorization to use this subcommand.

For information about adding interconnect components, see the description of the add subcommand.

show

Displays the configuration of the interconnect components that are specified as operands to the command.

You can use this subcommand in a global zone or a zone cluster.

The configuration information includes whether the component is enabled or disabled. By default, the configuration of all interconnect components is printed.

The show subcommand accepts the plus sign (+) as an operand to specify all components.

From the global zone, you can use the –Z option to see private network configuration information for the exclusive-IP zone cluster you specify. The –Z option is not valid when the command is run from a zone-cluster node.

Users other than the root role require solaris.cluster.read authorization to use this subcommand.

status

Displays the status of the interconnect paths. By default, the report displays the status of all interconnect paths in the system.

From the global zone, you can use the –Z option to display the status of private network configuration information for the exclusive-IP zone cluster you specify. The –Z option is not valid when the command is run from a zone-cluster node.

You can use this subcommand in a global zone or an exclusive-IP zone cluster.

The following are the possible states of an interconnect path.

faulted

The interconnect path has encountered an error that prevents it from functioning.

Path online

The interconnect path is online and is providing service.

waiting

The interconnect path is in transition to the Path online state.

To determine whether an interconnect component is enabled or disabled, use the show subcommand.

Users other than the root role require solaris.cluster.read authorization to use this subcommand.

Options

The following options are supported:

–?
–-help

Displays help information. When this option is used, no other processing is performed.

You can use this option either alone or with a subcommand.

  • If you specify this option alone, the list of available subcommands is printed.

  • If you specify this option with a subcommand, the usage options for that subcommand are printed.

–d

Specifies that the endpoint is added in the disabled state.

–i {- | clconfigfile}
–-input={- | clconfigfile–}
–-input {- | clconfigfile–}

Specifies configuration information that is to be used for adding or modifying cables. This information must conform to the format that is defined in the clconfiguration(7CL) man page. This information can be contained in a file or supplied through standard input. To specify standard input, supply the minus sign (-) instead of a file name.

Options that you specify in the command override any options that are set in the cluster configuration file. If required elements are missing from a cluster configuration file, you must specify these elements on the command line.

You can use the minus sign (-) argument with this option to specify that the configuration is supplied as standard input.

–l
–-limited

Specifies that the cable removal operation removes only the cable but not any of its endpoints.

The –l option is only valid with the remove subcommand. If you do not specify this option with the remove subcommand, the command removes the specified cables as well as any associated adapters. In addition, if the cable removal operation removes the last connection to a switch, the command also removes the switch from the configuration.

–n node[,…]
–-node=node[,…]
–-node node[,…]

Specifies a node or list of nodes. Use this option to limit the operation to adapters and cables that are attached only to the specified node.

You can specify a node either by its node name or by its node ID.

–o {- | clconfigfile}
–-output={- | clconfigfile}
–-output {- | clconfigfile}

Displays the interconnect configuration in the format that is described by the clconfiguration(7CL) man page.

Only the export subcommand accepts the –o option.

If you supply a file name as the argument to this option, the command creates a new file and the configuration is printed to that file. If a file of the same name already exists, the command exits with an error. No change is made to the existing file.

If you supply the minus sign (-) as the argument to this option, the command displays the configuration information to standard output. All other standard output for the command is suppressed.

–V
–-version

Displays the version of the command.

Do not specify this option with subcommands, operands, or other options. The subcommands, operands, or other options are ignored. The –V option only displays the version of the command. No other operations are performed.

–v
–-verbose

Displays verbose messages to standard output. By default, the show and status commands display verbose output.

You can use this option with any form of the command.

–Z {zone-cluster-name}
–-zonecluster={zone-cluster-name}
–-zonecluster {zone-cluster-name}

Specifies the cluster or clusters where you want to operate.

This option is supported by the show and status subcommands.

The –Z option is not valid when the command is run from a zone-cluster node.

If you specify this option, you must also specify one argument from the following list:

zone-cluster-name

Specifies that the command with which you use this option is to operate in only the zone cluster named zone-cluster-name.

global

Specifies that the command with which you use this option is to operate in the global cluster only.

Operands

This command accepts interconnect endpoints or pairs of comma-separated endpoints as operands. An endpoint can be an adapter or a switch. A comma-separated pair of endpoints indicates a cable.

For those forms of the command that accept more than one interconnect component, you can use the plus sign (+) argument to specify all possible components.

The following operands are supported:

node:adapter

Specifies an adapter endpoint.

An adapter endpoint has a node name and an adapter name. The adapter name is constructed from an interconnect name that is immediately followed by a physical-unit number, such as net0. The node that hosts the adapter does not need to be active in the cluster for these operations to succeed.

The following types of adapters can be configured as cluster transport adapters:

Ethernet

You can connect an Ethernet adapter to another Ethernet adapter or to an Ethernet switch.

InfiniBand

You can connect an InfiniBand adapter only to an InfiniBand switch.

By default, adapters are configured as using the dlpi transport type.

To specify a tagged-VLAN adapter, use the tagged-VLAN adapter name that is derived from the physical device name and the VLAN instance number. The VLAN instance number is the VLAN ID multiplied by 1000 plus the original physical-unit number. For example, a VLAN ID of 11 on the physical device net2 translates to the tagged-VLAN adapter name net11002.

switch[@port]

Specifies a switch endpoint.

Each interconnect switch name must be unique across the namespace of the cluster. You can use letters, digits, or a combination of both. The first character of the switch name must be a letter.

If you do not supply a port component for a switch endpoint, the command assumes the default port name. The default port name is equal to the node ID of the node that is attached to the other end of the cable.

You can configure the following types of switches as cluster transport switches:

Ethernet

Use the Ethernet switch with Ethernet adapters.

InfiniBand

Use the InfiniBand switch with InfiniBand adapters.

By default, switches are configured as using the switch type.

node:adapter,node:adapter
node:adapter,switch[@port]

Specifies a cable.

A cable is a comma-separated pair of adapter or switch endpoints. The order of endpoints is not important. Use cable operands to add a complete cluster interconnect. Because the clinterconnect command automatically creates both endpoints when you add a cable, you do not need to separately create adapter or switch endpoints.

Exit Status

The complete set of exit status codes for all commands in this command set are listed on the Intro(8CL) man page.

If the command is successful for all specified operands, it returns zero (CL_NOERR). If an error occurs for an operand, the command processes the next operand in the operand list. The returned exit code always reflects the error that occurred first.

This command returns the following exit status codes:

0 CL_NOERR

No error

1 CL_ENOMEM

Not enough swap space

3 CL_EINVAL

Invalid argument

6 CL_EACCESS

Permission denied

35 CL_EIO

I/O error

36 CL_ENOENT

No such object

37CL_EOP

Operation not allowed

38 CL_EBUSY

Object busy

39 CL_EEXIST

Object exists

Examples

Example 1 Creating a Direct-Connect Cluster Interconnect Cable

The following example shows how to add a cable that connects ports between the adapter net0 on the node phys-schost-1 and the adapter net0 on the node phys-schost-2.

# clinterconnect add phys-schost-1:net0,phys-schost-2:net0
Example 2 Creating a Cable Between a Switch and an Adapter

The following example shows how to add a cable between the adapter net0 on the node phys-schost-1 and the switch ether_switch.

# clinterconnect add phys-schost-1:net0,ether_switch
Example 3 Disabling a Cable

The following example shows how to disable the cable that is connected between the adapter net0 on the node phys-schost-1 and the switch ether_switch.

# clinterconnect disable phys-schost-1:net0,ether_switch
Example 4 Removing a Cluster Interconnect Cable

The following example shows how to remove the cable that is connected between the adapter net0 on the node phys-schost-1 and the switch ether_switch.

# clinterconnect remove phys-schost-1:net0,ether_switch
Example 5 Creating a Cable Between a Tagged-VLAN Adapter and a Switch

The following example shows how to add a cable between the tagged VLAN adapter net73002 on the node phys-schost-1 and the VLAN-capable switch switch1. The physical name of the adapter is net2 and the VLAN ID is 73.

# clinterconnect add phys-schost-1:net73002,switch1
Example 6 Enabling a Switch

The following example shows how to enable the switch endpoint switch1.

# clinterconnect enable switch1

Attributes

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

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Availability
ha-cluster/system/core
Interface Stability
Evolving

See Also

clconfiguration(7CL), rbac(7), Intro(8CL), cluster(8CL)

Managing Hardware With Oracle Solaris Cluster 4.4, Installing and Configuring an Oracle Solaris Cluster 4.4 Environment

Notes

The root role can run all forms of this command.

Any user can run this command with the following options.

  • –? (help) option

  • –V (version) option

To run this command with other subcommands, users other than the root role require authorizations. See the following table.

Subcommand
Authorization
add
solaris.cluster.modify
disable
solaris.cluster.modify
enable
solaris.cluster.modify
export
solaris.cluster.read
remove
solaris.cluster.modify
show
solaris.cluster.read
status
solaris.cluster.read