gs_om

Background

gs_om, provided by openGauss, is used to maintain openGauss. You can use it to start and stop openGauss, query the openGauss status, query static configurations, query openGauss status details, generate static configuration file and dynamic configuration file, replace SSL certificates, query help information, and query the version number.

Prerequisites

Log in to the OS as the OS user omm to run the gs_om command.

Syntax

• Start openGauss.

  gs_om -t start [-h HOSTNAME] [-D dataDir] [--time-out=SECS] [--security-mode=MODE] [-l LOGFILE]
  

• Stop openGauss.

  gs_om -t stop [-h HOSTNAME] [-D dataDir]  [--time-out=SECS] [-m MODE] [-l LOGFILE] 
  

• Restart openGauss.

  gs_om -t restart [-h HOSTNAME] [-D dataDir] [--time-out=SECS] [--security-mode=MODE] [-l LOGFILE] [-m MODE]
  

• Query the openGauss status.

  gs_om -t status [-h HOSTNAME] [-o OUTPUT] [--detail] [--all] [-l LOGFILE]
  

• Generate a static configuration file.

  gs_om -t generateconf -X XMLFILE [--distribute] [-l LOGFILE]
  

• Generate a dynamic configuration file. Perform this operation after the failover or switchover from the standby node to the primary node.

  gs_om -t refreshconf
  

• Display the static configurations.

  gs_om -t view [-o OUTPUT]
  

• Query the openGauss status details.

  gs_om -t query [-o OUTPUT]
  

• Replace SSL certificates.

  gs_om -t cert --cert-file=CERTFILE [-l LOGFILE]
  gs_om -t cert --rollback
  

• Enable or disable the Kerberos authentication in the cluster.

  gs_om -t kerberos -m [install|uninstall] -U USER [-l LOGFILE] [--krb-client|--krb-server]
  

• Display help information.

  gs_om -? | --help
  

• Display version information.

  gs_om -V | --version
  

Parameter Description

The gs_om tool can use the following types of parameters:

• Common parameters

  • -t

    Specifies the command types of gs_om.

    Value range: start, stop, status, generateconf, cert, view, query, refreshconf, and kerberos

  • -l

    Specifies a log file and its storage path.

    Default value: $GAUSSLOG/om/gs_om-YYYY-MM-DD_hhmmss.log (default value for virtualip: /tmp/gs_virtualip/gs_om-YYYY-MM-DD_hhmmss.log)

  • -?, --help

    Displays help information.

  • -V, --version

    Displays version information.

• openGauss startup parameters

  • -h

    Specifies the name of the server to be started. Only one server can be started at a time.

    Value range: a server name

    If no server name is specified, openGauss is started.

  • -D

    Specifies the DN path.

    Value range: a DN path

    If the DN path is not specified, the DN path in the static file is used.

  • --time-out=SECS

    Specifies the timeout threshold. gs_om exits when times out. Unit: s

    Value range: a positive integer. The recommended value is 300.

    Default value: 300

  • --security-mode

    Specifies whether to start the database in secure mode.

    Value range: on: Start the database in secure mode. off: Not start the database in secure mode.

    The secure mode is disabled by default.

• openGauss stop parameters

  • -h

    Specifies the name of the server where the instance to be stopped is located. Only one server can be stopped at a time.

    Value range: the name of the server where the instance is located

    If no server name is specified, openGauss is stopped.

  • -m, --mode=MODE

    Sets the stop mode.

    Value range: the following two stop modes are supported:

    • fast: The data of the primary and standby instance relationship is ensured to be consistent.
    • immediate: The data of the primary and standby instance relationship is not ensured to be consistent.

Default value: fast

• --time-out=SECS

  Specifies the timeout threshold. gs_om exits when times out. Unit: s

  Value range: a positive integer. The recommended value is 300.

  Default value: 300

• Parameters for checking status

  Table 1 describes parameters in the query result.

  • -h

    Specifies the name of the server to be queried.

    Value range: a server name

    If no server name is specified, openGauss is queried.

  • -o

    Outputs status information to the specified output file.

    If the parameter is not output to the specified file, it is displayed on the screen.

  • --detail

    Displays detailed information. If the parameter is not specified, only a prompt is displayed indicating whether the server is normal.

    --all

    Displays information about all openGauss nodes.

