scrgadm(1M)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXIT STATUS | ATTRIBUTES | SEE ALSO | NOTES

NAME

scrgadm– manage registration and unregistration of resource types, resource groups, and resources

SYNOPSIS

Show Current Configuration

scrgadm -p[v[v]] [-t resource_type_name] [-g resource_group_name] [-j resource_name]


Resource Type Commands

scrgadm -a -t resource_type_name [-h RT_installed_node_list] [-f registration_file_path]
scrgadm -c -t resource_type_name -h {RT_installed_node_list | \*}
scrgadm -r -t resource_type_name


Resource Group Commands

scrgadm -a -g RG_name [-h nodelist] [-y property […]]
scrgadm -c -g RG_name [-h nodelist] -y property [-y property […]]
scrgadm -r -g RG_name


Resource Commands

scrgadm -a -j resource_name -t resource_type_name -g RG_name [-y property […]] [-x extension_property […]]
scrgadm -c -j resource_name [-y property […]] [-x extension_property […]]
scrgadm -r -j resource_name


LogicalHostname Resource Commands

scrgadm -a -L -g RG_name [-j resource_name] -l hostnamelist [-n netiflist] [-y property […]]


SharedAddress Resource Commands

scrgadm -a -S -g RG_name -l hostnamelist [-j resource_name] [-n netiflist] [-X auxnodelist] [-y property […]]

DESCRIPTION

A resource type specifies common properties and callback methods for all resources of that type. Before you can create a resource of a particular type, you must first register the resource type using the

-a -t resource_type_name

form of the command.

A resource group contains a set of resources, all of which are brought online or offline together on a given node or set of nodes. You first create an empty resource group before placing any resources in it. To create a resource group, use the command form:

-a -g RG_name

There are two types of resource group: failover and scalable.

A failover resource group is online on only one node at a time. A failover resource group may contain resources of any type although scalable resources configured into a failover resource group run on only one node at a time.

A scalable resource group may be online on several nodes at once. It may contain only resources which support scaling and may not contain resources which are constrained by their resource type definition only to failover behavior.

To create a failover resource group named MyDatabaseRG, use:

# scrgadm -a -g MyDatabaseRG

To create a scalable resource group named MyWebServerRG, use:

# scrgadm -a -g MyWebServerRG \
     -y Maximum_primaries=<integer>\
     -y Desired_primaries=<integer>

A newly created resource group is in an UNMANAGED state. Use the scswitch(1M) command (after creating resources in the group) to put a resource group in a MANAGED state.

To create a resource of a given type in a resource group use the command form:

-a -j resource_name -t resource_type_name -g RG_name

Creating a resource causes the underlying RGM mechanism to take several actions. It calls the VALIDATE method on the resource to verify that the property settings of the resource are valid. If the VALIDATE method completes successfully and the resource group has been put in a MANAGED state, the RGM initializes the resource by calling the INIT method on the resource and brings the resource online if it is enabled and its resource group is online.

To remove a resource group, first remove all resources from the containing resource group. To remove a resource, first disable it with the scswitch(1M) command. Removing a resource causes the RGM to clean up after the resource by calling the FINI method on it.

OPTIONS

Action Options

Action options specify the actions performed by the command. Only one action option is allowed on the command line.

The following action options are supported:

-a

Add a new configuration.

Use with:

-t

to add a resource type

-g

to create a resource group

-j

to create a resource

-c

Modify existing configuration. Only values of the specified properties are set. Other properties retain their current values.

Use with:

-t

to modify a resource type

-g

to modify a resource group

-j

to modify a resource

-r

Remove configuration.

Use with:

-t

to remove a resource type

-g

to remove a resource group

-j

to remove a resource

-p

Display existing configurationinformation.

Use with:

-v[v]

to display more verbose output

-t resource_type_name

to display specific resource type configuration information

-g resource_group_name

to display specific resource group configuration information

-j resource_name

to display specific resource configuration information.

You can add up to two -v flags.

If you do not specify any -t, -g, or -j flags, the default is to provide information on all resource types, resource groups, and resources currently configured on the cluster.

Multiple -t, -g, and -j are supported and can be combined with any combination of -v options.

Target Options

Target options identify the target object.

The following target options are supported:

-g RGname

Resource group.

-t resource_type_name

Resource type.

-j resource_name

Resource. When used with -a, -t and -g must also be specified in the command to indicate the type of the resource to be instantiated and the containing resource group.

Resource Type Specific Options

The following resource type specific options are supported:

-f registration_file_path

This option is valid with -a. It is the pathname of the resource type registration file and is required if the file is not in the well-known directory (usually /usr/cluster/lib/rgm/rtreg).

-h RT_installed_node_list

This option is valid with -a and -c. It is a comma-separated list of node names upon which this resource type is installed. Resources of this type can be instantiated only in resource groups whose nodelist is a subset of this list.

-h is optional with the -a option. If -h is not specified, it implies that the resource type has been installed on all nodes. Doing so permits resources of this type to be instantiated in any resource group.

-h is required with the -c option. In this case, -h must be specified with either a new installed node list or with an escaped wildcard character (\*). The wildcard character indicates that the resource type has been installed on all nodes. Comma is not allowed in a node name.

-t resource_type_name

This option is valid with -a, -c, and -r. A resource type is defined by a resource type registration file that specifies standard and extension property values for the resource type. The registration filename is expected to be the same as the resource_type_name, and is expected to be present in the well-known directory where registration files are usually installed (/usr/cluster/lib/rgm/rtreg). Making the filename the same as the resource_type_name enables the shorthand notation:

