背景信息
openGauss提供了gs_om工具帮助对openGauss进行维护,包括启动openGauss、停止openGauss、查询openGauss状态、查询静态配置、生成静态配置文件、查询openGauss状态详细信息、生成动态配置文件、SSL证书替换、显示帮助信息和显示版本号信息等功能。
前提条件
需以操作系统用户omm执行gs_om命令。
语法
- 启动openGauss
gs_om -t start [-h HOSTNAME] [-D dataDir] [--time-out=SECS] [--security-mode=MODE] [-l LOGFILE]
- 停止openGauss
gs_om -t stop [-h HOSTNAME] [-D dataDir] [--time-out=SECS] [-m MODE] [-l LOGFILE]
- 重启openGauss
gs_om -t restart [-h HOSTNAME] [-D dataDir] [--time-out=SECS] [--security-mode=MODE] [-l
LOGFILE] [-m MODE]
- 查询openGauss状态
gs_om -t status [-h HOSTNAME] [-o OUTPUT] [--detail] [--all] [-l LOGFILE]
- 生成静态配置文件
gs_om -t generateconf -X XMLFILE [--distribute] [-l LOGFILE]
- 生成动态配置文件,备机failover或switchover成主机后,需要执行此操作
gs_om -t refreshconf
- 查看静态配置
gs_om -t view [-o OUTPUT]
- 查询openGauss状态详细信息
gs_om -t query [-o OUTPUT]
- SSL证书替换
gs_om -t cert --cert-fire=CERTFILE [-l LOGFILE]
gs_om -t cert --rollback
- 开启、关闭数据库内kerberos认证
gs_om -t kerberos -m [install|uninstall] -U USER [-l LOGFILE] [--krb-client|--krb-server]
- 显示帮助信息
gs_om -? | --help
- 显示版本号信息
gs_om -V | --version
参数说明
gs_om参数可以分为如下几类:
-
通用参数:
– -t
gs_om命令的类型。
取值范围:start、stop、status、generateconf、cert、view、query、
refreshconf、kerberos。
– -l
指定日志文件及存放路径。
默认值:$GAUSSLOG/om/gs_om-YYYY-MM-DD_hhmmss.log(virtualip的
默认值:/tmp/gs_virtualip/gs_om-YYYY-MM-DD_hhmmss.log)
– -?, --help
显示帮助信息。
– -V, --version
显示版本号信息。 -
启动openGauss参数:
– -h
指定需要启动的服务器名称。一次只能启动一个服务器。
取值范围:服务器名称。
不指定服务器名称时,表示启动openGauss。
– -D
指定 dn路径
取值范围:dn路径
不指定dn路径,表示使用静态文件中的dn路径
– --time-out=SECS
指定超时时间,如果超时,om脚本自动退出。单位:s。
取值范围:正整数,建议值300。
默认值:300
– --security-mode
指定是否以安全模式启动数据库。
取值范围:
▪ on以安全模式启动。
▪ off不以安全模式启动,默认不开启安全模式。 -
停止openGauss参数:
– -h
指定需要停止实例所在的服务器名称。一次只能停止一个服务器。
取值范围:实例所在的服务器名称。
不指定服务器名称时,表示停止openGauss。
– -m, --mode=MODE
停止模式设置。
取值范围:支持两种停止模式。
▪ fast方式:保证有主备关系的实例数据是一致的。
▪ immediate方式:不保证有主备关系的实例数据是一致的。
默认值:fast方式。
– --time-out=SECS
指定超时时间,如果超时,om脚本自动退出。单位:s。
取值范围:正整数,建议值300。
默认值:300 -
查询状态参数:
– -h
指定需要待查询的服务器名称。
取值范围:服务器名称。
不指定服务器时,表示查询openGauss。
– -o
输出到指定的output文件中。
如果不指定,直接显示在屏幕上。
– --detail
显示详细信息。如果不指定,只提示该服务器是否正常。 -
生成配置文件参数:
– -X
选择openGauss配置文件路径。
取值范围:cÃñäìžrcÑnfigȇxmÃ的路径。
– --distribute
将静态配置文件发布到openGauss实例的安装目录。 -
开启、关闭数据库内kerberos认证:
– -U
指定数据库部署用户。
取值范围:数据库部署用户
– -m
指定所要进行的操作。
取值范围:
install:开启数据库内kerberos认证。
uninstall:关闭数据库内kerberos认证。
– --krb-server安装kerberos服务端认证。
– --krb-client安装kerberos客户端认证。
注:需要先安装–krb-server,卸载时同步卸载不需要该参数 -
SSL证书替换:
– --cert-file
指定本地SSL证书zip压缩包所在路径。
–rollback
证书回退到上一次成功备份的状态。
示例
- 启动openGauss。
gs_om -t start
Starting cluster.
======================================================================
.
======================================================================
Successfully started .
- 停止openGauss。
gs_om -t stop
Stopping cluster.
=========================================
Successfully stopped cluster.
=========================================
End stop cluster.
- 查看openGauss详细状态信息,含实例状态信息。
gs_om -t status --detail
[ Cluster State ]
cluster_state : Normal
redistributing : No
current_az : AZ_ALL
[ Datanode State ]
node node_ip instance state | node
node_ip instance state
-----------------------------------------------------------------------------------------------------------------------
-------------------------------------------------------------------------
1 hostname1 10.10.10.1 6001 /opt/huawei/install/data/dn1 P Primary Normal | 2 hostname2
10.10.10.2 6002 /opt/huawei/install/data/dn1 S Standby Normal