Get all Nodes

Get list of all Nodes (MediaAgents) with basic information

Responses

Success

application/json

Schema
Example (from schema)

Schema

nodeDetail object[]
id int32
Node (MediaAgent) Id
name string
Node (MediaAgent) name
netHostName string
Network host name
displayName string
Display name of the node
status string
Node status: Online or Offline
statusDescription string
Detailed status description
description string
Description of the node
hyperscaleType string
HyperScale type: HSX, Edge, Universal, Flex, or NA
deployed string
Whether the node is deployed (Yes/No)
cNodeSNode string
C-Node or S-Node classification, or NA
type string
Physical or Virtual
rolesBitMask int32
Bitmask of roles assigned to this node
osInfo object
Operating system version summary for node list responses
Version string
versionInfo object
Software version summary for node list responses
version string
hardware object
vendor string
modelNo string
kernelVersion string
storageFileSystem string
rootAccessDisabled int32
mediaAgentHostAttribute int32
cpuCores int32
cpuUsage int32
totalMemory int32
Total memory in GB
memoryUsagePercent int32
metadataDiskSpaceGB int64
mediaAgentProps object
MediaAgent properties summary for node list responses
enableMA int32
storagePools object[]
status string
Online or Offline
capacityMB int64
freeSpaceMB int64
usedSpaceMB int64
usableFreeSpaceMB int64
storagePool object
Reference to a storage pool in Node API responses
id int32
name string
_type_ string
deviceType int32
deviceTypeName string
storageType string
Storage type classification
storagePoolType string
Storage pool type classification
region object
Reference to a region in Node API responses
regionId int32
regionName string
displayName string
_type_ string
clientGroups object[]
clientGroupId int32
clientGroupName string
_type_ string
isStoragePoolSCG int32
region object
Reference to a region in Node API responses
regionId int32
regionName string
displayName string
_type_ string
tags object[]
Tags associated with the node
id int32
name string
value string

{
  "nodeDetail": [
    {
      "id": 0,
      "name": "string",
      "netHostName": "string",
      "displayName": "string",
      "status": "string",
      "statusDescription": "string",
      "description": "string",
      "hyperscaleType": "string",
      "deployed": "string",
      "cNodeSNode": "string",
      "type": "string",
      "rolesBitMask": 0,
      "osInfo": {
        "Version": "string"
      },
      "versionInfo": {
        "version": "string"
      },
      "hardware": {
        "vendor": "string",
        "modelNo": "string",
        "kernelVersion": "string",
        "storageFileSystem": "string",
        "rootAccessDisabled": 0,
        "mediaAgentHostAttribute": 0,
        "cpuCores": 0,
        "cpuUsage": 0,
        "totalMemory": 0,
        "memoryUsagePercent": 0,
        "metadataDiskSpaceGB": 0
      },
      "mediaAgentProps": {
        "enableMA": 0
      },
      "storagePools": [
        {
          "status": "string",
          "capacityMB": 0,
          "freeSpaceMB": 0,
          "usedSpaceMB": 0,
          "usableFreeSpaceMB": 0,
          "storagePool": {
            "id": 0,
            "name": "string",
            "_type_": "string"
          },
          "deviceType": 0,
          "deviceTypeName": "string",
          "storageType": "string",
          "storagePoolType": "string",
          "region": {
            "regionId": 0,
            "regionName": "string",
            "displayName": "string",
            "_type_": "string"
          }
        }
      ],
      "clientGroups": [
        {
          "clientGroupId": 0,
          "clientGroupName": "string",
          "_type_": "string",
          "isStoragePoolSCG": 0
        }
      ],
      "region": {
        "regionId": 0,
        "regionName": "string",
        "displayName": "string",
        "_type_": "string"
      },
      "tags": [
        {
          "id": 0,
          "name": "string",
          "value": "string"
        }
      ]
    }
  ]
}

Get all Nodes​

Get all Nodes