Skip to main content
ZStack
Infrastructure/Installer

ResetInstallerCluster

Reset an existing ZCF cluster from target nodes after explicit confirmation

POST/api/v1/installer/cluster/reset

Operation ID

ResetInstallerCluster

Since

1.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • target
    ObjectRequired

    Cluster target configuration

    • local
      Boolean

      Whether to target the local installer node

      Example: true

    • nodes
      List

      Remote ZCF nodes to detect or reset

      Example: (nested array)

      • role
        String

        Role of this node in the cluster topology

        Example: primary

      • fqdn
        String

        Fully qualified domain name of this node

        Example: node01.example.com

      • username
        String

        SSH username for connecting to this node

        Example: root

      • password
        String

        SSH password for connecting to this node (sensitive)

        Example: ****

      • sshKeyPath
        String

        Path to SSH private key for key-based authentication

        Example: /root/.ssh/id_rsa

      • sshPort
        Integer

        SSH port to connect on

        Example: 22

    • vip
      String

      VIP or FQDN to detect or remove from target nodes

      Example: 192.168.1.100

    • vipInterface
      String

      Network interface that owns the VIP

      Example: ens192

    • cloud
      List

      Cloud management nodes to inspect or clean UI config

      Example: (nested array)

      • address
        StringRequired

        IP address or FQDN of the cloud management node

        Example: 192.168.1.50

      • port
        Integer

        SSH port for the cloud management node

        Example: 22

      • user
        StringRequired

        SSH username for the cloud management node

        Example: root

      • password
        String

        SSH password for the cloud management node (sensitive)

        Example: ****

  • confirmation
    StringRequired

    Required confirmation phrase for destructive execution

    Example: yes-i-really-mean-it

  • dryRun
    BooleanRequired

    Whether to return the reset plan without executing it

    Example: true

  • planHash
    StringRequired

    Hash returned by dry-run for the exact reset plan being executed

    Example: sha256:abc123

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • status
    String

    Reset request status: planned or completed

    Example: planned

  • plan
    String

    Human-readable reset plan

    Example: Reset plan:

  • resetPlan
    Object

    Structured reset plan

    • targets
      List

      Reset target plans

      Example: (nested array)

      • target
        String

        Target node label

        Example: 192.168.1.10

      • local
        Boolean

        Whether this plan targets the local installer node

        Example: false

      • commands
        List

        Commands to execute for this target

        Example: item1,item2

      • vipCleanupSkipped
        Boolean

        Whether VIP cleanup is skipped because no VIP was provided

        Example: false

    • cloud
      List

      Cloud UI cleanup plans

      Example: (nested array)

      • address
        String

        Cloud management node address

        Example: 192.168.1.50

  • planHash
    String

    Hash of the exact reset plan

    Example: sha256:abc123

  • results
    List

    Per-target execution results

    Example: (nested array)

    • target
      String

      Target node or cloud node label

      Example: 192.168.1.10

    • status
      String

      Execution status for this target: completed or failed

      Example: completed

    • error
      String

      Error message when this target failed

      Example: SSH connect failed

Change History

This API has no change history records yet.

View all change history