Skip Navigation Links
Exit Print View
| Oracle Solaris Cluster Reference Manual Oracle Solaris Cluster 4.1

Search Scope:

- This Document
- Entire Library

### clreslogicalhostname

### , clrslh

- manage resources for Oracle Solaris Cluster logical hostnames

### Synopsis

    /usr/cluster/bin/clreslogicalhostname  [subcommand]
     -?

    /usr/cluster/bin/clreslogicalhostname  -V

    /usr/cluster/bin/clreslogicalhostname  [subcommand
     [options]] -v  [lhresource]...

    /usr/cluster/bin/clreslogicalhostname create -g resourcegroup
     [-h lhost[,…]] [-N netif@node[,…]] [-p
     name=value] [-Z {zoneclustername | global}] [-d] lhresource

    /usr/cluster/bin/clreslogicalhostname create -i
     {- |  clconfiguration} [-a] [-g resourcegroup[,…]]
     [-p name=value] [-d] {+ | lhresource...}

    /usr/cluster/bin/clreslogicalhostname delete  [-g resourcegroup[,…] ]
    [-Z {zoneclustername | global}] [-F] {+ | lhresource...}

    /usr/cluster/bin/clreslogicalhostname disable  [-g resourcegroup[,…]]
     [-R] [ -n node[,…]] [-Z {zoneclustername | global}] {+ | lhresource...}

    /usr/cluster/bin/clreslogicalhostname enable  [-g resourcegroup[,…]]
     [-R] [ -n node[,…]] [-Z {zoneclustername | global}] {+ | lhresource...}

    /usr/cluster/bin/clreslogicalhostname export  [-o
     {- | configfile}] [+ | lhresource...]

    /usr/cluster/bin/clreslogicalhostname list  [-s state[,…]]
     [-g resourcegroup[,…]] [-Z {zoneclustername [,...] | global | all}]
     [+ | lhresource...]

    /usr/cluster/bin/clreslogicalhostname list-props
     [-l listtype] [-p name[,…] ] [-Z {zoneclustername [,...] | global | all}]
     [+ | lhresource...]

    /usr/cluster/bin/clreslogicalhostname monitor  [-g resourcegroup[,…] ]
     [-Z zoneclustername | all | global ] {+ |  lhresource...}

    /usr/cluster/bin/clreslogicalhostname reset  [-f errorflag]
     [-g resourcegroup[,…] ] [-Z {zoneclustername | global}] {+ | lhresource...}

    /usr/cluster/bin/clreslogicalhostname set   [-i
     {- |  clconfiguration}] [-g resourcegroup[,…] ]
     [-p name[+|-]=value] [-Z {zoneclustername}] {+ |  lhresource...}

    /usr/cluster/bin/clreslogicalhostname show  [-g resourcegroup[,…] ]
     [-p name[,…]] [-Z {zoneclustername [,...] | global | all}] [+ | lhresource...]

    /usr/cluster/bin/clreslogicalhostname status  [-s state[,…]]
     [ -n node[,…]] [-g resourcegroup[,…]]
     [-Z {zoneclustername [,...] | global | all}] [+ |  lhresource...]

    /usr/cluster/bin/clreslogicalhostname unmonitor
     [-g resourcegroup[,…] ] [-Z {zoneclustername | global}] {+ |  lhresource...}

## Description

The `clreslogicalhostname` command manages resources for Oracle Solaris Cluster logical hostnames. The `clrslh` command is the short form of the `clreslogicalhostname` command. The `clreslogicalhostname` command and the `clrslh` command are identical. You can use either form of the command.

The `clreslogicalhostname` command includes built-in convenience options for creating logical-hostname resources. The `clreslogicalhostname` command also supports the automatic creation of Solaris IP multipathing (IPMP) groups.

Some subcommands of the `clreslogicalhostname` command modify the resource configuration:

- `disable`

- `enable`

- `monitor`

- `reset`

- `set`

- `unmonitor`

