ycsctl add node

该命令用于在集群部署阶段向集群中添加一个实例节点，集群部署完成后，无法使用该命令。

Note:

安装部署YashanDB时，会内部调用执行添加实例节点的操作，无需手动执行该命令。

该命令用于在集群部署阶段向集群中添加一个节点。安装部署时执行，命令后加offline；扩容时执行，命令后不加offline。命令格式如下：

ycsctl add node <nodename> <yascs_url> [--vip <vip_config>] [-p <port>]

参数选项	取值	参数描述
	nodename	为待添加的实例节点指定名称，要求与节点所在服务器名称一致且全局唯一，长度为4 ~ 64个字符，支持字母、数字、连字符（-）以及下划线（_），且必须以字母开头。
	yascs_url	指定实例节点对应服务器的IP地址及端口，格式为：IPv4:PORT/[IPv6]:PORT，例如192.168.1.2:1770或[fc00:7::126]:1688，IP地址具体规格可参考yasql使用指导。 该地址将用于集群各个实例节点间内部互联，需保证所指定的IP地址之间路由可达、端口号不冲突。
--vip	vip_config	可选参数，指定实例节点对应服务器的VIP资源配置信息，格式为：IP地址/子网掩码[/网卡名]，例如：192.168.60.4/255.255.255.0/ens192或fc00:60::4/64/enp1s0，具体功能说明请查阅VIP管理。
-p	port_number	可选参数，指定实例节点对应服务器的服务端口号，数据库实例和VIP资源都会监听该端口。 必须和此服务器上的数据库实例配置参数LISTEN_ADDR的端口号一致。

ycsctl extend node

该命令用于动态扩容新节点到当前集群，或清理未完成节点扩容的残留配置。

命令格式及参数介绍如下：

ycsctl extend node <-f | --clean> [--post-db]

参数选项	取值	参数描述
-f	filename	指定新节点的配置文件绝对路径。
--clean		清理未完成节点扩容的残留配置。
--post-db		当集群数据库已完成实例添加时必须指定此参数。

ycsctl modify node

该命令用于离线调整集群的实例节点的相关属性。

该操作的完整步骤大致如下：

1. 停止集群。
2. 启动yasfs服务。
3. 执行本命令调整对应属性。
4. 停止yasfs服务。
5. 启动集群。

命令格式及参数介绍如下：

ycsctl modify node <name> [-nodename <newname>] [-port <newport>] [-url <newurl>]

参数选项	取值	参数描述
	name	指定待执行当前操作的目标实例节点名称，必须是目标数据库资源中已存在的节点名称。
-nodename	newname	指定新的节点名称，必须在目标数据库资源的中全局唯一。
-port	newport	指定新的数据库监听端口，必须为可用的空闲端口。
-url	newurl	指定新的YCS监听地址，格式为IP:PORT，必须为可用的IP地址和空闲端口。

ycsctl start ycs

该命令用于启动当前服务器上的YCS及其所管理的资源。启动YCS时是否同时启动YashanDB数据库由AUTO_START参数控制。

命令格式及参数介绍如下：

ycsctl start ycs [-startoption <startoption>] [-p <password>]

参数选项	取值	参数描述
-startoption -m	NOMOUNT、MOUNT或OPEN	可选参数，指定数据库实例默认的启动阶段选项，省略时默认使用ycsctl add database命令指定的启动选项。
-p	wallet_password	可选参数，指定数据库实例进行密钥管理的钱包的密码。 当共享集群/分布式集群已有加密对象且需要直接启动数据库到MOUNT或OPEN模式时必须指定，否则数据库实例会启动失败。

Note:

请使用-startoption选项指定启动模式，-m选项已过时，保留仅用于兼容。

ycsctl stop ycs

该命令用于停止当前服务器上的YCS，及其所管理的资源。

命令格式如下：

ycsctl stop ycs

ycsctl start osw

该命令用于启动当前YCS的OS Watcher。

命令格式如下：

ycsctl start osw

ycsctl stop osw

该命令用于停止当前YCS的OS Watcher。

Note:

关于YCS OS Watcher的详细介绍，请查阅操作系统负载监控。

命令格式如下：

ycsctl stop osw

ycsctl get

该命令用于查看当前服务器上YCS节点级参数项的值。

命令格式及参数介绍如下：

ycsctl get <parameter>

参数值	参数描述
parameter	指定待查看的参数名，大小写不敏感。

ycsctl set

该命令用于在线设置当前服务器上YCS节点级参数项（非只读参数）的值。

Note:

对于AUTO_START，本命令仅修改其在配置文件中的值，实际生效还需重启YCS。

命令格式及参数介绍如下：

ycsctl set <parameter> <value>

参数值	参数描述
parameter	指定待修改的参数名，大小写不敏感。
value	指定为对应参数的取值范围中的某个值。

ycsctl show parameter

该命令用于查看当前服务器上所有YCS节点级参数项的配置。

命令格式如下：

ycsctl show parameter