# scrgadm -a -t SUNW.rt:2.0

instead of having to use the following notation:

# scrgadm -a -t stuff -f <full path to SUNW.rt:2.0>

To view the names of the currently registered resource types, use:

scrgadm -p

Starting in Sun Cluster 3.1, a resource type name is of the form

vendor_id.resource_type:version

The three components of the resource type name are properties specified in the RTR file as Vendor_id, Resource_type, and RT_version; the scrgadm command inserts the period and colon delimiters. The optional Vendor_id prefix is necessary only if it is required to distinguish between two registration files of the same name provided by different vendors. The RT_version is used for upgrading from one version of a data service to another version of the data service.

To ensure that the Vendor_id is unique, the recommended approach is to use the stock symbol for the company creating the resource type. The resource_type_name used with the -t flag may either be the full resource type name, or an abbreviation that leaves off the Vendor_id. For example, both -t SUNW.iws and -t iws are valid. If there are two resource types in the cluster with names that differ only in the Vendor_id prefix, the use of the abbreviated name will fail.

The scrgadm command will fail the registration of the resource if the RT_version string includes a blank, tab, slash, backslash, asterisk, question mark, left square bracket, or right square bracket character,

You can omit the version component when specifying the resource_type_name used with the -t flag if there is not more than one version registered.

Resource type names created prior to Sun Cluster 3.1 continue to be of the form:

vendor_id.resource_type

Resource Group Specific Options

The following resource group specific options are supported:

-h nodelist

A shortcut for –y Nodelist=nodelist

-y property

This option is valid with -a and -c. Property is defined as name=value pair. Multiple instances of -yproperty are allowed.

To set a string property to an empty value, use this option without specifying a value, as follows:

-y property=

Recognition of -y property names is case-insensitive.

See the rg_properties(5) man page for a description of the resource group properties.

Resource Specific Options

-y property

This option is valid with -a and -c. Property is defined as name=value pair. Multiple instances of -yproperty are allowed.

To set a property to an empty value, use this option without specifying a value, as follows:

-y property=

Recognition of -y property names is case-insensitive.

See the rg_properties(5) man page for a description of the resource properties.

-x extension_property

This option is valid with -a and -c. An extension_property is defined as name=value pair applicable only to a given resource type. Multiple instances of -xextension_property are allowed.

To set a property to an empty value, use this option without specifying a value, as follows:

-x property=

For information on the extension properties available for a particular data service, see the man page for that data service.

Logical Hostname Specific Options

The following Logical Hostname specific options are supported:

These options apply to LogicalHostname resources. There are no special commands for removing a LogicalHostname resource. Use

-r -j resource_name

resource_name is the same name supplied with the optional -j flag when creating the LogicalHostname resource. If the -j flag and resource_name were omitted at LogicalHostname resource creation time then the name was generated by scrgadm. See the section describing -j under LogicalHostname specific options.

-l hostnamelist

The hostnamelist is a comma separated list of hostnames. It is the list of hostnames to be made available by this logical hostname resource. All hostnames in the same hostnamelist must be on the same subnet.

-j resource_name (optional)

Use this with with -a to explicitly name a logical hostname resource at creation and with -r to remove a resource from a resource group. If you do not use the -j option to explicitly name the resource, one is created whose name is the that of the first hostname in hostnamelist.

-n netiflist (optional)

The netiflist takes the following form:

netif@node[,...]

netif may be given as network adapter name, such as "le0,"or as an IP Network Multipathing (IPMP) group name, such as sc_ipmp. The node may be a node name or node ID. All nodes in the nodelist of the resource group must be represented in the netiflist. If -n netiflist is omitted, then an attempt is made to discover a net adapter on the subnet identified by the hostnamelist for each node in the nodelist. Single adapter IPMP groups are created for discovered network adapters not already in a IPMP group. Similarly, a single adapter IPMP group is created for a named adapter, if one does not already exist.

Refer to the NOTES section for more information.

-y property

Refer to the Resource Specific Options section for details.

Shared Address Specific Options

All LogicalHostname specific options apply to SharedAddress with the following additions:

-l hostnamelist

hostnamelist specifies the addresses to be shared. Dotted IP addresses may be specified although hostnames are strongly preferred.

-X auxnodelist

auxnodelist is a comma separated list of node names or IDs. Entries on this list must be members of the cluster. These are nodes which may host the specified SharedAddresses, but never serve as primary in the case of failover. This list is mutually exclusive with nodelist.

See the nodelist under Resource Group Specific Options.

EXIT STATUS

The following exit values are returned:

0

Successful completion.

Can write a warning message to standard error when it completes successfully.

non-0

An error has occurred.

Writes an error message to standard error when it exits with non-zero status.

ATTRIBUTES

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

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Availability	SUNWcsu

SEE ALSO

ifconfig(1M), scswitch(1M), scstat(1M), rg_properties(5), attributes(5)

NOTES

A network adapter that is not already configured for use cannot be discovered or placed into a IPMP group during LogicalHostname and SharedAddress add operations. See ifconfig(1M).

If scrgadm exits non-zero with the error message, cluster is reconfiguring, it is possible, though not definite, that the requested operation completed successfully, despite the error status. If the result is in doubt, you can execute scrgadm again with the same arguments after the reconfiguration is complete.

Sun Cluster 3.1  Last Revised 28 Apr 2002

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXIT STATUS | ATTRIBUTES | SEE ALSO | NOTES