This operation creates a disk library.
Request
Syntax
POST webservice/Library HTTP/1.1 Host: host name Accept: application/xml Authtoken: authentication token Content-type: application/xml <create_disk_library_template.xml>
where <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Headers
|
Name |
Description |
|---|---|
|
Host |
The host name of the Web Server or the Command Center used in the API request. |
|
Accept |
The format of the response. Valid values are: application/xml or application/json. |
|
Authtoken |
The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication. |
|
Content-type |
The media type contained in the request body. |
XML
Download the create_disk_library_template.xml file required for this request. The following table displays the parameters for the create_disk_library_template.xml file.
|
Name |
Description |
Element |
Parent Element |
|---|---|---|---|
|
isConfigRequired |
Valid value is 1. |
EVGui_ConfigureStorageLibraryReq |
|
|
mediaAgentId |
The system-generated ID assigned to the MediaAgent. |
library |
EVGui_ConfigureStorageLibraryReq |
|
libraryName |
The name of the library. |
library |
EVGui_ConfigureStorageLibraryReq |
|
mountPath |
The path where the data is written to and read from. |
library |
EVGui_ConfigureStorageLibraryReq |
|
loginName |
The user name that used by the system to access the mount path. |
library |
EVGui_ConfigureStorageLibraryReq |
|
password |
The password for the user name. |
library |
EVGui_ConfigureStorageLibraryReq |
|
opType |
Valid value is 1. |
library |
EVGui_ConfigureStorageLibraryReq |
Response
Response Parameters
|
Parameter |
Description |
Element |
|---|---|---|
|
archCopyId |
library |
|
|
archCopyName |
library |
|
|
archGroupId |
library |
|
|
archGroupName |
library |
|
|
backupRetentionDays |
library |
|
|
createStoragePolicy |
The option to create a storage policy. Valid values are:
|
library |
|
description |
library |
|
|
diskCapacity |
library |
|
|
isAutomaticallyManageDisk |
library |
|
|
isCloud |
library |
|
|
libSerialNumber |
The serial number of the library. Valid value for a PnP library is PnP. |
library |
|
libraryId |
The system-generated ID assigned to the library. |
library |
|
libraryName |
The name of the library. |
library |
|
libraryType |
library |
|
|
loginName |
library |
|
|
mediaAgentId |
The system-generated ID assigned to the MediaAgent. |
library |
|
mediaAgentName |
The name of the MediaAgent. |
library |
|
mountPath |
The path where the data is written to and read from. |
library |
|
mountPathId |
library |
|
|
objectAddress |
library |
|
|
opType |
library |
|
|
password |
library |
|
|
proxyPassword |
library |
|
|
serverType |
library |
Examples
Sample Request
POST webservice/Library HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml
<EVGui_ConfigureStorageLibraryReq isConfigRequired="1">
<library mediaAgentId="1234" libraryName="library001" mountPath="c:\library001" loginName="" password="" opType="1"/>
</EVGui_ConfigureStorageLibraryReq>Sample Response
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<EVGui_ConfigureStorageLibraryResp><library archCopyId="0"
archCopyName="" archGroupId="0" archGroupName="" backupRetentionDays="0" createStoragePolicy="0" description=""
diskCapacity="0" isAutomaticallyManageDisk="0" isCloud="0" libSerialNumber="" libraryId="-1" libraryName="library001" libraryType="3"
loginName="" mediaAgentId="0" mediaAgentName="" mountPath="c:\library001" mountPathId="0" objectAddress="0" opType="0"
password="UDl1NDU4OQ==" proxyPassword="UDl1NDU4OQ==" serverType="0"/></EVGui_ConfigureStorageLibraryResp>