Using ucs-ctl to Manage On-Premises Clusters

ucs-ctl is a command line tool and can only be used by UCS on-premises clusters.

Before using ucs-ctl, verify its integrity to prevent it from being tampered with. For details, see "Verifying the Integrity of ucs-ctl" in Installation and Verification.

Flags:
           -o Path and name of the file to be exported
           -t Type of the template to be exported, which can be cluster or node.

Example:

./ucs-ctl config generator -t clustername

ucs-ctl create

• Creating a cluster: ucs-ctl create cluster

Object:

Clustername: cluster name

Flags:
           -f, --agent string       Cluster connection configuration file
           -c, --config string      Cluster configuration file
           -h, --help               Help information
           -r, --retry              Installation retry

Example:

./ucs-ctl create cluster clustername -c cluster.yaml -f agent.yaml

• Adding a node: ucs-ctl create node

Flags:
           -c, --cluster string     Name of the cluster that the node is to be added to
           -h, --help               Help information
           -m, --machine string     Information about the node to be added to the cluster
           -r, --retry              Node management retry

Example:

./ucs-ctl create node -c cluster_name -m machine.csv

ucs-ctl delete

• Deleting a cluster: ucs-ctl delete cluster

Flags:
           -y, --default-yes        Operation for confirming the cluster deletion
           -h, --help               Help information

Example:

./ucs-ctl delete cluster clustername

• Deleting a node: ucs-ctl delete node

Flags:
           -y, --assumeyes          Operation for confirming the node deletion
           -c, --cluster string     Name of the cluster that the node to be deleted from
           -h, --help               Help information
           -m, --machine string     Information about the node to be deleted from the cluster
           -n, --node-ip string     IP address of the node to be deleted

Example:

./ucs-ctl delete node -c clustername -m machine.csv

ucs-ctl get

• Obtaining on-premises cluster information: ucs-ctl get cluster

Example:

./ucs-ctl get cluster

• Obtaining kubeconfig information: ucs-ctl get kubeconfig

  Flags:
             -c, --cluster string    Cluster name
             -e, --eip string        EIP used as the API access point
             -h, --help               Help information
             -o, --output string     Path of the file to be exported

Example:

./ucs-ctl get kubeconfig -c clustername -o kubeconfig