List DB2 MultiNode Instances

This operation is used to list all DB2 MultiNode Instances and their properties of a pseudo client

Query Parameters

clientId integer required
DB2 MultiNode Pseudo Client ID
applicationId integer required
103 for DB2 MultiNode

Responses

application/json

Schema
Example (from schema)
Example 1

Schema

instanceProperties object[]
DB2 MultiNode Instance Properties
isDeleted boolean
applicationSize integer
excludeFromSLA boolean
version string
scIdxEnabled integer
isSnapEnabled boolean
autoDiscovered boolean
instance object
Instance Specific Properties
clientName string
instanceName string
displayName string
instanceId integer
instanceGUID string
clientId integer
appName string
applicationId integer
entityInfo object
companyId integer
companyName string
multiCommcellId integer
instanceActivityControl object
activityControlOptions object[]
activityType integer
enableAfterADelay boolean
enableActivityType boolean
db2Instance object
homeDirectory string
pureScale boolean
dpfpartitionclients object[]
nodenum integer
nodeClient object
Physical Clients Info
hostName string
clientId integer
clientName string
displayName string
userAccount object
domainName string
userName string
DB2StorageDevice object
networkAgents integer
softwareCompression integer
throttleNetworkBandwidth integer
dataBackupStoragePolicy object
storagePolicyName string
storagePolicyId integer
deDuplicationOptions object
enableDeduplication boolean
generateSignature integer
logBackupStoragePolicy object
storagePolicyName string
storagePolicyId integer
commandLineStoragePolicy object
storagePolicyName string
storagePolicyId integer
planEntity object
Plan Information
planType integer
planName string
planSubtype integer
planId integer
cloudDBInstance object
overRideAccessNode boolean
accessNodes object

{
  "instanceProperties": [
    {
      "isDeleted": true,
      "applicationSize": 0,
      "excludeFromSLA": true,
      "version": "string",
      "scIdxEnabled": 0,
      "isSnapEnabled": true,
      "autoDiscovered": true,
      "instance": {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "instanceId": 0,
        "instanceGUID": "string",
        "clientId": 0,
        "appName": "string",
        "applicationId": 0,
        "entityInfo": {
          "companyId": 0,
          "companyName": "string",
          "multiCommcellId": 0
        }
      },
      "instanceActivityControl": {
        "activityControlOptions": [
          {
            "activityType": 0,
            "enableAfterADelay": true,
            "enableActivityType": true
          }
        ]
      },
      "db2Instance": {
        "homeDirectory": "string",
        "pureScale": true,
        "dpfpartitionclients": [
          {
            "nodenum": 0,
            "nodeClient": {
              "hostName": "string",
              "clientId": 0,
              "clientName": "string",
              "displayName": "string"
            }
          }
        ],
        "userAccount": {
          "domainName": "string",
          "userName": "string"
        },
        "DB2StorageDevice": {
          "networkAgents": 0,
          "softwareCompression": 0,
          "throttleNetworkBandwidth": 0,
          "dataBackupStoragePolicy": {
            "storagePolicyName": "string",
            "storagePolicyId": 0
          },
          "deDuplicationOptions": {
            "enableDeduplication": true,
            "generateSignature": 0
          },
          "logBackupStoragePolicy": {
            "storagePolicyName": "string",
            "storagePolicyId": 0
          },
          "commandLineStoragePolicy": {
            "storagePolicyName": "string",
            "storagePolicyId": 0
          }
        }
      },
      "planEntity": {
        "planType": 0,
        "planName": "string",
        "planSubtype": 0,
        "planId": 0
      },
      "cloudDBInstance": {
        "overRideAccessNode": true,
        "accessNodes": {}
      }
    }
  ]
}

{
  "instanceProperties": [
    {
      "isDeleted": false,
      "applicationSize": 163577856,
      "excludeFromSLA": false,
      "version": "SQL11014 64bit",
      "scIdxEnabled": 0,
      "isSnapEnabled": true,
      "autoDiscovered": false,
      "instance": {
        "clientName": "vikramdpf",
        "instanceName": "dpfinst",
        "displayName": "vikramdpf",
        "instanceId": 5419,
        "instanceGUID": "5F459610-639D-42D8-8247-8562A6855948",
        "clientId": 1483,
        "appName": "DB2 MultiNode",
        "applicationId": 103,
        "entityInfo": {
          "companyId": 0,
          "companyName": "Commcell",
          "multiCommcellId": 0
        }
      },
      "instanceActivityControl": {
        "activityControlOptions": [
          {
            "activityType": 1,
            "enableAfterADelay": false,
            "enableActivityType": true
          },
          {
            "activityType": 2,
            "enableAfterADelay": false,
            "enableActivityType": true
          }
        ]
      },
      "db2Instance": {
        "homeDirectory": "/home/dpfinst",
        "pureScale": false,
        "dpfpartitionclients": [
          {
            "nodenum": 0,
            "nodeClient": {
              "hostName": "12.6.20.29",
              "clientId": 1469,
              "clientName": "vikramdpf1",
              "displayName": "vikramdpf1"
            }
          },
          {
            "nodenum": 1,
            "nodeClient": {
              "hostName": "72.6.20.23",
              "clientId": 1469,
              "clientName": "vikramdpf1",
              "displayName": "vikramdpf1"
            }
          },
          {
            "nodenum": 2,
            "nodeClient": {
              "hostName": "12.1.20.24",
              "clientId": 1470,
              "clientName": "vikramdpf2",
              "displayName": "vikramdpf2"
            }
          },
          {
            "nodenum": 3,
            "nodeClient": {
              "hostName": "17.1.20.24",
              "clientId": 1470,
              "clientName": "vikramdpf2",
              "displayName": "vikramdpf2"
            }
          }
        ],
        "userAccount": {
          "domainName": "",
          "userName": "dpfinst"
        },
        "DB2StorageDevice": {
          "networkAgents": 2,
          "softwareCompression": 2,
          "throttleNetworkBandwidth": 0,
          "dataBackupStoragePolicy": {
            "storagePolicyName": "vikram omrpo dedup regression",
            "storagePolicyId": 292
          },
          "deDuplicationOptions": {
            "enableDeduplication": true,
            "generateSignature": 1
          },
          "logBackupStoragePolicy": {
            "storagePolicyName": "vikram omrpo dedup regression",
            "storagePolicyId": 292
          },
          "commandLineStoragePolicy": {
            "storagePolicyName": "vikram omrpo dedup regression",
            "storagePolicyId": 292
          }
        }
      },
      "planEntity": {
        "planType": 2,
        "planName": "vikram omrpo dedup regression",
        "planSubtype": 33554437,
        "planId": 119
      },
      "cloudDBInstance": {
        "overRideAccessNode": false,
        "accessNodes": {}
      }
    }
  ]
}

Unauthorized

application/json

Schema
Example (from schema)
Example 1

Schema

errorMessage string
errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Access denied",
  "errorCode": 5
}

List DB2 MultiNode Instances​

List DB2 MultiNode Instances