Skip to main content

Create Cluster​

This operation is used to create a Cluster Setup for DB2 nodes

Request Body
  • clientInfo object required
  • clientType string required

    UNIX_CLUSTER_CLIENT

  • plan object

    Pass this object to associate a plan to cluster

  • planId integer required

    ID of the plan to associate

  • planName string
  • entity object required
  • hostName string required

    Hostname of cluster

  • displayName string required

    Display name of cluster

  • clientId integer
  • clientName string required

    Pseudo client name for representing cluster

  • entityTypeName string required

    CLIENT_ENTITY

  • _type_ string required

    CLIENT_ENTITY

  • clusterClientsInfo object required
  • clusterClientProperties object required
  • clusterGroupAssociation object[] required
  • clientId integer required

    ID of the pyhsical client to associate with cluster

  • clientName string
  • configuredAgents object[] required
  • ComponentId integer required

    1101 for Unix File System

  • ComponentName string
  • NoApplicationRequired boolean required

    True

  • osType string required

    Unix

  • clusterGroupAssociationOperationType string required

    ADD

  • configuredAgentsOperationType string required

    ADD

  • forceSyncConfigOnRemoteNodes boolean required

    True if you want to enable force sync config else False

  • jobResultsDir object required
  • path string required

    Path to job results directory

Responses

OK

Schema
  • processinginstructioninfo object
  • attributes object[]
  • name string
  • value string
  • response object
  • errorString string
  • errorCode integer
  • entity object
  • clientId integer
  • clientName string
  • _type_ integer
POST /pseudoclient

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body
{

  "clientInfo": {

    "clientType": "string",

    "plan": {

      "planId": 0,

      "planName": "string"

    }

  },

  "entity": {

    "hostName": "string",

    "displayName": "string",

    "clientId": 0,

    "clientName": "string",

    "entityTypeName": "string",

    "_type_": "string"

  },

  "clusterClientsInfo": {

    "clusterClientProperties": {

      "clusterGroupAssociation": [

        {

          "clientId": 0,

          "clientName": "string"

        }

      ],

      "configuredAgents": [

        {

          "ComponentId": 0,

          "ComponentName": "string",

          "NoApplicationRequired": true,

          "osType": "string"

        }

      ],

      "clusterGroupAssociationOperationType": "string",

      "configuredAgentsOperationType": "string",

      "forceSyncConfigOnRemoteNodes": true

    },

    "jobResultsDir": {

      "path": "string"

    }

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/pseudoClient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "clientInfo": {
    "clientType": "string",
    "plan": {
      "planId": 0,
      "planName": "string"
    }
  },
  "entity": {
    "hostName": "string",
    "displayName": "string",
    "clientId": 0,
    "clientName": "string",
    "entityTypeName": "string",
    "_type_": "string"
  },
  "clusterClientsInfo": {
    "clusterClientProperties": {
      "clusterGroupAssociation": [
        {
          "clientId": 0,
          "clientName": "string"
        }
      ],
      "configuredAgents": [
        {
          "ComponentId": 0,
          "ComponentName": "string",
          "NoApplicationRequired": true,
          "osType": "string"
        }
      ],
      "clusterGroupAssociationOperationType": "string",
      "configuredAgentsOperationType": "string",
      "forceSyncConfigOnRemoteNodes": true
    },
    "jobResultsDir": {
      "path": "string"
    }
  }
}'