Appendix B Sun Cluster Man Page Quick Reference

This appendix contains a quick reference to the syntax and descriptions for all the commands and utilities associated with the Sun Cluster framework and the Sun Cluster data services. They are presented in alphabetical order within their appropriate man page section.

The complete man pages described in this appendix are available online by using the man(1) command.

B.1 Man1

• cconsole(1) - Provides multi-window, multi-machine remote console access.

  cconsole [clustername ...|hostname ...]

• ccp(1) - Starts the Sun Cluster Cluster Control Panel GUI.

  ccp [clustername]

• chosts(1) - Expands the arguments into a list of host names or cluster name.

  chosts name [name ...]

• cports(1) - Expands the hostname arguments into a list of host, server, port triples.

  cports hostname [hostname ...]

• crlogin(1) - Provides multi-window, multi-machine remote login access.

  crlogin [-l user] [clustername|hostname ...]

• ctelnet(1) - Provides multi-window, multi-machine remote telnet access.

  ctelnet [clustername ...|hostname]

• lktest(1) - Tests the state of the Distributed Lock Manager (DLM).

  lktest [-q]

B.2 Man1M

• ccdadm(1M) - Provides administrative services to the Cluster Configuration Database (CCD).

  ccdadm clustername -r restore_file [-t timeout] ccdadm clustername -c checkpoint_file [-t timeout] ccdadm clustername -q quorum_flag [-t timeout] ccdadm clustername [-vdh] [-t timeout] ccdadm -p candidate_file [-t timeout] ccdadm -x candidate_file [-t timeout]

• ccdctl(1M) - The ccdctl command is used to control the starting, reconfiguring, and stopping of the ccdd(1m) server.

  ccdctl transition clustername timeout [restart]

• ccdd(1M) - The ccdd server performs the initialization, update, query, and reconfiguration of the Cluster Configuration Database (CCD).

  ccdd

• ccdinstall(1M) - This allows the Sun Cluster installation program, scinstall(1m), to update either the initial (ccd.database.init) or dynamic (ccd.database) instance of the CCD with package-specific information.

  ccdinstall [-i] add component_file ccdinstall [-i] rem key component_file

• confccdssa(1M) - Configures an SSVM mirrored volume for use as a highly-available file system to store the CCD database.

  confccdssa clustername

• finddevices(1M) - Probes a Sun Cluster for disk devices and array controllers.

  finddevices finddevices ssa finddevices disks [cX] finddevices rootdev

• get_ci_status(1M) - Displays the cluster configuration, the SCI adapter status and the SMA session status.

  get_ci_status [-l]

• get_node_status(1M) - Prints the current status of certain Sun Cluster software on the local node.

  get_node_status

• ha_fault_mon_config(1M) - Gets or sets NFS fault monitoring configuration parameters.

  ha_fault_mon_config get ParameterName ha_fault_mon_config set ParameterName NewValue

• hactl(1M) - Provides various cluster control operations.

  hactl [-n] -t|-g -s service_name -l|-p hostname [-L severity] [-k cluster_key] hactl [-n] -r -s service_name [-k cluster_key] hactl -f fieldname

• hadsconfig(1M) - HA data services configuration command.

  hadsconfig

• haget(1M) - Queries the current state of the cluster HA configuration.

  haget [-S] [-a APIversion] -f fieldname [-h hostname] [-s dataservicename]

• hainformix(1M) - Sun Cluster HA for Informix administration command.

  hainformix [-s] command [server] [datafield1 ...]

• halockrun(1M) - Runs a child program while holding a lock file.

  halockrun [-vsn] [-e exitcode] lockfilename prog [args]

• haoracle(1M) - Sun Cluster HA for Oracle administration command.

  haoracle [-s] command [instance] [datafield1 ...]

