Help Center/ Enterprise Switch/ CLI Reference/ CLI Command Reference
Updated on 2026-09-03 GMT+08:00

CLI Command Reference

Enterprise Switch

API Name

Command

Description

Operation

Querying the Enterprise Switches

hcloud ESW ListInstances

This API is used to query the details about all the enterprise switches.

Go debug

Creating an Enterprise Switch

hcloud ESW CreateInstance

This API is used to create an enterprise switch. This is an asynchronous API. After the request for creating an enterprise switch is delivered, the job ID and instance ID are returned. You need to call the [API for querying the job status](ListResourceJobs.xml) to query the job execution status.

Go debug

Querying the Details About an Enterprise Switch

hcloud ESW ShowInstance

This API is used to query the details about an enterprise switch.

Go debug

Updating an Enterprise Switch

hcloud ESW UpdateInstance

This API is used to update the name or description of an enterprise switch.

Go debug

Deleting an Enterprise Switch

hcloud ESW DeleteInstance

This API is used to delete an enterprise switch if you no longer need it.

Go debug

Querying the Enterprise Switch Quota

hcloud ESW ListQuotas

This API is used to query the enterprise switch quota of a tenant.

Go debug

Querying Enterprise Switch Specifications

hcloud ESW ListFlavors

This API is used to query the enterprise switch specifications available to a tenant.

Go debug

Querying the AZs of an Enterprise Switch

hcloud ESW ListAvailabilityZones

This API is used to obtain the list of AZs where the active and standby nodes of the enterprise switch can be created.

Go debug

Querying the Job Execution Status

hcloud ESW ListResourceJobs

This API is used to query the information about jobs of a specified resource. **COMPLETED** indicates that the job has been successfully completed. **RUNNING** indicates that the job is being executed. **FAILED** indicates that the job fails to be executed.

Go debug

Layer 2 Connection

API Name

Command

Description

Operation

Querying the Layer 2 Connections of an Enterprise Switch

hcloud ESW ListConnections

This API is used to query the Layer 2 connections associated with an enterprise switch.

Go debug

Creating a Layer 2 Connection

hcloud ESW CreateConnection

This API is used to create a Layer 2 connection for an enterprise switch.

Go debug

Querying the Details About a Layer 2 Connection

hcloud ESW ShowConnection

This API is used to query the details about a Layer 2 connection.

Go debug

Updating a Layer 2 Connection

hcloud ESW UpdateConnection

This API is used to update the name of a Layer 2 connection.

Go debug

Deleting a Layer 2 Connection

hcloud ESW DeleteConnection

This API is used to delete a Layer 2 connection if you no longer need it.

Go debug

Binding a Virtual IP Address to a Layer 2 Connection

hcloud ESW BindVport

This API is used to bind a virtual IP address to a Layer 2 connection.

Go debug

Unbinding a Virtual IP Address from a Layer 2 Connection

hcloud ESW UnbindVport

This API is used to unbind a virtual IP address from a Layer 2 connection.

Go debug

Querying Layer 2 Connections

hcloud ESW ListConnectionsAllInstances

This API is used to query all the Layer 2 connections created by a tenant.

Go debug