Jump to content United States-English
HP.com Home Products and Services Support and Drivers Solutions How to Buy
 Contact HP
More options
HP.com home
Managing Serviceguard Fifteenth Edition

Appendix A Serviceguard Commands

 

Technical documentation

Complete book in PDF
Feedback
Content starts here

  Table of Contents

  Index

The following is an alphabetical list of commands used for Serviceguard cluster configuration and maintenance. Manpages for these commands are available on your system after installation.

NOTE: Check the Serviceguard, SGeRAC, and SMS Compatibility and Feature Matrix and the latest Release Notes for your version of Serviceguard for up-to-date information about support for Cluster Volume manager (CVM) and Cluster File System (CFS): http://www.docs.hp.com -> High Availability -> Serviceguard.

Table A-1 Serviceguard Commands

CommandDescription
cfscluster
  • Configure or unconfigure SG-CFS-pkg, the system multi-node package used for clusters that use the Veritas Cluster File System.

  • Start or stop the CVM package for the CFS.

  • Get the status of the SG-CFS-pkg package.

Requires selected HP Serviceguard Storage Management Suite Bundle.

cfsdgadm
  • Display the status of CFS disk groups.

  • Add shared disk groups to a Veritas Cluster File System CFS cluster configuration, or remove existing CFS disk groups from the configuration.

    Serviceguard automatically creates the multi-node package SG-CFS-DG-id# to regulate the disk groups. This package has a dependency on the SG-CFS-pkg created by cfscluster command.

  • Activate or de-activate the shared disk groups, clusterwide or on specified node(s).

Requires selected HP Serviceguard Storage Management Suite Bundle.

The cmgetpkgenv command, below, displays information about the environment.

cfsmntadm

Add, delete, modify, or set policy on mounted filesystems in a Veritas Cluster File System (CFS) cluster.

Requires selected HP Serviceguard Storage Management Suite Bundle.

cfsmount
cfsumount

Mount or unmount a Veritas Cluster File System.

The cmgetpkgenv command, below, displays status.

Requires selected HP Serviceguard Storage Management Suite Bundle.

cmapplyconf

Verify and apply Serviceguard cluster configuration and package configuration files.

cmapplyconf verifies the cluster configuration and package configuration specified in the cluster_ascii_file and the associated pkg_ascii_file(s), creates or updates the binary configuration file, called cmclconfig, and distributes it to all nodes. This binary configuration file contains the cluster configuration information as well as package configuration information for all packages specified. This file, which is used by the cluster daemons to manage the entire cluster and package environment, is kept in the /etc/cmcluster directory.

If changes to either the cluster configuration or to any of the package configuration files are needed, first update the appropriate ASCII file(s) (cluster or package), then validate the changes using the cmcheckconf command and then use cmapplyconf again to verify and redistribute the binary file to all nodes. The cluster and package configuration can be modified only when the cluster is down. The cluster ASCII file only needs to be specified if configuring the cluster for the first time, or if adding or deleting nodes to the cluster. The package ASCII file only needs to be specified if the package is being added, or if the package configuration is being modified.

cmapplyconf (continued)

Run cmgetconf to get either the cluster configuration file or package configuration file whenever changes to the existing configuration are required.

Note that cmapplyconf will verify and distribute cluster configuration or package files. It will not cause the cluster daemon to start or be removed from the cluster configuration. The same kind of processing will apply to the package configuration to determine whether to add or delete package nodes, package subnet, etc. All package configuration changes require the package to be halted.

cmcheckconf

Check high availability cluster configuration and/or package configuration files.

cmcheckconf verifies the cluster configuration as specified by the cluster_ascii_file and/or the package configuration files specified by each pkg_ascii_file in the command. If the cluster has already been configured previously, the cmcheckconf command will compare the configuration in the cluster_ascii_file against the previously configuration information stored in the binary configuration file and validates the changes. The same rules apply to the pkg_ascii_file. It is necessary to halt the cluster to run the cmcheckconf command.

cmdeleteconf

Delete either the cluster or the package configuration.