• hareg(1M) - Registers Sun Cluster data services.

  hareg -r service_name -m method=path [, method=path ...] [-b basedir] [-t method=timeout [, method=timeout ...] [-d depends_on_service ...] [-h logical_host ...] [-v service_version] [-a APIversion] [-p pkg ...] hareg -s -r Sun_service_name [-h logical_host ...] hareg -u service_name hareg -q service_name [-M method|-T method|-D|-H|-V|-A|-P|-B] hareg -y|-n service_name ... hareg [-Y|-N]

• hasap_dbms(1M) - .Set dependencies and modify timeouts for the Sun Cluster HA for SAP data service

  hasap_dbms -d depends_on_svc[depends_on_svc]... hasap_dbms -r hasap_dbms -d method=timeout[method=timeout]... hasap_dbms -r

• hasap_start_all_instances(1M), hasap_stop_all_instance(1M)- .Scripts called from the Sun Cluster HA for SAP data service code that should be customized to start and stop all application servers and test or development instances.

  hasap_start_all_instances Instance-Name Context Timeout hasap_stop_all_instances Instance-Name Context Timeout

• hastat(1M) - Monitors status of Sun Cluster configurations.

  hastat [-i interval] [-m message-lines]

• haswitch(1M) - Performs a switchover of services or a cluster reconfiguration in a Sun Cluster configuration.

  haswitch destination_hostname logicalhostname ... haswitch -m logicalhostname ... haswitch -r

• hasybase(1M) - Sun Cluster HA for Sybase administration command.

  hasybase [-s] command [server] [datafield1 ...]

• hatimerun(1M) - Provides a convenient facility for timing out the execution of another (child) program.

  hatimerun [-va] [-k signalname] [-e exitcode] -t timeOutSecs prog args

• lkdbx(1M) - Runs the Interactive Distributed Lock Manager (DLM).

  lkdbx [options]

• pmfadm(1M) - Provides the administrative command-line interface to the process monitor facility.

  pmfadm -c nametag [-n retries] [-t period] [-a action] command [args_to_command ...] pmfadm -m nametag [-n retries] [-t period] pmfadm -s nametag [-w timeout] [signal] pmfadm -k nametag [-w timeout] [signal] pmfadm -l nametag [-h host] pmfadm -q nametag [-h host]

• pnmd(1M) - The Public Network Management (PNM) service daemon.

  pnmd [-s]

• pnmptor(1M) - Maps the pseudo adapter name to the real adapter name in a NAFO backup group.

  pnmptor p_adpname

• pnmrtop(1M) - Maps the real adapter name to the pseudo adapter name in a NAFO backup group.

  pnmrtop r_adpname

• pnmset(1M) - Sets up the configuration for PNM (Public Network Management).

  pnmset [-s] [-f filename] [-n [-t]] [-v]

• pnmstat(1M) - Reports the status for NAFO backup groups monitored by PNM.

  pnmstat [-d] [-l|[[[-s] -h hostname] [-c p_adpname]]]

• rpc.pmfd(1M) - RPC-based process monitor server.

  rpc.pmfd

• scadmin(1M) - Starts up or shuts down a cluster.

  scadmin [-af] startcluster localnode clustname scadmin [-af] startnode [clustname] scadmin [-a] stopnode [clustname] scadmin abortpartition localnode clustname scadmin continuepartition localnode clustname scadmin reldisks [clustname] scadmin resdisks [clustname] scadmin reserve disk scadmin switch clustname [-m] logical-hosts ... scadmin switch clustname dest-host logical-hosts ... scadmin switch clustname -r

• scconf(1M) - Creates or modifies cluster system configuration.

  scconf clustname -h hostname1 [... hostname4] scconf clustname -i hostname if0 if1 scconf clustname -F logicalhost [disk-group] scconf clustname -L logicalhost -n nodelist -g dglist -i logaddrinfo [-m] scconf clustname -L logicalhost -r scconf clustname -s data-service-name logicalhost-name scconf clustname -s -r data-service-name logicalhost-name scconf clustname -p scconf clustname [+|-] D scconf clustname -q [-m quorum-device] hostname1 hostname2 scconf clustname -q -D [-m quorum-device] scconf clustname -U [config-file-for-Oracle-Unix-DLM] scconf clustname -N 0|1|2|3 ethernet-address-of-host scconf clustname -A number-of-active-hosts scconf clustname -S none|ccdvol scconf clustname -T new-step10-and-11-timeout-value scconf clustname -l new-loghost-timeout-value scconf clustname -H hostname [-dpt] scconf clustname -t old-ip-address|TC-name [-iPl] scconf clustname -R data-service-name [data-service-name ...]

• scdidadm(1M) - Configures and administers disk ID configurations that have Solstice DiskSuite as their volume manager.

  scdidadm -r [-H hostname, ...] scdidadm -R path|instance_number scdidadm -l|-L [-h] [-o fmt] [path|instance_number]

• scinstall(1M) - Installs Sun Cluster software on the Sun Cluster servers, and sets up the configuration.

  scinstall -i [-a|c|s] [-d package dir] [-A admin file] scinstall -u [-a|c|s] [-d package dir] [-A admin file] scinstall -l [-d package dir] scinstall [-d package dir] scinstall [-V|h|o]

• sm_config(1M)-This is the SCI adapter configuration utility for clusters.

  sm_config [-t] -f filename

• sma_configd(1M)-This is the SCI adapter configuration daemon process.

  sma_configd [-i] [-t]

B.3 Man3HA

• ha_close(3HA) - Once a data service has finished with a snapshot by some previous call to ha_open(3HA), the data service should call ha_close(3HA) to release the snapshot, the handle, and all associated memory.

  cc [flag ...] - I/opt/SUNWcluster/include file ... - L /opt/SUNWcluster/lib [threads lib] -lhads -lintl -ldl [library ...] #include <hads.h> ha_error_t ha_open(ha_handle_t *handlep); ha_error_t ha_close(ha_handle_t handle);

• ha_get_calls(3HA) - These are used by data services to obtain selected Sun Cluster configuration and state information as recorded by snapshot by some previous call to ha_open(3HA).

  cc [flag ...] - I/opt/SUNWcluster/include file ... - L /opt/SUNWcluster/lib [threads lib] -lhads -lintl -ldl [library ...] #include <hads.h> ha_error_t ha_getconfig(ha_handle_t handle, ha_config_t **config); ha_error_t ha_getcurstate(ha_handle_t handle, ha_lhost_dyn_t **lhosts[]); ha_error_t ha_getmastered(ha_handle_t handle, ha_lhost_dyn_t **lhosts[]); ha_error_t ha_getnotmastered(ha_handle_t handle, ha_lhost_dyn_t **lhosts[]); ha_error_t ha_getonoff(ha_handle_t handle, char *service_name, boolean_t *ison); ha_error_t ha_getlogfacility(ha_handle_t handle, int *facility);

• ha_getconfig - This is used by data services to obtain selected Sun Cluster configuration and state information as recorded by snapshot by some previous call to ha_open(3HA).

  cc [flag ...] - I/opt/SUNWcluster/include file ... - L /opt/SUNWcluster/lib [threads lib] -lhads -lintl -ldl [library ...] #include <hads.h> ha_error_t ha_getconfig(ha_handle_t handle, ha_config_t **config); ha_error_t ha_getcurstate(ha_handle_t handle, ha_lhost_dyn_t **lhosts[]); ha_error_t ha_getmastered(ha_handle_t handle, ha_lhost_dyn_t **lhosts[]); ha_error_t ha_getnotmastered(ha_handle_t handle, ha_lhost_dyn_t **lhosts[]); ha_error_t ha_getonoff(ha_handle_t handle, char *service_name , boolean_t *ison); ha_error_t ha_getlogfacility(ha_handle_t handle, int *facility);

• ha_getcurstate - This is used by data services to obtain selected Sun Cluster configuration and state information as recorded by snapshot by a previous call to ha_open(3HA).

  cc [flag ...] - I/opt/SUNWcluster/include file ... - L /opt/SUNWcluster/lib [threads lib] -lhads -lintl -ldl [library ...] #include <hads.h> ha_error_t ha_getconfig(ha_handle_t handle, ha_config_t **config); ha_error_t ha_getcurstate(ha_handle_t handle, ha_lhost_dyn_t **lhosts[]); ha_error_t ha_getmastered(ha_handle_t handle, ha_lhost_dyn_t **lhosts[]); ha_error_t ha_getnotmastered(ha_handle_t handle, ha_lhost_dyn_t **lhosts[]); ha_error_t ha_getonoff(ha_handle_t handle, char *service_name, boolean_t *ison); ha_error_t ha_getlogfacility(ha_handle_t handle, int *facility);

• ha_getlogfacility - This is used by data services to obtain selected Sun Cluster configuration and state information as recorded by snapshot by a previous call to ha_open(3HA).

  cc [flag ...] - I/opt/SUNWcluster/include file ... - L /opt/SUNWcluster/lib [threads lib] -lhads -lintl -ldl [library ...] #include <hads.h> ha_error_t ha_getconfig(ha_handle_t handle, ha_config_t **config); ha_error_t ha_getcurstate(ha_handle_t handle, ha_lhost_dyn_t **lhosts[]); ha_error_t ha_getmastered(ha_handle_t handle, ha_lhost_dyn_t **lhosts[]); ha_error_t ha_getnotmastered(ha_handle_t handle, ha_lhost_dyn_t **lhosts[]); ha_error_t ha_getonoff(ha_handle_t handle, char *service_name, boolean_t *ison); ha_error_t ha_getlogfacility(ha_handle_t handle, int *facility);

• ha_getmastered - This is used by data services to obtain selected Sun Cluster configuration and state information as recorded by snapshot by a previous call to ha_open(3HA).

  cc [flag ...] - I/opt/SUNWcluster/include file ... - L /opt/SUNWcluster/lib [threads lib] -lhads -lintl -ldl [library ...] #include <hads.h> ha_error_t ha_getconfig(ha_handle_t handle, ha_config_t **config); ha_error_t ha_getcurstate(ha_handle_t handle, ha_lhost_dyn_t **lhosts[]); ha_error_t ha_getmastered(ha_handle_t handle, ha_lhost_dyn_t **lhosts[]); ha_error_t ha_getnotmastered(ha_handle_t handle, ha_lhost_dyn_t **lhosts[]); ha_error_t ha_getonoff(ha_handle_t handle, char *service_name, boolean_t *ison); ha_error_t ha_getlogfacility(ha_handle_t handle, int *facility);

• ha_getmastered - This is used by data services to obtain selected Sun Cluster configuration and state information as recorded by snapshot by a previous call to ha_open(3HA).

  cc [flag ...] - I/opt/SUNWcluster/include file ... - L /opt/SUNWcluster/lib [threads lib] -lhads -lintl -ldl [library ...] #include <hads.h> ha_error_t ha_getconfig(ha_handle_t handle, ha_config_t **config); ha_error_t ha_getcurstate(ha_handle_t handle, ha_lhost_dyn_t **lhosts[]); ha_error_t ha_getmastered(ha_handle_t handle, ha_lhost_dyn_t **lhosts[]); ha_error_t ha_getnotmastered(ha_handle_t handle, ha_lhost_dyn_t **lhosts[]); ha_error_t ha_getonoff(ha_handle_t handle, char *service_name, boolean_t *ison); ha_error_t ha_getlogfacility(ha_handle_t handle, int *facility);

• ha_getonoff - This is used by data services to obtain selected Sun Cluster configuration and state information as recorded by snapshot by a previous call to ha_open(3HA).

  cc [flag ...] - I/opt/SUNWcluster/include file ... - L /opt/SUNWcluster/lib [threads lib] -lhads -lintl -ldl [library ...] #include <hads.h> ha_error_t ha_getconfig(ha_handle_t handle, ha_config_t **config); ha_error_t ha_getcurstate(ha_handle_t handle, ha_lhost_dyn_t **lhosts[]); ha_error_t ha_getmastered(ha_handle_t handle, ha_lhost_dyn_t **lhosts[]); ha_error_t ha_getnotmastered(ha_handle_t handle, ha_lhost_dyn_t **lhosts[]); ha_error_t ha_getonoff(ha_handle_t handle, char *service_name, boolean_t *ison); ha_error_t ha_getlogfacility(ha_handle_t handle, int *facility);

• ha_open(3HA) - Obtains a snapshot of the current state of the Sun Cluster environment.

  cc [flag ...] - I/opt/SUNWcluster/include file ... - L /opt/SUNWcluster/lib [threads lib] -lhads -lintl -ldl [library ...] #include <hads.h> ha_error_t ha_open(ha_handle_t *handlep); ha_error_t ha_close(ha_handle_t handle);

• hads -- The hads library routines provide a programming interface for the addition of data service modules to a Sun Cluster server cluster.

  cc [flag ...] -I /opt/SUNWcluster/include file ... -L /opt/SUNWcluster/lib [threads lib] -lhads -lintl -ldl [library ...] #include <hads.h>

B.4 Man4

• ccd(4) - The Cluster Configuration Database (CCD) is a highly-available, replicated database whose main purpose is to provide a single cluster-wide namespace and configuration repository for the cluster software components for the HA framework.

  ccd

• clusters(4) - The clusters file contains information regarding the known clusters in the local naming domain. For each cluster a single line should be present with the following information:

  [clustername ...|hostname ...]

• hainformix_config_V1(4) - The configuration file for Sun Cluster HA for Informix fault monitor.

  hainformix_config_V1

• hainformix_support(4) - The table of Sun Cluster HA for Informix releases supported by Sun Cluster.

  hainformix_support

• haoracle_config_V1(4) - The configuration file for Sun Cluster HA for Oracle fault monitor.

  haoracle_config_V1

• haoracle_support(4) - The table of Sun Cluster HA for Oracle releases supported by Sun Cluster.

  haoracle_support

• hasybase_config_V1(4) - The configuration file for Sun Cluster HA for Sybase fault monitor.

  hasybase_config_V1

• hasybase_support(4) - The table of Sun Cluster HA for Sybase releases supported by Sun Cluster.

  hasybase_support

• ora_cdb(4) -This file contains configuration information that will be used by the Oracle Unix DLM during start-up.

  clustername.ora_cdb

• pnmconfig(4) - Public Network Management (PNM) configuration file for Network Adapter Failover (NAFO). This file contains the configuration information for PNM.

  pnmconfig

• serialports(4) - The serialports NIS or NIS+ database maps a name to a servername and TCP port number that represents the serial port connected to the specified terminal server host.

  [hostname ...|concentrator hostname ...|tcp port number ...]

B.5 Man7

• did(7) - User-configurable pseudo device driver used to run Solstice DiskSuite in an N+1 configuration.

  did

• mond(7) - System configuration and status reporting daemon.

  in.mond

• smond(7) - This is the super monitor daemon that gathers system configuration and status information from several Sun Cluster 2.0 systems and passes the same to the SNMP agent on the local host.

  smond -h clustername1|hostname1 clustername2|host-name2 ... smond -p port number smond -c config_file

• smond_conf(7) - A utility script useful for configuring the supermonitor daemon's configuration file.

  smond_conf -h clustername1|hostname1 clustername2|hostname2 ...

• smond_ctl(7) - Starts or stops the super monitor daemon on the localhost.

  smond_ctl [start|stop]

• snmpd(7) - The Sun Cluster SNMP Agent is an RFC 1157-compliant SNMP agent.

  snmpd [-r] [-p port] [-a] [-c config-file] [-T trace-level]