Some subcommands of the `clreslogicalhostname` command only obtain information about resources. You can use these subcommands from the global cluster or a zone cluster: The following commands only obtain information about resources:

- `export`

- `list`

- `list-props`

- `show`

- `status`

To avoid unpredictable results from this command, run all forms of the command from the global-cluster node.

The general form of this command is as follows:

`clreslogicalhostname` [subcommand] [options] [operands]

You can omit subcommand only if options specifies the option `-?`, `-o`, `-V`, or `-v`.

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.

### Operation with Zone Clusters

You can use the `clreslogicalhostname` command with all subcommands except `export` in a zone cluster.

You can also use the `-Z` option with all subcommands except `export` to specify the name of a particular zone cluster to which you want to restrict an operation. And, you can also attach the zone-cluster name to a logical-hostname resource (zoneclustername : lhresource) to restrict an operation to a particular zone cluster.

You can access all zone cluster information from a global-cluster node, but a particular zone cluster is not aware of other zone clusters. If you do not restrict an operation to a particular zone cluster, the subcommand you use operates in the current cluster only.

## SUBCOMMANDS

The following subcommands are supported:

`create`

  Creates the logical-hostname resources that are specified as operands to the command.

  When you use `create` with the `-i` option to specify a configuration file, the subcommand accepts the plus sign (+) as an operand. When you use the + operand, all resources in the configuration file that do not exist are created.

  Before you use the `create` subcommand, ensure that the `/etc/netmasks` file has IP-address subnet and netmask entries for all logical hostnames. If necessary, edit the `/etc/netmasks` file to add any missing entries.

  By default, resources are created in the enabled state with monitoring enabled. However, a resource comes online and is monitored only after the resource's resource group is brought online. To create resources in the disabled state, specify the `-d` option.

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

  To create a logical-hostname resource in a zone cluster from the global cluster, use the `-Z` option to specify the name of the zone cluster.

  Users other than superuser require `solaris.cluster.modify` role-based access control (RBAC) authorization to use this subcommand.

  See also the description of the `delete` subcommand.

`delete`

  Deletes the logical-hostname resources that are specified as operands to the command. This subcommand accepts the plus sign (+) as an operand to specify that all resources are deleted.

  The `-g` option filters the list of operands to limit the resources that are deleted. The `-g` option deletes only the resources in the list of operands that are members of the resource groups in resourcegrouplist.

  - By default, a resource is deleted only if the following conditions are met:

  - The resource is disabled.

  - All dependencies on the resource are eliminated.

  - To ensure that all specified resources are deleted, specify the `-F` option. The effects of the `-F` option are as follows:

  - All specified resources are deleted, even resources that are not disabled.

  - All specified resources are removed from resource-dependency settings of other resources.

  Resources are deleted in the order that is required to satisfy dependencies between the resources, regardless of the order in which resources are specified on the command line.

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

  To delete the logical-hostname resources in a zone cluster from the global cluster, specify the zone-cluster name using the `-Z` option.

  Users other than superuser require `solaris.cluster.modify` RBAC authorization to use this subcommand.

  See also the description of the `create` subcommand.

`disable`

  Disables the logical-hostname resources that are specified as operands to the command. This subcommand accepts the plus sign (`+`) as an operand to specify that all resources are disabled.

  The `-g` option filters the list of operands to limit the resources that are disabled. The `-g` option disables only the resources in the list of operands that are members of the resource groups in resourcegrouplist.

  To ensure that all required resource dependencies are satisfied, specify the `-R` option. The `-R` option disables any resources that depend on the resources that are specified as operands to the command, even if the resources are not specified as operands to the command. The `-g` option and the `-t` option do not apply to resources that are to be disabled solely to satisfy resource dependencies.

  Resources are disabled in the order that is required to satisfy dependencies between the resources, regardless of the order in which resources are specified on the command line.

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

  To disable the logical-hostname resources registered in a zone cluster from the global cluster, specify the zone-cluster name using the `-Z` option.

  Users other than superuser require `solaris.cluster.admin` RBAC authorization to use this subcommand.

  See also the description of the `enable` subcommand.

