cmhaltpkg(1m)cmhaltpkg(1m)NAMEcmhaltpkg - halt a high availability package
SYNOPSIScmhaltpkg [-v] [-t] [-n node_name]... package_name...
cmhaltpkg [-v] [-s] [-n node_name]... package_name...
DESCRIPTIONcmhaltpkg connects to the Serviceguard cluster manager and halts the
specified package(s) or multi-node package instance(s).
When a package or package instance is halted, global switching
(AUTO_RUN) is disabled for that package.
cmhaltpkg may be run on any node within the cluster and may operate on
any package within the cluster.
To halt a package, a user must either be a superuser with effective
user ID of zero (see id(1) and su(1)), or have an access policy of
PACKAGE_ADMIN allowed in the cluster or package configuration file. See
access policy in cmquerycl(1m) or cmmakepkg(1m).
If no node_name arguments are supplied, each package will be halted on
any and all nodes where it is running. If the package is not running on
any nodes, the command will fail.
cmhaltpkg should not be used to halt SYSTEM_MULTI_NODE packages (HP-UX
only). Use cmhaltnode or cmhaltcl to halt SYSTEM_MULTI_NODE packages
instead. Packages of other types may be halted on a subset of the con‐
figured nodes by specifying one or more node_name arguments.
If you execute cmhaltpkg simultaneously on two packages that have an
exclusionary dependency on each other, unexpected behavior may result
(for example, depending on the timing, one of them could be restarted).
cmhaltpkg will fail if each specified package is not running on all the
specified nodes.
Packages are halted in the order required by their configured dependen‐
cies. Packages without configured dependencies are halted in the order
specified on the command line. To successfully halt a package, all
required dependent packages must either be previously halted or speci‐
fied as a package_name argument in the cmhaltpkg command. Packages
configured with STORAGE_GROUP are implicitly dependent on the corre‐
sponding multi-node cluster volume manager (CVM) package. (HP-UX only)
cmhaltpkg validates its command line prior to halting any package and
returns an error if the user does not have correct access to complete
the operation or if illegal combinations of node_name and package_name
arguments are encountered.
If a problem is detected while halting a package, cmhaltpkg exits with
an error indication and remaining package_name arguments are not pro‐
cessed.
A package in maintenance mode that was start up to and including a
specified module can be halted from that specified module. Only those
modules which were started are halted.
Options
cmhaltpkg supports the following options:
-n node_name Acts only on a specific node. If the package is
not running on the specified node, it will not be
halted.
-v Verbose output will be displayed.
-t Test only. Provide an assessment of the package
placement without affecting the current state of
the nodes or packages. This option validates the
node's eligibility with respect to the package
dependencies as well as the external dependencies
such as EMS resources, package subnets, and stor‐
age before predicting any package placement deci‐
sions. This option is not legal for package in
maintenance mode.
-s Symmetric halt is only for packages in mainte‐
nance mode. If a package in maintenance mode has
been started up to a module as specified by
cmrunpkg -m, then cmhaltpkg-s will halt the
package up to that module. Otherwise, cmhaltpkg-s will halt the package for all the modules
specified in its configuration file.
RETURN VALUEcmhaltpkg returns the following value:
0 Successful completion.
1 Command failed.
2 Command failed due to a transient condition.
EXAMPLES
A sequence of cmhaltpkg and cmrunpkg commands may be used to move a
package from one node to another. For example, the package may be
halted on one node and then run on a new node, provided that the pack‐
age is enabled for the new node.
To move package package1 to node node2, do the following:
cmhaltpkg package1
cmrunpkg -n node2 package1
cmmodpkg -e package1 (to enable package switching, if desired)
AUTHORcmhaltpkg was developed by HP.
SEE ALSOcmmakepkg(1m), cmquerycl(1m), cmmodpkg(1m), cmrunpkg(1m), cmviewcl(1m),
cmeval(1m).
Requires Optional Serviceguard Software cmhaltpkg(1m)