• Parameters for generating the configuration file:

  • -X

    Selects the path of the openGauss configuration file.

    Value range: path of the clusterconfig.xml file

  • --distribute

    Publishes the static configuration file to the installation directory of the openGauss instance.

• Parameters for enabling or disabling the Kerberos authentication in the cluster

  • -U

    Specifies a database cluster user.

    Value range: a database cluster deployment user

  • -m

    Specifies the operations to be performed.

    Value range:

    install: Enables the Kerberos authentication in a cluster is enabled.

    uninstall: Disables the Kerberos authentication in a cluster is disabled.

  • --krb-server: Installs the Kerberos server authentication.

  • --krb-client: Installs the Kerberos client authentication.

    Note: You need to use --krb-server to install the server authentication first. These two parameters are not required during the uninstallation because the server and client are uninstalled at the same time.

• Parameters for replacing SSL certificates

  • --cert-file

    Specifies the path of the local SSL certificate .zip package.

    --rollback

    Rolls back the certificates to the last backup.

Table 1 Status description

Table 2 Feature IDs

Example

• Start openGauss.

  gs_om -t start
  Starting cluster.
  ======================================================================
  .
  ======================================================================
  
  Successfully started .
  

• Stop openGauss.

  gs_om -t stop
  Stopping cluster.
  =========================================
  Successfully stopped cluster.
  =========================================
  End stop cluster.
  

• View openGauss status details, including instance status.

  gs_om -t status --detail
  [   Cluster State   ]
  
  cluster_state   : Normal
  redistributing  : No
  
  [  Datanode State   ]
  node          node_ip         instance                                    state            | node          node_ip         instance                                    state            | node          node_ip         instance                                    state
  --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
  

• Run the following commands on openGauss to generate the configuration file:

  gs_om -t generateconf -X  /opt/software/openGauss/clusterconfig.xml  --distribute
  Generating static configuration files for all nodes.
  Creating temp directory to store static configuration files.
  Successfully created the temp directory.
  Generating static configuration files.
  Successfully generated static configuration files.
  Static configuration files for all nodes are saved in /opt/huawei/Bigdata/gaussdb/wisequery/script/static_config_files.
  Distributing static configuration files to all nodes.
  Successfully distributed static configuration files.
  

  Open the generated configuration file directory. You can see three new files.

  cd /opt/huawei/Bigdata/gaussdb/wisequery/script/static_config_files
  ll
  total 456
  -rwxr-xr-x 1 omm dbgrp 155648 2016-07-13 15:51 cluster_static_config_plat1
  -rwxr-xr-x 1 omm dbgrp 155648 2016-07-13 15:51 cluster_static_config_plat2
  -rwxr-xr-x 1 omm dbgrp 155648 2016-07-13 15:51 cluster_static_config_plat3
  

• Roll back SSL certificates.

  gs_om -t cert --rollback 
  [plat1] SSL cert files rollback successfully.
  [plat2] SSL cert files rollback successfully.
  [plat3] SSL cert files rollback successfully.
  

• Register a license.

  gs_om -t license -m register -f MTgsMTkK  
  Preparing for the program initialization.
  Lock the OPS operation of OM components.
  Check and make sure the consistency of the license file.
  Backup the license file on all of the cluster hosts.
  Encrypt the product feature information and generate the license file.
  Send message to the database node instances to reload the license file.
  Remove the backup license file on all of the cluster hosts.
  License register successfully.
  

• Deregister a license.

  gs_om -t license -m unregister -f MTgsMTkK
  Preparing for the program initialization.
  Lock the OPS operation of OM components.
  Check and make sure the consistency of the license file.
  Backup the license file on all of the cluster hosts.
  Encrypt the product feature information and generate the license file.
  Send message to the database node instances to reload the license file.
  Remove the backup license file on all of the cluster hosts.
  License unregister successfully.