`enable`

  Enables the logical-hostname resources that are specified as operands to the command. This subcommand accepts the plus sign (`+`) as an operand to specify that all resources are enabled.

  The `-g` option filters the list of operands to limit the resources that are enabled. The `-g` option enables only the resources in the list of operands that are members of the resource groups in resourcegrouplist.

  To ensure that all required resource dependencies are satisfied, specify the `-R` option. The `-R` option enables any resources that depend on the resources that are specified as operands to the command, even if the resources are not specified as operands to the command. The `-g` option does not apply to resources that are to be enabled solely to satisfy resource dependencies.

  Resources are enabled in the order that is required to satisfy dependencies between the resources, regardless of the order in which resources are specified on the command line.

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

  To enable the logical-hostname resources registered in a zone cluster from the global cluster, specify the zone-cluster name using the `-Z` option.

  Users other than superuser require `solaris.cluster.admin` RBAC authorization to use this subcommand.

  See also the description of the `disable` subcommand.

`export`

  Exports the logical-hostname resource configuration in the format that is described by the `clconfiguration`(5CL) man page.

  You can use this subcommand only in the global cluster.

  Users other than superuser require `solaris.cluster.read` RBAC authorization to use this subcommand.

`list`

  Displays a list of the logical-hostname resources that are specified as operands to the command. By default, all resources are displayed.

  The `-g` option filters the list of operands to limit the resources that are displayed. The `-g` option displays only the resources in the list of operands that are members of the resource groups in resourcegrouplist.

  This subcommand accepts the plus sign (`+`) as an operand to specify all resources in the specified resource groups or that are instances of the specified resource types. If no operands are supplied, all resources in the specified resource groups or that are instances of the specified resource types are displayed.

  If you specify the `-v` option, the resource group and resource type of each resource in the list is also displayed.

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

  To view the logical-hostname resources registered in a zone cluster from the global cluster, specify the zone-cluster name using the `-Z` option.

  Users other than superuser require `solaris.cluster.read` RBAC authorization to use this subcommand.

`list-props`

  Displays a list of the properties of the logical-hostname resources that are specified as operands to the command. By default, the extension properties of all resources are displayed.

  The following options filter the list of operands to limit the resources whose properties are displayed:

  `-g` resourcegrouplist

    Displays the properties only of the logical-hostname resources in the list of operands that are members of the resource groups in resourcegrouplist.

  The `-l` option specifies the type of resource properties that are to be displayed:

  `-l all`

    Specifies that standard properties and extension properties are displayed.

  `-l extension`

    Specifies that only extension properties are displayed. By default, only extension properties are displayed.

  `-l standard`

    Specifies that only standard properties are displayed.

  If you do not specify the `-l`option, only extension properties are displayed, unless you specify a standard property explicitly by using the `-p` option or the `-y` option.

  The `-p` option limits the set of resource properties that is to be displayed. The `-p` option displays only the properties that are specified in namelist. You can specify standard properties and extension properties in namelist.

  If you specify the `-v` option, the description of each property is also displayed.

  This subcommand accepts the plus sign (`+`) as an operand to specify all resources in the specified resource groups or that are instances of the specified resource types. If no operands are supplied, properties of all resources in the specified resource groups or that are instances of the specified resource types are displayed.

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

  To view the list of properties of the logical-hostname resources of a zone cluster, specify the zone-cluster name using the `-Z` option.

  Users other than superuser require `solaris.cluster.read` RBAC authorization to use this subcommand.

`monitor`

  Turns on monitoring for the logical-hostname resources that are specified as operands to the command. This subcommand accepts the plus sign (`+`) as an operand to specify that monitoring is turned on for all resources.

  The `-g` option filters the list of operands to limit the resources that are monitored. The `-g` option monitors only the resources in the list of operands that are members of the resource groups in resourcegrouplist.

  - If monitoring is turned on for a resource, the resource is monitored only if the following conditions are met:

  - The resource is enabled.

  - The resource group that contains the resource is online on at minimum one cluster node.

  Note - When you turn on monitoring for a resource, you do not enable the resource.

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

  To monitor the resources in a zone cluster from the global cluster, specify the zone-cluster name using the `-Z` option.

  Users other than superuser require `solaris.cluster.admin` RBAC authorization to use this subcommand.

  See also the description of the `unmonitor` subcommand.

