Configure Library

This operation detects tape libraries.

More Details

Query Parameters

Action string

application/json

Request Body

autoDetect boolean
hdr object
tag integer
mediaAgentIdList object[]
isConfigRequired integer
library object
libraryName string
opType integer
mediaAgentId integer
Media Agent Client ID
password string
loginName string
mountPath string
isCloud integer
serverType integer
baseFolder string
savedCredential object
credentialName string
isDeconfigLibrary integer

Responses

application/json

Schema
Example (from schema)
Example 1

Schema

library object
libraryName string
stopDataAgingWhenDataOccupiedOnDiskIs integer
deviceAccessType integer
enablePruningOfAgedData integer
libraryId integer
archGroupId integer
opType integer
description string
errorCode integer
driveName string
deviceId integer
deviceName string
startDataAgingWhenDataOccupiedOnDiskIs integer
numOfWritersForMountpath integer
mediaAgentId integer
usePnpWhenBlank integer
password string
warningWaterMark integer
preferMountPathAccordingToMA integer
baseFolder string
loginName string
archCopyName string
mediaAgentName string
NDMPServer string
deviceType integer
mountPath string
hideLibrary integer
isCloud integer
archGroupName string
isAutomaticallyManageDisk integer
createStoragePolicy integer
proxyPassword string
preventDataDelFromMntPth integer
archCopyId integer
backupRetentionDays integer
numOfWritersForLibrary integer
diskCapacity integer
reserveSpaceInMB integer
resrvSpaceForSiloRestores integer
serverType integer
libSerialNumber string
markDrive integer
objectAddress integer
lowWaterMark integer
mountPathId integer
preferMountPathWithFreeSpace integer
libraryType integer
mountPathUsage integer

{
  "library": {
    "libraryName": "string",
    "stopDataAgingWhenDataOccupiedOnDiskIs": 0,
    "deviceAccessType": 0,
    "enablePruningOfAgedData": 0,
    "libraryId": 0,
    "archGroupId": 0,
    "opType": 0,
    "description": "string",
    "errorCode": 0,
    "driveName": "string",
    "deviceId": 0,
    "deviceName": "string",
    "startDataAgingWhenDataOccupiedOnDiskIs": 0,
    "numOfWritersForMountpath": 0,
    "mediaAgentId": 0,
    "usePnpWhenBlank": 0,
    "password": "string",
    "warningWaterMark": 0,
    "preferMountPathAccordingToMA": 0,
    "baseFolder": "string",
    "loginName": "string",
    "archCopyName": "string",
    "mediaAgentName": "string",
    "NDMPServer": "string",
    "deviceType": 0,
    "mountPath": "string",
    "hideLibrary": 0,
    "isCloud": 0,
    "archGroupName": "string",
    "isAutomaticallyManageDisk": 0,
    "createStoragePolicy": 0,
    "proxyPassword": "string",
    "preventDataDelFromMntPth": 0,
    "archCopyId": 0,
    "backupRetentionDays": 0,
    "numOfWritersForLibrary": 0,
    "diskCapacity": 0,
    "reserveSpaceInMB": 0,
    "resrvSpaceForSiloRestores": 0,
    "serverType": 0,
    "libSerialNumber": "string",
    "markDrive": 0,
    "objectAddress": 0,
    "lowWaterMark": 0,
    "mountPathId": 0,
    "preferMountPathWithFreeSpace": 0,
    "libraryType": 0,
    "mountPathUsage": 0
  }
}

{
  "library": {
    "libraryName": "library001",
    "stopDataAgingWhenDataOccupiedOnDiskIs": 0,
    "deviceAccessType": 0,
    "enablePruningOfAgedData": 2,
    "libraryId": 5,
    "archGroupId": 0,
    "opType": 0,
    "description": "",
    "errorCode": 0,
    "driveName": "",
    "deviceId": 0,
    "deviceName": "",
    "startDataAgingWhenDataOccupiedOnDiskIs": 0,
    "numOfWritersForMountpath": 0,
    "mediaAgentId": 2,
    "usePnpWhenBlank": 2,
    "password": "",
    "warningWaterMark": 0,
    "preferMountPathAccordingToMA": 2,
    "baseFolder": "",
    "loginName": "",
    "archCopyName": "",
    "mediaAgentName": "firewalltestcs",
    "NDMPServer": "",
    "deviceType": 0,
    "mountPath": "c:/library001",
    "hideLibrary": 2,
    "isCloud": 0,
    "archGroupName": "",
    "isAutomaticallyManageDisk": 0,
    "createStoragePolicy": 0,
    "proxyPassword": "",
    "preventDataDelFromMntPth": 2,
    "archCopyId": 0,
    "backupRetentionDays": 0,
    "numOfWritersForLibrary": 0,
    "diskCapacity": 0,
    "reserveSpaceInMB": 0,
    "resrvSpaceForSiloRestores": 2,
    "serverType": 0,
    "libSerialNumber": "",
    "markDrive": 0,
    "objectAddress": 0,
    "lowWaterMark": 0,
    "mountPathId": 0,
    "preferMountPathWithFreeSpace": 2,
    "libraryType": 0,
    "mountPathUsage": 0
  }
}

