Skip to main content
ZStack
Infrastructure/Installer

DetectInstallerCluster

Detect existing ZCF cluster residue on target nodes without modifying them

POST/api/v1/installer/cluster/detect

Operation ID

DetectInstallerCluster

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: ****

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • exists
    Boolean

    Whether any ZCF cluster residue was detected

    Example: true

  • findings
    List

    Detection findings

    Example: (nested array)

    • target
      String

      Target node or cloud node label

      Example: 192.168.1.10

    • kind
      String

      Finding category

      Example: lifecycle

    • present
      Boolean

      Whether this residue item is present

      Example: true

    • item
      String

      Residue item name

      Example: /opt/zcf

    • message
      String

      Human-readable finding message

      Example: /opt/zcf exists

    • detail
      String

      Additional finding detail

      Example: /opt/zcf

  • summary
    String

    Human-readable detection summary

    Example: cluster residue detected

Change History

This API has no change history records yet.

View all change history