`reset`

  Clears an error flag that is associated with the logical-hostname resources that are specified as operands to the command. This subcommand accepts the plus sign (`+`) as an operand to specify that the error flag is cleared for all resources.

  The `-g` option filters the list of operands to limit the resources that are reset. The `-g` option resets only the resources in the list of operands that are members of the resource groups in resourcegrouplist.

  By default, the `reset` subcommand clears the `STOP_FAILED` error flag. To specify explicitly the error flag that is to be cleared, use the `-f` option. The only error flag that the `-f` option accepts is the `STOP_FAILED` error flag.

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

  To reset the logical-hostname resources in a zone cluster from the global cluster, specify the zone-cluster name using the `-Z` option.

  Users other than superuser require `solaris.cluster.admin` RBAC authorization to use this subcommand.

`set`

  Modifies specified properties of the logical-hostname resources that are specified as operands to the command. This subcommand accepts the plus sign (`+`) as an operand to specify that the specified properties of all resources are modified.

  The `-g` option filters the list of operands to limit the resources that are modified. The `-g` option modifies only the resources in the list of operands that are members of the resource groups in resourcegrouplist.

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

  To set the properties of logical-hostname resources in a zone cluster from the global cluster, specify the zone-cluster name using the `-Z` option.

  Users other than superuser require `solaris.cluster.modify` RBAC authorization to use this subcommand.

`show`

  Displays the configuration of the logical-hostname resources that are specified as operands to the command. By default, the configuration of all resources is displayed.

  The `-g` option filters the list of operands to limit the resources for which the configuration is displayed. The `-g` option displays the configuration of only the resources in the list of operands that are members of the resource groups in resourcegrouplist.

  The `-p` option limits the set of resource properties that is to be displayed. The `-p` option displays only the properties that are specified in namelist. You can specify standard properties and extension properties in namelist.

  This subcommand accepts the plus sign (`+`) as an operand to specify all resources in the specified resource groups or that are instances of the specified resource types. If no operands are supplied, the configuration of all resources in the specified resource groups or that are instances of the specified resource types are displayed.

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

  To view the configuration of the logical-hostname resources in a zone cluster from the global cluster, specify the zone-cluster name using the `-Z` option.

  Users other than superuser require `solaris.cluster.read` RBAC authorization to use this subcommand.

`status`

  Displays the status of the logical-hostname resources that are specified as operands to the command. By default, the status of all resources is displayed.

  The following options filter the list of operands to limit the list of resources for which the status is displayed:

  `-g` resourcegrouplist

    Displays the status of only the resources in the list of operands that are members of the resource groups in resourcegrouplist.

  `-n` nodelist

    Displays the status of only the resources in the list of operands that are hosted on the nodes in nodelist.

  `-s` statelist

    Displays the status of only the resources in the list of operands that are in the states in statelist.

  This subcommand accepts the plus sign (`+`) as an operand to specify all resources in the specified resource groups or that are instances of the specified resource types. If no operands are supplied, the status of all resources in the specified resource groups or that are instances of the specified resource types are displayed.

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

  To view the status of logical-hostname resources in a zone cluster from the global cluster, specify the zone-cluster name using the `-Z` option.

  Users other than superuser require `solaris.cluster.read` RBAC authorization to use this subcommand.

