---
title: "Command reference for EZswitch in PV autoscaling"
slug: "command-reference-for-ezswitch-in-storage-autoscaling"
updated: 2026-07-21T09:45:50Z
published: 2026-07-21T09:45:50Z
canonical: "docs.zesty.co/command-reference-for-ezswitch-in-storage-autoscaling"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zesty.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Command reference for EZswitch in PV autoscaling

This topic describes the CLI commands for Kompass Storage EZswitch.

All EZswitch commands are invoked via the CLI plugin:

`kubectl zesty ezswitch <command> <stsName> [flags]`

The following tables describe the commands, flags, and descriptions.

<editor360-custom-block data-preprocessing="true" data-sanitizationtags="a"><h4 data-block-id="5f975d9e-cbfd-4a06-9099-b4756e4fe1b1" id="start"><a id="_heading=h.x46pryz037ea" display="false"></a>start <stsname></stsname></h4></editor360-custom-block>

Starts the migration process, installing EZswitch components (including the Helm chart if not already installed) and creating the EZswitch CR. By default, all ezswitch resources will be on the zesty-ezswitch namespace

| Flag | Default | Description |
| --- | --- | --- |
| `--autoMigrate` | true | Run process automatically to completion if true. |
| `--stsNamespace` | default | Namespace of the original STS. |
| `--set key=value` | (none) | Override [Helm chart values](/v1/docs/install-and-run-ezswitch-in-kompass-storage#helm-chart-values) during installation. |
| `--logLevel int` | 4 | Set the log level of ezswitch-controller. |
| `--zestyStsName` | <stsName>-zesty | Name of the new Zesty-based STS. |
| `--helm-namespace` | zesty-ezswitch | Namespace where ezswitch resources will be created |

**Example**:

`kubectl zesty ezswitch start myapp-sts --autoMigrate=false --helm-namespace=custom-namespace --set logLevel=4`

<editor360-custom-block data-preprocessing="true" data-sanitizationtags="a"><h4 data-block-id="93775250-8c1e-4dbc-acfc-b755be459592" id="migrate"><a id="_heading=h.xj72ebhvbu10" display="false"></a>migrate <stsname></stsname></h4></editor360-custom-block>

Resumes the migration if previously halted at ReadyForMigration.

| Flag | Default | Description |
| --- | --- | --- |
| `--stsNamespace` | default | Namespace of the original STS. |

**Example**:

`kubectl zesty ezswitch migrate myapp-sts`

<editor360-custom-block data-preprocessing="true" data-sanitizationtags="a"><h4 data-block-id="f05aa88b-aa14-4b02-91eb-d05bb441439c" id="pause"><a id="_heading=h.dibrak9wtjk5" display="false"></a>pause <stsname></stsname></h4></editor360-custom-block>

Pauses the ongoing migration.

| Flag | Default | Description |
| --- | --- | --- |
| `--stsNamespace` | default | Namespace of the original STS. |

**Example**:

`kubectl zesty ezswitch pause myapp-sts`

<editor360-custom-block data-preprocessing="true" data-sanitizationtags="a"><h4 data-block-id="b094b309-ae7c-4cc4-aa53-e525ad34c2b4" id="resume"><a id="_heading=h.3jf41i6k5kji" display="false"></a>resume <stsname></stsname></h4></editor360-custom-block>

Resumes a previously paused migration.

| Flag | Default | Description |
| --- | --- | --- |
| `--stsNamespace` | default | Namespace of the original StatefulSet. |

**Example**:

`kubectl zesty ezswitch resume myapp-sts`

<editor360-custom-block data-preprocessing="true" data-sanitizationtags="a"><h4 data-block-id="042f3235-52f4-49f5-b787-42299833181c" id="abort"><a id="_heading=h.yashx1nal6rb" display="false"></a>abort <stsname></stsname></h4></editor360-custom-block>

Aborts the current process before significantly impacting the original StatefulSet and cleans up created resources.

| Flag | Default | Description |
| --- | --- | --- |
| `--stsNamespace` | default | Namespace of the original STS. |

**Example**:

`kubectl zesty ezswitch abort myapp-sts`

<editor360-custom-block data-preprocessing="true" data-sanitizationtags="a"><h4 data-block-id="6a318187-2698-417c-aa17-0fc54748e9ec" id="rollback"><a id="_heading=h.7qosle35t3fd" display="false"></a>rollback <stsname></stsname></h4></editor360-custom-block>

Attempts to revert to the original state if changes to the StatefulSet have begun. This option is especially relevant at or after the ReadyForMigration phase.

- The EZswitch resource from which the migration started must still exist.
- The original StatefulSet and its PVCs must still exist.

| Flag | Default | Description |
| --- | --- | --- |
| `--stsNamespace` | default | Namespace of the original STS. |

**Example**:

`kubectl zesty ezswitch rollback myapp-sts`

<editor360-custom-block data-preprocessing="true" data-sanitizationtags="a"><h4 data-block-id="ecd85a07-db24-4f04-aaf2-217cbaf7c2a5" id="status"><a id="_heading=h.z5udf8e60yn2" display="false"></a>status <stsname></stsname></h4></editor360-custom-block>

Displays the current migration status, including phase and sync progress.

| Flag | Default | Description |
| --- | --- | --- |
| `--stsNamespace` | default | Namespace of the original STS. |

**Example**:

`kubectl zesty ezswitch status myapp-sts`

For a description of the statuses, see Migration statuses

<editor360-custom-block data-preprocessing="true" data-sanitizationtags="a"><h4 data-block-id="fd2dac9d-8a34-409a-a28f-c25a0e26e13e" id="set"><a id="_heading=h.ysbnbwjcfbpe" display="false"></a>set <stsname></stsname></h4></editor360-custom-block>

Modifies attributes of the EZswitch CR.

| Flag | Default | Description |
| --- | --- | --- |
| `--autoMigrate=&lt;bool&gt;` | true | Updates autoMigrate field. |
| `--transferRateLimits=Html` | -1 | Updates transferRateLimits field (-1 will unset its value, that is, no limit). |

**Example**:

- To Disable automatic migration

`kubectl zesty ezswitch set myapp-sts --autoMigrate=false`

<editor360-custom-block data-preprocessing="true" data-sanitizationtags="a"><h4 data-block-id="363ca8a2-760e-40d3-9041-11e86d41491c" id="cleanup"><a id="_heading=h.83q7tr2stx7p" display="false"></a>cleanup <stsname></stsname></h4></editor360-custom-block>

Removes the EZswitch CR.

| Flag | Default | Description |
| --- | --- | --- |
| `--helm-namespace` | zesty-ezswitch | Namespace of the original STS. |
| `--delete-old-sts` | false | Deletes the old StatefulSet on cleanup. |
| `--force-abort` | false | Forces abort of all EZswitch resources before cleanup. |
| `--keep-resources` | false | Keeps EZswitch resources instead of deleting them. |
| `--stsNamespace` | default | Namespace of the original STS. |

**Example**:

`kubectl zesty ezswitch cleanup &lt;stsName&gt; [flags]`