scsnapshot(1M) (Sun Cluster Reference Manual for Solaris OS)

Sun Cluster Reference Manual for Solaris OS

scsnapshot(1M)

NAME

scsnapshot – retrieve configuration data about resource groups, resource types, and resources, and generate a shell script

Synopsis

scsnapshot [-s scriptfile] [-o imagefile]

scsnapshot [-s scriptfile] oldimage newimage

Description

Note –

Beginning with the Sun Cluster 3.2 release, Sun Cluster software includes an object-oriented command set. Although Sun Cluster software still supports the original command set, Sun Cluster procedural documentation uses only the object-oriented command set. For more information about the object-oriented command set, see the Intro(1CL) man page.

The scsnapshot tool retrieves information from the Cluster Configuration Repository (CCR) about configuration data that is related to resource groups, resource types, and resources. The scsnapshot tool formats the configuration data as a shell script that can be used for the following purposes:

To replicate configuration data on a cluster that has no configured resource groups, resource types, and resources
To upgrade configuration data on a cluster that has configured resource groups, resource types, and resources

The scsnapshot tool retrieves configuration data only from the CCR. Other configuration data is ignored. The scsnapshot tool does not take into account the dynamic state of different resource groups, resource types, and resources.

You can use this command only in the global zone.

Options

The following options are supported by the scsnapshot tool. If you use an incorrect command option, the correct way to use the command option is displayed.

-s scriptfile

Stores the generated script in a file called scriptfile.

You can use this option only in the global zone.

If this option is not specified, the generated script is written to the standard output.

If a file called scriptfile already exists, it is renamed as scriptfile.old, and a new file called scriptfile is created. If a file called scriptfile.old already exists, it is overwritten.

-o imagefile

Stores the generated image file in a file called imagefile.

You can use this option only in the global zone.

If this option is not specified, an image file is not generated.

If a file called imagefile already exists, it is renamed as imagefile.old, and a new file called imagefile is created. If a file called imagefile.old already exists, it is overwritten.

oldimage

Specifies an image file that contains the old configuration data.

newimage

Specifies an image file that contains the new configuration data.

Extended Description

The output of the scsnapshot tool is an executable Bourne shell-based script. Before you run the script, you might need to manually change some properties to reflect the features of your host.

The script compares the following characteristics of the local cluster to the cluster where the script was generated:

Machine architecture
Version of the Solaris Operating System
Version of the Sun Cluster software

If the characteristics are not the same, the script writes an error and ends. A message asks whether you want to rerun the script by using the -f option. The -f option forces the script to run, despite any difference in characteristics.

The script generated by the scsnapshot tool verifies that the Sun Cluster resource type exists on the local cluster. If the resource type does not exist on the local cluster, the script writes an error and ends. A message asks whether you want to install the missing resource type before you run the script again.

To run a script that is generated by the scsnapshot tool, you need solaris.cluster.resource.modify RBAC authorization. For more information, see the rbac(5) man page.

Usage

This section describes how you can use the scsnapshot tool.

Retrieving Configuration Data for Resource Groups, Resource Types, and Resources

scsnapshot  [-s scriptfile] [-o imagefile]

Used without the -o option, the scsnapshot tool generates a script that creates configuration data for clusters that do not already have configured resource groups, resource types, and resources. See Example 1.

Used with the -o option, the scsnapshot tool produces an image file that represents the configuration data. The image file can be used in further invocations of the scsnapshot tool to upgrade configuration data on a cluster. See Example 2.

To use the scsnapshot tool to retrieve configuration data, you need solaris.cluster.resource.read role-based access control (RBAC) authorization. For more information, see the rbac(5) man page.

To track differences between versions of configuration data, store the image files in a source control system such as SCCS.

Upgrading Configuration Data for Resource Groups, Resource Types, and Resources

scsnapshot  [-s scriptfile]  oldimage newimage

The scsnapshot tool generates a shell script that can be used to upgrade the configuration data that is contained in the oldimage file with the configuration data that is contained in the newimage file.

To use the scsnapshot tool to upgrade configuration data, you do not need specific RBAC authorization.

Examples

Example 1 To Generate a Shell Script That Retrieves Configuration Data for Resources Groups, Resource Types, and Resources

The script that is generated in this example is called scriptfile.sh.

example% scsnapshot -s scriptfile.sh

Example 2 To Generate a Shell Script That Retrieves Configuration Data and Stores an Image File

The script that is generated in this example is called scriptfile.sh. The configuration data is stored in an image file called imagefile.

example% scsnapshot -s scriptfile.sh -o imagefile

Example 3 To Generate a Shell Script That Upgrades Configuration Data on One Cluster With Configuration Data From Another Cluster

This example creates a script that upgrades the configuration data on cluster1 to match the configuration data on cluster2. The configuration data for cluster1 is in a file called imagefile1, and the configuration data for cluster2 is in a file called imagefile2. The name of a shell script is not specified, so the generated script is written to the standard output.

example% scsnapshot imagefile1 imagefile2

Exit Status

The following exit status codes are returned:

0: The command completed successfully.
nonzero: An error occurred.

Attributes

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

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Availability	SUNWsczu
Interface Stability	Evolving