`unmonitor`

  Turns off monitoring for the logical-hostname resources that are specified as operands to the command. This subcommand accepts the plus sign (`+`) as an operand to specify that monitoring is turned off for all resources.

  If you turn off monitoring for a resource that is disabled, the resource is not affected. The resource and its monitor are already offline.

  Note - When you turn off monitoring for a resource, you do not disable the resource. However, when you disable a resource, you do not need to turn off monitoring for the resource. The disabled resource and its monitor are kept offline.

  The `-g` option filters the list of operands to limit the resources for which monitoring is turned off. The `-g` option turns off monitoring for the resources in the list of operands that are members of the resource groups in resourcegrouplist.

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

  ITo turn off monitoring for a logical-hostname resource in a zone cluster from the global cluster, specify the zone-cluster name using the `-Z` option.

  Users other than superuser require `solaris.cluster.admin` RBAC authorization to use this subcommand.

  See also the description of the `disable` subcommand and the `monitor` subcommand.

## Options

The following options are supported:

`-?`
`--help`

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

  You can specify this option without a subcommand or with a subcommand.

  If you specify this option without a subcommand, the list of subcommands for this command is displayed.

  If you specify this option with a subcommand, the usage options for the subcommand are displayed.

  The effect of this option with specific subcommands is as follows:

  `create`

    When specified with the `-g` option, this option displays help information for all resource properties of the specified resource group.

  `set`

    Displays help information for properties of the resources that are specified as operands to the command.

`-a`
`--automatic`

  Automatically performs the following additional operations when resources are being created from cluster configuration information:

  - Registering resource types

  - Creating resource groups

  - Creating resources on which the resources that are specified in the list of operands depend

  - The cluster configuration information must contain sufficient information to do all of the following:

  - Enable the resource types to be registered

  - Enable the resource groups to be created

  - Enable the resources to be created

  You can specify this option only with the `create` subcommand. If you specify this option, you must also specify the `-i` option and provide a configuration file.

`-d`
`--disable`

  Disables a resource when the resource is created. You can specify this option only with the `create` subcommand. By default, resources are created in the enabled state.

  Enabling a resource does not guarantee that the resource is brought online. A resource comes online only after the resource's resource group is brought online on at minimum one node.

`-f` errorflag
`--flag` errorflag

  Specifies explicitly the error flag that is to be cleared by the `reset` subcommand. You can specify this option only with the `reset` subcommand. By default, the `reset` subcommand clears the `STOP_FAILED` error flag.

  The only error flag that the `-f` option accepts is the `STOP_FAILED` error flag.

`-F`
`--force`

  Forces the deletion of resources that are not disabled. You can specify this option only with the `delete` subcommand.

`-g` resourcegroup[,…]
`--resourcegroup` resourcegroup`-[,…]`

  Specifies a resource group or a list of resource groups.

  For subcommands except `create`, the command acts on only the resources in the list of operands that are members of the resource groups that the `-g` option specifies.

  The effect of this option with specific subcommands is as follows:

  `create`

    Specifies that the resource is created in the specified resource group. When you use `-g` with the `create` subcommand, you can specify only one resource group.

`-h` lhost[,…]
`--logicalhost` lhost`-[,…]`

  Specifies the list of logical hostnames that this resource represents. You must use the `-h` option either when more than one logical hostname is to be associated with the new logical-hostname resource or when the logical hostname does not have the same name as the resource itself. All logical hostnames in the list must be on the same subnet. If you do not specify the `-h` option, the resource represents a single logical hostname whose name is the name of the resource itself.

  You can use `-h` instead of setting the `HostnameList` property with `-p`. However, you cannot use `-h` and explicitly set `HostnameList` in the same command.

  You can only use `-h` is with the `create` subcommand.

  Note - For a zone cluster, all the logical hostnames or the corresponding IP addresses must be specified in the net properties in the global scope in the zone cluster configuration. Otherwise the resource group creation fails.

  For more information about global scope net properties, refer to `clzonecluster`(1CL) man page.

`-i` {- | clconfiguration}
`--input {- |` clconfiguration`-}`

  Specifies configuration information that is to be used for creating or modifying logical-hostname resources. This information must conform to the format that is defined in the `clconfiguration`(5CL) man page. This information can be contained in a file or supplied through the standard input. To specify the standard input, specify `-` instead of a file name.

  Only the resources that are supplied as operands to the command are created or modified. Options that are specified in the command override any options that are set in the configuration information. If configuration parameters are missing in the configuration information, you must specify these parameters on the command line.

  The effect of this option with specific subcommands is as follows:

  `create`

    When specified with the `-a` option, this option registers all required resource types and creates all required resource groups. You must supply all information that is required for the registration and configuration. All other configuration data is ignored.