cmdeleteconf deletes either the entire cluster configuration, including all its packages, or only the specified package configuration. If neither cluster_name nor package_name is specified, cmdeleteconf will delete the local cluster’s configuration and all its packages. If only the package_name is specified, the configuration of package_name in the local cluster is deleted. If both cluster_name and package_name are specified, the package must be configured in the cluster_name, and only the package package_name will be deleted. The local cluster is the cluster that the node running the cmdeleteconf command belongs to.

cmgetconf

Get cluster or package configuration information.

cmgetconf obtains either the cluster configuration, not including the package configuration, or the specified package’s configuration information, and writes to either the output_filename file, or to stdout. This command can be run whether the cluster is up or down. If neither cluster_name nor package_name is specified, cmgetconf will obtain the local cluster’s configuration. If both cluster_name and package_name are specified, the package must be configured in the cluster_name, and only the package configuration for package_name will be written to output_filename or to stdout.

cmgetpkgenv

Allows the Veritas Cluster File System (CFS) admin packages to retrieve their configured values from the context of the package control script.

Requires selected HP Serviceguard Storage Management Suite Bundle.

cmhaltcl

Halt a high availability cluster.

cmhaltcl causes all nodes in a configured cluster to stop their cluster daemons, optionally halting all packages or applications in the process.

This command will halt all the daemons on all currently running systems. If the user only wants to shutdown a subset of daemons, the cmhaltnode command should be used instead.

cmhaltnode

Halt a node in a high availability cluster.

cmhaltnode causes a node to halt its cluster daemon and remove itself from the existing cluster.

When cmhaltnode is run on a node, the cluster daemon is halted and, optionally, all packages that were running on that node are moved to other nodes if possible.

If node_name is not specified, the cluster daemon running on the local node will be halted and removed from the existing cluster.

cmhaltpkg

Halt a high availability package.

cmhaltpkg performs a manual halt of high availability package(s) running on Serviceguard clusters. This command may be run on any node within the cluster and may operate on any package within the cluster.

cmhaltserv

Halt a service from the high availability package halt script. This is not a command line executable command, it runs only from within the package control script.

cmhaltserv is used in the high availability package halt script to halt a service. If any part of package is marked down, the package halt script is executed as part of the recovery process.

This command sends a SIGTERM signal to the PID and the corresponding process group of the monitored service. If this signal is caught by the running application, it is up to the application to ensure that the processes will be terminated.

cmmakepkg

Create a high availability package template file.

cmmakepkg creates a template package configuration file (or package control script for a legacy package). The template file should be customized for a specific package, then verified by the cmcheckconf command before being applied (cmapplyconf). If you do not provide an output_file_name, output goes to stdout.

See “Package Configuration Planning ”; Chapter 6 “Configuring Packages and Their Services”; “Configuring a Legacy Package”; and “Reconfiguring a Package”.

cmmodnet

Add or remove an address from a high availability cluster.

cmmodnet is used to add or remove a relocatable package IP_address for the current network interface running the given subnet_name.

cmmodnet can also be used to enable or disable a LAN_name currently configured in a cluster. (Note that if you use cmmodnet to disable a LAN_name on a node that subsequently leaves the cluster, the LAN_name will be re-enabled if the node then rejoins the cluster.)

Extreme caution should be exercised when executing this command outside the context of a package. It should only be used to remove the relocatable IP addresses of packages which have failed and are in the “halted” state, or to enable or disable a LAN interface when absolutely necessary. Use while the package is running could lead to loss of client connectivity.

cmmodpkg

Enable or disable switching attributes for a high availability package.

cmmodpkg enables or disables the ability of a package to switch to another node upon failure of the package, and it enables or disables a particular node from running specific packages. Switching for a package can be enabled or disabled globally. For example, if a globally disabled package fails, it will not switch to any other node, and if a globally enabled package fails, it will attempt to switch to the first available node on which it is configured to run.

cmquerycl

Query cluster or node configuration information.

cmquerycl searches all specified nodes for cluster configuration and Logical Volume Manager (LVM) information. Cluster configuration information includes network information such as LAN interface, IP addresses, bridged networks and possible heartbeat networks. LVM information includes volume group (VG) interconnection and file system mount point information. This command should be run as the first step in preparing for cluster configuration. See “Configuring the Cluster ”. It can also be used as a troubleshooting tool to identify the current configuration of a cluster.

NOTE:

Use cmquerycl -c <cluster_name> -C <filename> to produce a text file (filename) showing the current configuration of the cluster, with additional, commented-out, entries for network subnets that are not currently part of the the cluster configuration, but can be configured into it. See “Changing the Cluster Networking Configuration while the Cluster Is Running”.

cmreadlog

Format an Object Manager log file for easy display.

This command reads the log files created by Object Manager in the Managed Object File (MOF) format and displays them in a report with one entry per line. Use the command when troubleshooting or reviewing Object Manager activity.

cmruncl

Run a high availability cluster.

cmruncl causes all nodes in a configured cluster or all nodes specified to start their cluster daemons and form a new cluster.This command should only be run when the cluster is not active on any of the configured nodes. If a cluster is already running on a subset of the nodes, the cmrunnode command should be used to start the remaining nodes and force them to join the existing cluster.

cmrunnode

Run a node in a high availability cluster.

cmrunnode causes a node to start its cluster daemon to join the existing cluster

Starting a node will not cause any active packages to be moved to the new node. However, if a package is DOWN, has its switching enabled, and is able to run on the new node, that package will automatically run there.

cmrunpkg

Run a high availability package.

cmrunpkg runs a high availability package(s) that was previously halted.This command may be run on any node within the cluster and may operate on any package within the cluster. If a node is not specified, the node on which the command is run will be used. This will result in an error if the current node is not able to run the package or is not in the list of possible owners of the package. When a package is started on a new node, the package’s run script is executed.

cmrunserv

Run a service from the high availability package run script. This is not a command line executable command, it runs only from within the package control script.

cmrunserv is used in the high availability package run script to run a service. If the service process dies, cmrunserv updates the status of the service to down. The cluster software will recognize the change in status and execute the normal package recovery sequence. This includes executing the package halt script, determining if the package can be run on a different node, and if so, executing the package run script on the new node.

Should the service_command be halted by the cmhaltserv command, a SIGTERM signal will be sent to the process. This executable or shell script should be able to handle a SIGTERM signal and execute a graceful shutdown performing any cleanup necessary. If the process ignores the SIGTERM, a SIGKILL will be sent to the process. If a SIGKILL is sent, the process will die immediately and will be unable to perform any cleanup.

cmscancl

Gather system configuration information from nodes with Serviceguard installed.

cmscancl is a configuration report and diagnostic tool which gathers system software and hardware configuration information from a list of nodes, or from all the nodes in a cluster. The information that this command displays includes LAN device configuration, network status and interfaces, file systems, LVM configuration, link-level connectivity, and the data from the binary cluster configuration file. This command can be used as a troubleshooting tool or as a data collection tool.

If output _file is not specified, the information will be directed to /tmp/scancl.out. Output file contains:

  • A listing of all Serviceguard products installed on each node in the cluster

  • LAN device configuration (output from lanscan)

  • network status and interfaces (output from netstat)

  • file systems (output from mount)

  • LVM configuration (contents of /etc/lvmtab file)

  • LVM physical vg information (contents of /etc/lvmpvg file)

  • link-level connectivity (output from linkloop)

  • binary configuration file data (output from cmviewconf)

cmstartres

This command is run by package control scripts, and not by users!

Starts resource monitoring on the local node for an EMS resource that is configured in a Serviceguard package.

cmstartres starts resource monitoring for an EMS resource on the local node. This resource must be configured in the specified package_name.

cmstopres

This command is run by package control scripts, and not by users!

cmstopres stops resource monitoring for an EMS resource on the local node. This resource must be configured in the specified package_name.

cmversion

Returns the version of Serviceguard installed on the system where the command is issued.

cmviewcl

View information about the current high availability cluster.

cmviewcl displays the current status information of a cluster. Output can be displayed for the whole cluster or it may be limited to particular nodes or packages.

Information can be formatted in tabulated form, which is organized for viewing, or in line format, which is designed for scripts to easily parse.

cmviewconf

View Serviceguard cluster configuration information.

cmviewconf collects and displays the cluster configuration information, in ASCII format, from the binary configuration file for an existing cluster. Optionally, the output can be written to a file. This command can be used as a troubleshooting tool to identify the configuration of a cluster.

 

Printable version
Privacy statement Using this site means you accept its terms Feedback to webmaster
Hewlett-Packard Development Company, L.P.