Get Node details
Get details of a specific Node based on the property level
Path Parameters
- nodeId int32 required
Id of the Node (MediaAgent client Id)
Query Parameters
- PropType string
Possible values: [
overview,configuration,associations]Default value:
overviewProperty type to fetch: overview (general info), configuration (control settings), associations (storage pools)
- 200
- 400
- 404
Success
- application/json
- Schema
- Example (from schema)
Schema
nodeDetail object[]
description stringDescription of the node
commCellName stringCommServe host name
rolesBitMask int32Bitmask of roles assigned to this node
hyperscaleType stringHyperScale type: Fujitsu, SDDS, Edge, Compute, Flex, HSX, or NA
deployed stringWhether the node is deployed (Yes/No)
cNodeSNode stringC-Node or S-Node classification, or NA
readinessStatus stringReadiness status (Ready/Not Ready)
readinessTime int64Timestamp of last readiness check
jobStartTime int32Job start time
forceClientSideDownload int32Force client-side download setting
type stringPhysical or Virtual
status stringNode status: Online or Offline
statusDescription stringDetailed status description
mediaAgent object
mediaAgentId int32mediaAgentName stringnetHostName stringdisplayName string_type_ stringosInfo object
Type stringosId int32SubType stringOsDisplayInfo object
OSName stringVersion stringversionInfo object
Version information for a Node
GalaxyRelease object
ReleaseString stringReleaseID int32GalaxyBuildNumber stringUpdateStatus stringPossible values: [
UNKNOWN,UP_TO_DATE,NEEDS_UPDATE,AHEAD_OF_CACHE,NOT_APPLICABLE,HAS_DIAGNOSTIC_UPDATES,OTHER_SOFTWARE,PENDING]PatchStatus object[]
BaselineUpdates stringBaselineStatus stringIsBaseLineDeltaSP int32version stringIsBaselineComparedToClient int32releaseName stringhardware object
vendor stringmodelNo stringkernelVersion stringstorageFileSystem stringrootAccessDisabled int32mediaAgentHostAttribute int32cpuCores int32cpuUsage int32totalMemory int32Total memory in GB
memoryUsagePercent int32metadataDiskSpaceGB int64mediaAgentProps object
enableMA int32optimizeForConcurrentLANBackups int32enableAutomaticParallelDataTransferSelection int32maxNumOfParallelDataTransferOperations int32markMAOfflineForMaintenance int32isRansomwareProtected int32blockSizeKB int32TimeZone object
TimeZoneID int32TimeZoneName stringregion object
Reference to a region in Node API responses
regionId int32regionName stringdisplayName string_type_ stringstoragePools object[]
status stringOnline or Offline
capacityMB int64freeSpaceMB int64usedSpaceMB int64usableFreeSpaceMB int64storagePool object
Reference to a storage pool in Node API responses
id int32name string_type_ stringdeviceType int32deviceTypeName stringstorageType stringStorage type classification
storagePoolType stringStorage pool type classification
region object
Reference to a region in Node API responses
regionId int32regionName stringdisplayName string_type_ stringclientGroups object[]
clientGroupId int32clientGroupName string_type_ stringisStoragePoolSCG int32company object
connectName stringshortName object
id int32name stringassociations object
storagePools object[]
status stringOnline or Offline
capacityMB int64freeSpaceMB int64usedSpaceMB int64usableFreeSpaceMB int64storagePool object
Reference to a storage pool in Node API responses
id int32name string_type_ stringdeviceType int32deviceTypeName stringstorageType stringStorage type classification
storagePoolType stringStorage pool type classification
region object
Reference to a region in Node API responses
regionId int32regionName stringdisplayName string_type_ stringerror object
errorMessage stringerrorCode int32
{
"nodeDetail": [
{
"description": "string",
"commCellName": "string",
"rolesBitMask": 0,
"hyperscaleType": "string",
"deployed": "string",
"cNodeSNode": "string",
"readinessStatus": "string",
"readinessTime": 0,
"jobStartTime": 0,
"forceClientSideDownload": 0,
"type": "string",
"status": "string",
"statusDescription": "string",
"mediaAgent": {
"mediaAgentId": 0,
"mediaAgentName": "string",
"netHostName": "string",
"displayName": "string",
"_type_": "string"
},
"osInfo": {
"Type": "string",
"osId": 0,
"SubType": "string",
"OsDisplayInfo": {
"OSName": "string"
},
"Version": "string"
},
"versionInfo": {
"GalaxyRelease": {
"ReleaseString": "string",
"ReleaseID": 0
},
"GalaxyBuildNumber": "string",
"UpdateStatus": "UNKNOWN",
"PatchStatus": [
{
"BaselineUpdates": "string",
"BaselineStatus": "string",
"IsBaseLineDeltaSP": 0
}
],
"version": "string",
"IsBaselineComparedToClient": 0,
"releaseName": "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,
"optimizeForConcurrentLANBackups": 0,
"enableAutomaticParallelDataTransferSelection": 0,
"maxNumOfParallelDataTransferOperations": 0,
"markMAOfflineForMaintenance": 0,
"isRansomwareProtected": 0,
"blockSizeKB": 0
},
"TimeZone": {
"TimeZoneID": 0,
"TimeZoneName": "string"
},
"region": {
"regionId": 0,
"regionName": "string",
"displayName": "string",
"_type_": "string"
},
"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
}
],
"company": {
"connectName": "string",
"shortName": {
"id": 0,
"name": "string"
}
},
"associations": {
"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"
}
}
]
}
}
],
"error": {
"errorMessage": "string",
"errorCode": 0
}
}
Bad Request
Requested Details not found