`-l` listtype
`--listtype` listtype

  Specifies the type of resource properties that are to be displayed by the `list-props` subcommand. You can specify this option only with the `list-props` subcommand.

  You must specify one value from the following list for listtype:

  `all`

    Specifies that standard properties and extension properties are displayed.

  `extension`

    Specifies that only extension properties are displayed. By default, only extension properties are displayed.

  `standard`

    Specifies that only standard properties are displayed.

  If you do not specify the `-l` option, only extension properties are displayed, unless you specify a standard property explicitly by using the `-p` option.

`-n` node[,…]
`--node` node[,...]

  Specifies a node or a list of nodes in the target global cluster or zone cluster. You can specify each node as node name or a node ID. If the `-Z` option is specified, then you can specify only zone-cluster hostnames with the `-n` option and not the global-cluster hostnames. If `-Z` option is not specified, then you can specify only the global-cluster hostnames with the `-n` option.

  The subcommands with which you can specify this option are as follows:

  `disable`

    Disables only the resources in the list of operands that are hosted on the specified nodes.

  `enable`

    Enables only the resources in the list of operands that are hosted on the specified nodes.

  `status`

    Reports the status only of resources in the list of operands that are hosted on the specified nodes.

`-N` netif@node[,…]
`--netiflist` netif@node[,…]

  Specifies a resource property. The `-N` option enables you to set the `NetIfList` property without using the `-p` option for the property. If you do not specify `-N`, the `clreslogicalhostname` command attempts to set the `NetIfList` property for you based on available IPMP groups or public adapters, as well as the subnet associated with the `HostnameList` property.

  You can specify the `NetIfList` property in the form of ipmpgroup@node[,…] or publicNIC@node[,…]. If you do not use `-N`, or if you use it with publicNIC@node, the `clreslogicalhostname` command attempts to create the necessary IPMP groups. The system creates single-adapter IPMP groups with basic defaults, which the user can later modify by using standard Solaris IPMP interfaces. IPMP groups are automatically created only in the global-cluster node.

  You can use `-N` instead of directly setting the `NetIfList` property with `-p`. However, you cannot use `-N` and explicitly set `NetIfList` in the same command.

  You can only use `-N` with the `create` subcommand.

`-o` {- | clconfiguration}
`--output {- |` clconfiguration`-}`

  Specifies the location where resource configuration information is to be written. This location can be a file or the standard output. To specify the standard output, specify `-` instead of a file name. If you specify the standard output, all other standard output for the command is suppressed. You can specify this option only with the `export` subcommand.

  Configuration information is written only for the resources that are supplied as operands to the command. The information is written in the format that is defined in the `clconfiguration`(5CL) man page.

`-p` name=value
`-p` name`-+=`array-values
`-p` name-=array-values
`--property` name`-=`value
`--property` name+=value-values
`--property` name`--=`value-values

  Sets the standard properties and extension properties of a resource. You can specify this option only with the `create` subcommand and the `set` subcommand.

  For a description of standard properties, see the `r_properties`(5) man page.

  For a description of a resource type's extension properties, see the documentation for the resource type.

  The operators to use with this option are as follows:

  `=`

    Sets the property to the specified value. The `create` subcommand and the `set` subcommand accept this operator.

  `+=`

    Adds a value or values to a string array value. Only the `set` subcommand accepts this operator. You can specify this operator only for string array values.

  `-=`

    Removes a value or values from a string array value. Only the `set` subcommand accepts this operator. You can specify this operator only for string array values.

  If a per-node property is to be set only on a subset of cluster nodes, specify the nodes the where the property is set by appending the list of nodes in braces to the property name as follows:

      name{nodelist}

  nodelist is a comma-separated list of node names or node IDs. For more information about per-node properties, see the `rt_properties`(5) man page.

