Get MediaAgent Power Management

This operation returns & operates power management status for a cloud media agent.

Path Parameters

• mediaAgentId int64 required
• operation integer required

  Power on -1 Poweroff - 0

Responses

• 200
• 201

---

OK

application/json

• Schema
• Example (from schema)
• Media Agent Power Management - Send Power Off Request

---

Schema

• errorMessage string
• errorCode integer

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

{
  "errorMessage": "Successfully submitted power off request.",
  "errorCode": 0
}

Created

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• useMediaAgent boolean
• powerManagementInfo object

  FailedPowerOperation integer

  powerStatus integer

  isPowerMgmtAllowed boolean

  FailureReason string

  isPowerMgmtAllowedCheck boolean

  isPowerMgmtSupported boolean

  isPowerManagementEnabled boolean

  clientGroup object

  _type_ integer

  clientGroupId integer

  selectedCloudController object

  clientId integer

  clientName string

  _type_ integer
• CloudControllerList object[]

  clientId integer

  clientName string

  _type_ integer

{
  "useMediaAgent": true,
  "powerManagementInfo": {
    "FailedPowerOperation": 0,
    "powerStatus": 0,
    "isPowerMgmtAllowed": true,
    "FailureReason": "string",
    "isPowerMgmtAllowedCheck": true,
    "isPowerMgmtSupported": true,
    "isPowerManagementEnabled": true,
    "clientGroup": {
      "_type_": 0,
      "clientGroupId": 0
    },
    "selectedCloudController": {
      "clientId": 0,
      "clientName": "string",
      "_type_": 0
    }
  },
  "CloudControllerList": [
    {
      "clientId": 0,
      "clientName": "string",
      "_type_": 0
    }
  ]
}

{
  "useMediaAgent": true,
  "powerManagementInfo": {
    "FailedPowerOperation": 0,
    "powerStatus": 3,
    "isPowerMgmtAllowed": true,
    "FailureReason": "",
    "isPowerMgmtAllowedCheck": true,
    "isPowerMgmtSupported": true,
    "isPowerManagementEnabled": true,
    "clientGroup": {
      "_type_": 28,
      "clientGroupId": -1
    },
    "selectedCloudController": {
      "clientId": 187,
      "clientName": "Azure-Controller",
      "_type_": 3
    }
  },
  "CloudControllerList": [
    {
      "clientId": 4,
      "clientName": "AzureRM-V1",
      "_type_": 3
    },
    {
      "clientId": 148,
      "clientName": "VSAAZURE-RM",
      "_type_": 3
    },
    {
      "clientId": 171,
      "clientName": "MarketingAzureRM",
      "_type_": 3
    },
    {
      "clientId": 187,
      "clientName": "Azure-Controller",
      "_type_": 3
    },
    {
      "clientId": 191,
      "clientName": "1sapna-AzureRM",
      "_type_": 3
    },
    {
      "clientId": 371,
      "clientName": "Azure_Replication",
      "_type_": 3
    }
  ]
}

GET /mediaagent/:mediaagentid/cloudvmpowermanagement/:operation    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

mediaAgentId — path required

operation — path required

Accept

application/jsonapplication/json

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/MediaAgent/:mediaAgentId/CloudVMPowerManagement/:operation' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/MediaAgent/:mediaAgentId/CloudVMPowerManagement/:operation' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/MediaAgent/:mediaAgentId/CloudVMPowerManagement/:operation' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/MediaAgent/:mediaAgentId/CloudVMPowerManagement/:operation' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/MediaAgent/:mediaAgentId/CloudVMPowerManagement/:operation' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/MediaAgent/:mediaAgentId/CloudVMPowerManagement/:operation' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/MediaAgent/:mediaAgentId/CloudVMPowerManagement/:operation' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'