Get Media Agent Details
Select
Get details of a media agent based on id
Path Parameters
- mediaAgentId int32 required
Id of the Media Agent whose details have to be fetched
Query Parameters
- showInheritedAssociation boolean
Show inherited security association
- 200
- 404
Success
- application/json
- Schema
- Example (from schema)
Schema
general object
id int32Id of the media agent.
name stringName of the media agent.
displayName stringDisplay name of the media agent.
status stringPossible values: [
ONLINE
,OFFLINE
,MAINTENANCE
]Current status of the media agent.
offlineReason stringProvides a reason for the media agent being offline. Only given when the media agent is offline.
operatingSystem stringName of the operating system of the media agent.
version stringThe service pack of the media agent.
description stringDescription of the media agent.
indexCache object
path stringPath where the index cache is maintained.
logsCache object
enabled booleanThis tag determines if the logs cache has been enabled or not.
path stringIf the logs cache is enabled, this tag gives the path to store the logs cache.
control object
enabled booleanDetermines if the media agent is currently enabled or disabled.
optimizeForConcurrentLANBackups booleanAllows 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 booleanSpecifies whether the MediaAgent is available for data protection, data recovery and auxiliary copy operations.
ransomwareProtection booleanIf set to true, ransomware protection against the media agent is enabled. If set to false, ransomware protection against media agent is disabled.
parallelDataTransferOperations int32Specifies the number of parallel data operations that can take place.
security object[]
user object
id int32name stringuserGroup object
id int32name stringexternalUserGroup object
External User Group Entity
id int32User Group Id
name stringExternal Group Name
providerId int32Provider id
providerName stringProvider Name
isCreatorAssociation booleanrole object
id int32name stringpermissionList object[]
permissionId int32permissionName stringcategoryId int32categoryName stringtype stringPossible values: [
ALL_CATEGORIES
,CATEGORY_ENTITY
,PERMISSION_ENTITY
]Returns the type of association.
exclude booleanFlag to specify if this is included permission or excluded permission.
{
"general": {
"id": 0,
"name": "string",
"displayName": "string",
"status": "ONLINE",
"offlineReason": "string",
"operatingSystem": "string",
"version": "string",
"description": "string"
},
"indexCache": {
"path": "string",
"logsCache": {
"enabled": true,
"path": "string"
}
},
"control": {
"enabled": true,
"optimizeForConcurrentLANBackups": true,
"maintenanceMode": true,
"ransomwareProtection": true,
"parallelDataTransferOperations": 0
},
"security": [
{
"user": {
"id": 0,
"name": "string"
},
"userGroup": {
"id": 0,
"name": "string"
},
"externalUserGroup": {
"id": 0,
"name": "string",
"providerId": 0,
"providerName": "string"
},
"isCreatorAssociation": true,
"role": {
"id": 0,
"name": "string"
},
"permissionList": [
{
"permissionId": 0,
"permissionName": "string",
"categoryId": 0,
"categoryName": "string",
"type": "ALL_CATEGORIES",
"exclude": true
}
]
}
]
}
Requested Details not found