`-p` name[,…]
`--property` name`-[,…]`

  Specifies a list of properties for the `list-props` subcommand and `show` subcommand.

  You can use this option for standard properties and extension properties of a resource.

  For a description of standard properties, see the `r_properties`(5) man page.

  For a description of a resource type's extension properties, see the documentation for the resource type.

  Without this option, the `list-props` subcommand and `show` subcommand list all or most resource properties, depending on whether the `-v` option is also specified.

`-R`
`--recursive`

  Recursively enables or disables resources to ensure that all required dependencies are satisfied. You can specify this option only with the `disable` subcommand and the `enable` subcommand.

  The effect of this option with these subcommands is as follows:

  `disable`

    Disables any resources that depend on the resources that are specified as operands to the command, even if the resources are not specified as operands to the command.

  `enable`

    Enables any resources on which resources that are specified as operands to the command depend, even if the resources are not specified as operands to the command.

`-s` state[,…]
`--state` state`-[,…]`

  Specifies a list of states for the `list` subcommand and `status` subcommand.

  This option limits the output to include only those resources that are in one of the specified states on one or more nodes in the node list.

  The possible states are as follows:

  - `degraded`

  - `detached`

  - `faulted`

  - `monitor_failed`

  - `not_online` - specifies any state other than `online` or `online_not_monitored`

  - `offline`

  - `online`

  - `online_not_monitored`

  - `start_failed`

  - `stop_failed`

  - `unknown`

  - `unmonitored`

  - `wait`

