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

DetectInstallerCluster

Detect existing ZCF cluster residue on target nodes without modifying them

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

Responses

200 OK

On success, this API returns the following response structure.

  • existsBoolean

    Whether any ZCF cluster residue was detected

    Example: true

  • findingsList

    Detection findings

    Example: (nested array)

    • targetString

      Target node or cloud node label

      Example: 192.168.1.10

    • kindString

      Finding category

      Example: lifecycle

    • presentBoolean

      Whether this residue item is present

      Example: true

    • itemString

      Residue item name

      Example: /opt/zcf

    • messageString

      Human-readable finding message

      Example: /opt/zcf exists

    • detailString

      Additional finding detail

      Example: /opt/zcf

  • summaryString

    Human-readable detection summary

    Example: cluster residue detected

Endpoint

POST/api/v1/installer/cluster/detect

/api/v1/installer/cluster/detect

Operation ID

DetectInstallerCluster

Permalink

Request Example

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

Response Example

200
{
  "exists": true,
  "findings": [],
  "summary": "cluster residue detected"
}

Change History

This API has no change history records yet.

View all change history