
# 使用ucs-ctl命令行工具管理本地集群
ucs-ctl是管理UCS本地集群的命令行工具，它仅适用于UCS本地集群。
在使用ucs-ctl工具前，为防止您执行被篡改的ucs-ctl工具，请先进行工具的完整性校验，具体操作请参考[安装及验证](https://support.huaweicloud.com/usermanual-ucs/ucs_01_0337.html)章节的ucs-ctl工具完整性校验操作步骤。
表1常用命令 
| **命令**           | **解释**       |
|:---|:---|
| config generator | 提供集群、节点的创建模板 |
| create           | 创建集群或者添加节点   |
| delete           | 删除集群或者移除节点   |
| upgrade          | 升级集群         |
| get              | 获取本地集群信息     |
| help             | 帮助信息         |
| version          | ucs-ctl版本信息  |
   
#### 参数说明
**ucs-ctl config generator**
```
Flags:
           -o 导出文件路径及名称
           -t 导出模板类型，集群/节点
```
示例：
```
./ucs-ctl config generator -t cluster -o cluster.yaml
```
**ucs-ctl create**
- 创建集群(ucs-ctl create cluster)
Object:
Clustername 集群名称
```
Flags:
           -f, --agent string       集群连线配置文件
           -c, --config string      集群配置文件
           -h, --help               帮助信息
           -r, --retry              安装重试
```
示例：
```
./ucs-ctl create cluster clustername -c cluster.yaml -f agent.yaml
```
- 新增节点(ucs-ctl create node)
```
Flags:
           -c, --cluster string     操作集群名称
           -h, --help               帮助信息
           -m, --machine string     待纳管节点信息
           -r, --retry              纳管重试
```
示例：
```
./ucs-ctl create node -c cluster_name -m machine.csv
```
**ucs-ctl delete**
- 删除集群(ucs-ctl delete cluster)
```
Flags:
           -y, --default-yes        确认输入默认yes
           -h, --help               帮助信息
```
示例：
```
./ucs-ctl delete cluster clustername
```
- 删除节点(ucs-ctl delete node)
```
Flags:
           -y, --assumeyes          确认输入默认yes
           -c, --cluster string     待删除节点集群名称
           -h, --help               帮助信息
           -m, --machine string     待删除节点信息
           -n, --node-ip string     待删除节点ip
```
示例：
```
./ucs-ctl delete node -c clustername -m machine.csv
```
**ucs-ctl get**
- 获取本地集群信息(ucs-ctl get cluster)
示例：
```
./ucs-ctl get cluster
```
- 获取kubeconfig信息(ucs-ctl get kubeconfig)
  ```
  Flags:
             -c, --cluster string    集群名称
             -e, --eip string        使用eip为api接入点
             -h, --help              帮助信息
             -o, --output string     导出路径文件
  ```
  
示例：
```
./ucs-ctl get kubeconfig -c clustername -o kubeconfig
```
