Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
On this page

Show all

Using ucs-ctl to Manage On-Premises Clusters

Updated on 2024-12-18 GMT+08:00

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.

Table 1 Common commands

Command

Description

config generator

Provides templates for creating clusters and nodes.

create

Creates clusters or adds nodes.

delete

Deletes clusters or removes nodes.

get

Obtains on-premises cluster information.

help

Obtains help information.

version

Obtains ucs-ctl version information.

Parameters

ucs-ctl config generator

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 -o cluster.yaml

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

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback