Skip to main content
API Explorer|API Explorer
Infrastructure/Installer
POSTInstallerSince 1.0SynchronousAuth RequiredAdded

ResetInstallerCluster

Reset an existing ZCF cluster from target nodes after explicit confirmation

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • targetObjectRequired

    Cluster target configuration

    • localBoolean

      Whether to target the local installer node

      Example: true

    • nodesList

      Remote ZCF nodes to detect or reset

      Example: (nested array)

      • roleString

        Role of this node in the cluster topology

        Example: primary

      • fqdnString

        Fully qualified domain name of this node

        Example: node01.example.com

      • usernameString

        SSH username for connecting to this node

        Example: root

      • passwordString

        SSH password for connecting to this node (sensitive)

        Example: ****

      • sshKeyPathString

        Path to SSH private key for key-based authentication

        Example: /root/.ssh/id_rsa

      • sshPortInteger

        SSH port to connect on

        Example: 22

    • vipString

      VIP or FQDN to detect or remove from target nodes

      Example: 192.168.1.100

    • vipInterfaceString

      Network interface that owns the VIP

      Example: ens192

    • cloudList

      Cloud management nodes to inspect or clean UI config

      Example: (nested array)

      • addressStringRequired

        IP address or FQDN of the cloud management node

        Example: 192.168.1.50

      • portInteger

        SSH port for the cloud management node

        Example: 22

      • userStringRequired

        SSH username for the cloud management node

        Example: root

      • passwordString

        SSH password for the cloud management node (sensitive)

        Example: ****

  • confirmationStringRequired

    Required confirmation phrase for destructive execution

    Example: yes-i-really-mean-it

  • dryRunBooleanRequired

    Whether to return the reset plan without executing it

    Example: true

  • planHashStringRequired

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

    Example: sha256:abc123

Responses

200 OK

On success, this API returns the following response structure.

  • statusString

    Reset request status: planned or completed

    Example: planned

  • planString

    Human-readable reset plan

    Example: Reset plan:

  • resetPlanObject

    Structured reset plan

    • targetsList

      Reset target plans

      Example: (nested array)

      • targetString

        Target node label

        Example: 192.168.1.10

      • localBoolean

        Whether this plan targets the local installer node

        Example: false

      • commandsList

        Commands to execute for this target

        Example: item1,item2

      • vipCleanupSkippedBoolean

        Whether VIP cleanup is skipped because no VIP was provided

        Example: false

    • cloudList

      Cloud UI cleanup plans

      Example: (nested array)

      • addressString

        Cloud management node address

        Example: 192.168.1.50

  • planHashString

    Hash of the exact reset plan

    Example: sha256:abc123

  • resultsList

    Per-target execution results

    Example: (nested array)

    • targetString

      Target node or cloud node label

      Example: 192.168.1.10

    • statusString

      Execution status for this target: completed or failed

      Example: completed

    • errorString

      Error message when this target failed

      Example: SSH connect failed

Endpoint

POST/api/v1/installer/cluster/reset

/api/v1/installer/cluster/reset

Operation ID

ResetInstallerCluster

Permalink

Request Example

curl -X POST '{host}/api/v1/installer/cluster/reset' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"dryRun":true,"target":{"local":true,"vip":"192.0.2.100","vipInterface":"ens192"}}'

Response Example

200
{
  "status": "planned",
  "plan": "Reset plan:",
  "resetPlan": {}
}

Change History

This API has no change history records yet.

View all change history