Skip to main content

Modify Media Agent Details​

Select

SaaS
Customer Managed

Modify the properties of an existing media agent

Path Parameters
  • mediaAgentId int32 required

    Id of the mediaAgent to update

Request Body
  • description string

    Provides the media agent with a new description.

  • control object
  • enabled boolean

    Determines if the media agent is currently enabled or disabled.

  • optimizeForConcurrentLANBackups boolean

    Allows optimization for concurrent LAN backups. If set to true, default value for parallel data transfer operations will be 100. If set to false, default value of parallel data transfer operations will be set to 25.

  • maintenanceMode boolean

    Specifies whether the MediaAgent is available for data protection, data recovery and auxiliary copy operations.

  • ransomwareProtection boolean

    If set to true, ransomware protection against the media agent is enabled. If set to false, ransomware protection against media agent is disabled.

  • parallelDataTransferOperations int32

    Specifies the number of parallel data operations that can take place.

  • indexCache object
  • path string

    Path where the index cache is maintained.

  • logsCache object
  • enabled boolean

    This tag determines if the logs cache has been enabled or not.

  • path string

    If the logs cache is enabled, this tag gives the path to store the logs cache.

  • security object

    A list of users or user groups each having a specific set of roles that determine the kind of operations they can perform on the entity. Either id/name of the user/usergroup/roles can be provided. If both id and name are provided, id will be taken into consideration.

  • user object
  • id int32
  • name string
  • userGroup object
  • id int32
  • name string
  • role object
  • id int32
  • name string
Responses

Success

Schema
  • errorMessage string
  • errorCode int32
PUT /v4/mediaagent/:mediaagentid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
mediaAgentId — path required
Body
{

  "description": "string",

  "control": {

    "enabled": true,

    "optimizeForConcurrentLANBackups": true,

    "maintenanceMode": true,

    "ransomwareProtection": true,

    "parallelDataTransferOperations": 0

  },

  "indexCache": {

    "path": "string",

    "logsCache": {

      "enabled": true,

      "path": "string"

    }

  },

  "security": {

    "user": {

      "id": 0,

      "name": "string"

    },

    "userGroup": {

      "id": 0,

      "name": "string"

    },

    "role": {

      "id": 0,

      "name": "string"

    }

  }

}

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/mediaAgent/:mediaAgentId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "description": "string",
  "control": {
    "enabled": true,
    "optimizeForConcurrentLANBackups": true,
    "maintenanceMode": true,
    "ransomwareProtection": true,
    "parallelDataTransferOperations": 0
  },
  "indexCache": {
    "path": "string",
    "logsCache": {
      "enabled": true,
      "path": "string"
    }
  },
  "security": {
    "user": {
      "id": 0,
      "name": "string"
    },
    "userGroup": {
      "id": 0,
      "name": "string"
    },
    "role": {
      "id": 0,
      "name": "string"
    }
  }
}'