`-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.

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

  Do not specify the `-v` option with the `-o``-` option. The`-v` option is ignored. The `-o``-` option suppresses all other standard output.

`-Z` {zoneclustername | `global` | `all`}
`--zoneclustername=`{zoneclustername | `global` | `all`}
`--zoneclustername` {zoneclustername | `global` | `all`}

  Specifies the cluster or clusters in which the resource exists and on which you want to operate.

  This option is supported by all subcommands except the `export` subcommand.

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

  zoneclustername

    Specifies that the command with which you use this option is to operate on all specified resources in only the zone cluster named zoneclustername.

  `global`

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

  `all`

    If you use this argument in the global cluster, it specifies that the command with which you use it is to operate on all specified resources in all clusters, including the global cluster and all zone clusters.

    If you use this argument in a zone cluster, it specifies that the command with which you use it is to operate on all specified resources in that zone cluster only.

## Operands

The following operand is supported:

resource

  Specifies that the Oracle Solaris Cluster resource names should be accepted as operands. If the subcommand accepts more than one resource, you can use the plus sign (`+`) to specify all logical-hostname resources.

## Exit Status

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

  The command that you issued completed successfully.

`1` `CL_ENOMEM`

  Not enough swap space

  A cluster node ran out of swap memory or ran out of other operating system resources.

`3` `CL_EINVAL`

  Invalid argument

  You typed the command incorrectly, or the syntax of the cluster configuration information that you supplied with the `-i` option was incorrect.

`6` `CL_EACCESS`

  Permission denied

  The object that you specified is inaccessible. You might need superuser or RBAC access to issue the command. See the `su`(1M) and `rbac`(5) man pages for more information.

`9` `CL_ESTATE`

  Object is in wrong state

  You tried to modify a property, a resource group, or other object that you cannot modify at that particular time or at any time.

`10` `CL_EMETHOD`

  Resource method failed

  A method of a resource failed. The method failed for one of the following reasons:

  - The `validate` method failed when you tried to create a resource or modify the properties of a resource.

  - A method other than `validate` failed when you tried to enable, disable, or delete a resource.

`15` `CL_EPROP`

  Invalid property

  The property or value that you specified with the `-p`, `-y`, or `-x` option does not exist or is not allowed.

`35` `CL_EIO`

  I/O error

  A physical input/output error has occurred.

`36` `CL_ENOENT`

  No such object

  The object that you specified cannot be found for one of the following reasons:

  - The object does not exist.

  - A directory in the path to the configuration file that you attempted to create with the `-o` option does not exist.

  - The configuration file that you attempted to access with the `-i` option contains errors.

`39` `CL_EEXIST`

  Object exists

  The device, device group, cluster interconnect component, node, cluster, resource, resource type, resource group, or private string that you specified already exists.

These exit values are compatible with the return codes that are described in the `scha_calls`(3HA) man page.

## Examples

Example 1 Creating a Logical-Hostname Resource

This command creates a resource that is named `logicalhost1` in a resource group that is named `rg-failover`. The resource is created in the enabled state, with monitoring enabled.

    # clreslogicalhostname create -g rg-failover logicalhost1

Either of the following two commands create a resource that is named `logicalhost1` in a zone cluster `ZC`. These commands can be executed from the global-cluster node or the zone cluster `ZC`. If the command is executed from a zone cluster, explicitly defining the scope of the resource with the zone-cluster name is optional.

    # clreslogicalhostname create -g rg-failover -Z ZC logicalhost1

    # clreslogicalhostname create -g rg-failover ZC:logicalhost1

Example 2 Creating a Logical-Hostname Resource with a Different Logical Hostname

This command creates a resource named `rs-logicalhost1` in a resource group that is named `rg-failover`.

The logical hostname is not the same as the resource name, but the name and IP address of the logical host remain the same.

    # clreslogicalhostname create -g rg-failover \\
    -h logicalhost1 rs-logicalhost1

Example 3 Specifying the IPMP Groups for a Logical-Hostname Resource

This command sets the IPMP groups for the `logicalhost1` resource.

    # clreslogicalhostname create -g rg-failover \\
    -N ipmp0@black,ipmp0@white logicalhost1

Example 4 Deleting a Logical-Hostname Resource

This command deletes a resource that is named `logicalhost1`.

    # clreslogicalhostname delete logicalhost1

Example 5 Listing Logical-Hostname Resources

This command lists all logical-hostname resources.

    # clreslogicalhostname list
    logicalhost1
    logicalhost2

Example 6 Listing Logical-Hostname Resources With Resource Groups and Resource Types

This command lists all logical-hostname resources with their resource groups and resource types.

    # clreslogicalhostname list -v
    Resources    Resource Groups Resource Types
    ---------    --------------- --------------
    logicalhost1 rg-failover-1   SUNW.LogicalHostname
    logicalhost2 rg-failover-2   SUNW.LogicalHostname

Example 7 Listing Extension Properties of Logical-Hostname Resources

This command lists the extension properties of all logical-hostname resources.

    # clreslogicalhostname list-props -v
    Properties       Descriptions
    ----------       ------------
    NetIfList        List of IPMP groups on each node
    HostnameList     List of hostnames this resource manages
    CheckNameService Name service check flag

## Attributes

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

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

## See Also

`Intro`(1CL), `cluster`(1CL), `clresource`(1CL), `clressharedaddress`(1CL), `clresourcegroup`(1CL), `clresourcetype`(1CL), `scha_calls`(3HA), `clconfiguration`(5CL), `rbac`(5), `r_properties`(5)

## Notes

The superuser can run all forms of this command.

Any user can run this command with the following options:

- `-?` option

- `-V` option

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

Subcommand | RBAC Authorization
--- | ---
`create` | `solaris.cluster.modify`
`delete` | `solaris.cluster.modify`
`disable` | `solaris.cluster.admin`
`enable` | `solaris.cluster.admin`
`export` | `solaris.cluster.read`
`list` | `solaris.cluster.read`
`list-props` | `solaris.cluster.read`
`monitor` | `solaris.cluster.admin`
`reset` | `solaris.cluster.admin`
`set` | `solaris.cluster.modify`
`show` | `solaris.cluster.read`
`status` | `solaris.cluster.read`
`unmonitor` | `solaris.cluster.admin`

Copyright © 2000, 2012, Oracle and/or its affiliates. All rights reserved. Legal Notices |