Get MediaAgents

Select

SaaS

Customer Managed

This operation returns a list of MediaAgents.

Response Parameters

offlineReason

Value	Description
0	No errors detected
1	Cannot communicate with Media Mount Manager Service
2	CommServe and MediaAgent versions appear to be different
3	MediaAgent has been marked as disabled
4	MediaAgent has been marked disabled as it has exceeded the pre-determined number of days since the CommCell has been upgraded
5	MediaAgent is initializing and refreshing the device information
6	MediaAgent has been migrated to different CommServe
7	MediaAgent is powered off by Power Management
8	MediaAgent marked offline as node refresh failed
9	MediaAgent is marked offline by the automated MediaAgent state management feature

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• mediaAgentList object[]

  offlineReason integer

  description string

  status integer

  0(Offline) 1(Ready) 2(

  mediaAgent object

  mediaAgentId integer

  _type_ integer

  displayName string

  mediaAgentName string

  osInfo object

  osId integer

  OsDisplayInfo object

  OSName string

  versionInfo object

  UpdateStatus integer

  GalaxyBuildNumber string

  GalaxyRelease object

  ReleaseString string

  _type_ integer

  ReleaseID integer

  mediaAgentProps object

  pushMA boolean

  isPreConfigured boolean

  isUnlicensedMA boolean

  isVirtualsClient boolean

  powerManagementInfo object

  isPowerMgmtAllowedCheck boolean

  isPowerMgmtSupported boolean

  statusDescription string

{
  "mediaAgentList": [
    {
      "offlineReason": 0,
      "description": "string",
      "status": 0,
      "mediaAgent": {
        "mediaAgentId": 0,
        "_type_": 0,
        "displayName": "string",
        "mediaAgentName": "string"
      },
      "osInfo": {
        "osId": 0,
        "OsDisplayInfo": {
          "OSName": "string"
        }
      },
      "versionInfo": {
        "UpdateStatus": 0,
        "GalaxyBuildNumber": "string",
        "GalaxyRelease": {
          "ReleaseString": "string",
          "_type_": 0,
          "ReleaseID": 0
        }
      },
      "mediaAgentProps": {
        "pushMA": true,
        "isPreConfigured": true,
        "isUnlicensedMA": true,
        "isVirtualsClient": true
      },
      "powerManagementInfo": {
        "isPowerMgmtAllowedCheck": true,
        "isPowerMgmtSupported": true
      },
      "statusDescription": "string"
    }
  ]
}

{
  "mediaAgentList": [
    {
      "offlineReason": 0,
      "description": "",
      "status": 1,
      "mediaAgent": {
        "mediaAgentId": 2,
        "_type_": 11,
        "displayName": "dm2perf3",
        "mediaAgentName": "dm2perf3"
      },
      "osInfo": {
        "osId": 210,
        "OsDisplayInfo": {
          "OSName": "Windows Server 2016 Datacenter"
        }
      },
      "versionInfo": {
        "UpdateStatus": 0,
        "GalaxyBuildNumber": "11",
        "GalaxyRelease": {
          "ReleaseString": "11 SP17",
          "_type_": 58,
          "ReleaseID": 16
        }
      },
      "mediaAgentProps": {
        "pushMA": false,
        "isPreConfigured": false,
        "isUnlicensedMA": false,
        "isVirtualsClient": false
      },
      "powerManagementInfo": {
        "isPowerMgmtAllowedCheck": true,
        "isPowerMgmtSupported": false
      }
    },
    {
      "offlineReason": 0,
      "description": "",
      "status": 1,
      "mediaAgent": {
        "mediaAgentId": 18,
        "_type_": 11,
        "displayName": "yashdutch",
        "mediaAgentName": "yashdutch"
      },
      "osInfo": {
        "osId": 210,
        "OsDisplayInfo": {
          "OSName": "Windows Server 2012 R2 Datacenter"
        }
      },
      "versionInfo": {
        "UpdateStatus": 0,
        "GalaxyBuildNumber": "11",
        "GalaxyRelease": {
          "ReleaseString": "11 SP17",
          "_type_": 58,
          "ReleaseID": 16
        }
      },
      "mediaAgentProps": {
        "pushMA": false,
        "isPreConfigured": false,
        "isUnlicensedMA": false,
        "isVirtualsClient": false
      },
      "powerManagementInfo": {
        "isPowerMgmtAllowedCheck": true,
        "isPowerMgmtSupported": false
      }
    },
    {
      "statusDescription": "Cannot communicate with Media Mount Manager Service.\nPlease ensure that.\na. The MediaAgent is reachable from CommServe.\nb. All MediaAgent services are running.",
      "offlineReason": 1,
      "description": "",
      "status": 0,
      "mediaAgent": {
        "mediaAgentId": 23,
        "_type_": 11,
        "displayName": "pluto",
        "mediaAgentName": "pluto"
      },
      "osInfo": {
        "osId": 210,
        "OsDisplayInfo": {
          "OSName": "Windows Server 2016 Standard"
        }
      },
      "versionInfo": {
        "UpdateStatus": 0,
        "GalaxyBuildNumber": "11",
        "GalaxyRelease": {
          "ReleaseString": "11 SP16",
          "_type_": 58,
          "ReleaseID": 16
        }
      },
      "mediaAgentProps": {
        "pushMA": false,
        "isPreConfigured": false,
        "isUnlicensedMA": true,
        "isVirtualsClient": false
      },
      "powerManagementInfo": {
        "isPowerMgmtAllowedCheck": true,
        "isPowerMgmtSupported": false
      }
    },
    {
      "statusDescription": "Cannot communicate with Media Mount Manager Service.\nPlease ensure that.\na. The MediaAgent is reachable from CommServe.\nb. All MediaAgent services are running.",
      "offlineReason": 0,
      "description": "",
      "status": 1,
      "mediaAgent": {
        "mediaAgentId": 300,
        "_type_": 11,
        "displayName": "YashLinux",
        "mediaAgentName": "YashLinux"
      },
      "osInfo": {
        "osId": 82,
        "OsDisplayInfo": {
          "OSName": "Ubuntu 12.04"
        }
      },
      "versionInfo": {
        "UpdateStatus": 0,
        "GalaxyBuildNumber": "11",
        "GalaxyRelease": {
          "ReleaseString": "11 SP17",
          "_type_": 58,
          "ReleaseID": 16
        }
      },
      "mediaAgentProps": {
        "pushMA": false,
        "isPreConfigured": false,
        "isUnlicensedMA": false,
        "isVirtualsClient": false
      },
      "powerManagementInfo": {
        "isPowerMgmtAllowedCheck": true,
        "isPowerMgmtSupported": false
      }
    }
  ]
}

Loading...