POST /library

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

token

Action — query

Body

Default
Detect Tape Library
Library
Cloud Library
Delete Library

{
  "autoDetect": true,
  "hdr": {
    "tag": 0
  },
  "mediaAgentIdList": [
    {}
  ],
  "isConfigRequired": 0,
  "library": {
    "libraryName": "string",
    "opType": 0,
    "mediaAgentId": 0,
    "password": "string",
    "loginName": "string",
    "mountPath": "string",
    "isCloud": 0,
    "serverType": 0,
    "baseFolder": "string",
    "savedCredential": {
      "credentialName": "string"
    }
  },
  "isDeconfigLibrary": 0
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Library' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "autoDetect": true,
  "hdr": {
    "tag": 0
  },
  "mediaAgentIdList": [
    {}
  ],
  "isConfigRequired": 0,
  "library": {
    "libraryName": "string",
    "opType": 0,
    "mediaAgentId": 0,
    "password": "string",
    "loginName": "string",
    "mountPath": "string",
    "isCloud": 0,
    "serverType": 0,
    "baseFolder": "string",
    "savedCredential": {
      "credentialName": "string"
    }
  },
  "isDeconfigLibrary": 0
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Library' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "autoDetect": true,
  "hdr": {
    "tag": 0
  },
  "mediaAgentIdList": [
    {}
  ],
  "isConfigRequired": 0,
  "library": {
    "libraryName": "string",
    "opType": 0,
    "mediaAgentId": 0,
    "password": "string",
    "loginName": "string",
    "mountPath": "string",
    "isCloud": 0,
    "serverType": 0,
    "baseFolder": "string",
    "savedCredential": {
      "credentialName": "string"
    }
  },
  "isDeconfigLibrary": 0
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Library' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "autoDetect": true,
  "hdr": {
    "tag": 0
  },
  "mediaAgentIdList": [
    {}
  ],
  "isConfigRequired": 0,
  "library": {
    "libraryName": "string",
    "opType": 0,
    "mediaAgentId": 0,
    "password": "string",
    "loginName": "string",
    "mountPath": "string",
    "isCloud": 0,
    "serverType": 0,
    "baseFolder": "string",
    "savedCredential": {
      "credentialName": "string"
    }
  },
  "isDeconfigLibrary": 0
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Library' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "autoDetect": true,
  "hdr": {
    "tag": 0
  },
  "mediaAgentIdList": [
    {}
  ],
  "isConfigRequired": 0,
  "library": {
    "libraryName": "string",
    "opType": 0,
    "mediaAgentId": 0,
    "password": "string",
    "loginName": "string",
    "mountPath": "string",
    "isCloud": 0,
    "serverType": 0,
    "baseFolder": "string",
    "savedCredential": {
      "credentialName": "string"
    }
  },
  "isDeconfigLibrary": 0
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Library' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "autoDetect": true,
  "hdr": {
    "tag": 0
  },
  "mediaAgentIdList": [
    {}
  ],
  "isConfigRequired": 0,
  "library": {
    "libraryName": "string",
    "opType": 0,
    "mediaAgentId": 0,
    "password": "string",
    "loginName": "string",
    "mountPath": "string",
    "isCloud": 0,
    "serverType": 0,
    "baseFolder": "string",
    "savedCredential": {
      "credentialName": "string"
    }
  },
  "isDeconfigLibrary": 0
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Library' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "autoDetect": true,
  "hdr": {
    "tag": 0
  },
  "mediaAgentIdList": [
    {}
  ],
  "isConfigRequired": 0,
  "library": {
    "libraryName": "string",
    "opType": 0,
    "mediaAgentId": 0,
    "password": "string",
    "loginName": "string",
    "mountPath": "string",
    "isCloud": 0,
    "serverType": 0,
    "baseFolder": "string",
    "savedCredential": {
      "credentialName": "string"
    }
  },
  "isDeconfigLibrary": 0
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Library' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "autoDetect": true,
  "hdr": {
    "tag": 0
  },
  "mediaAgentIdList": [
    {}
  ],
  "isConfigRequired": 0,
  "library": {
    "libraryName": "string",
    "opType": 0,
    "mediaAgentId": 0,
    "password": "string",
    "loginName": "string",
    "mountPath": "string",
    "isCloud": 0,
    "serverType": 0,
    "baseFolder": "string",
    "savedCredential": {
      "credentialName": "string"
    }
  },
  "isDeconfigLibrary": 0
}'

Configure Library​

Authorization

Request

Configure Library