REST API - POST Cloud Library

This operation creates a cloud library.

Request

Syntax

XML

 
POST <webservice>/Library HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>
Content-type: application/xml
<create_cloud_library_template.xml>

JSON

 
POST <webservice>/Library HTTP/1.1
Host: <host name>
Accept: application/json
Authtoken: <authentication token>
Content-type: application/json
<create_cloud_library_template.json>

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 Web Console 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.

Request Body

Download the XML or JSON file required for this request: create_cloud_library_template.xml or create_cloud_library_template.json. The following table displays the parameters for the request body.

Name	Description	Element	Parent Element
isConfigRequired	Valid value is 1.	EVGui_ConfigureStorageLibraryReq
MediaAgentName	The name of 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
isCloud	Valid value is 1.	library	EVGui_ConfigureStorageLibraryReq
credentialName	The name of the credential that you created using the Credential Manager. If you enter the credential name, then update the loginName parameter in the format of "<vendorURL>//__CVCRED__". For example, "s3.amazonaws.com//__CVCRED__".	savedCredential	EVGui_ConfigureStorageLibraryReq

For more information on the specific parameters required by each vendor, see Cloud Libraries - Vendor Specific XML Parameters.

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: 1, create a storage policy 0, do not create a storage policy	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

This request creates a cloud library.

XML

POST <webservice>/Library HTTP/1.1
 Host: client.mydomain.com
 Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
 0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
 8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
 40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
 68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
 3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
 Content-type: application/xml
<EVGui_ConfigureStorageLibraryReq isConfigRequired="1">
    <library mediaAgentName="MA1" libraryName="Library1" mountPath="MP1" isCloud="1" opType="1" serverType="3" loginName="blob.core.windows.net@1//__CVCRED__" password="" baseFolder="">
       <savedCredential credentialId="" credentialName="credential1"/>
    </library>
</EVGui_ConfigureStorageLibraryReq>

JSON

POST <webservice>/Library HTTP/1.1
 Host: client.mydomain.com
 Accept: application/json
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
 0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
 8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
 40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
 68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
 3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
 Content-type: application/json
 {
  "isConfigRequired": 1,
  "library": {
    "libraryName": "Library1",
    "opType": 1,
    "isCloud": 1,
    "mediaAgentName": "MA1",
    "serverType":3,
    "password": "",
    "loginName": "blob.core.windows.net@1//__CVCRED__",
    "mountPath": "MP1",
    "baseFolder":"",
    "savedCredential": {
        "credentialName": "credential1"
    }
  }
}

Sample Response

XML

<EVGui_ConfigureStorageLibraryResp>
    <library deviceAccessType="0" opType="0" errorCode="0" deviceId="0" deviceName="" mediaAgentId="2" password="" warningWaterMark="0" preferMountPathAccordingToMA="2" loginName="" archCopyName="" mediaAgentName="MA1" deviceType="0" hideLibrary="2" isCloud="0" reserveSpaceInMB="0" preventDataBlockReferences="2" serverType="0" markDrive="0" mountPathId="0" libraryType="0" mountPathUsage="0" libraryName="Library1" stopDataAgingWhenDataOccupiedOnDiskIs="0" enablePruningOfAgedData="2" libraryId="76" archGroupId="0" description="" driveName="" startDataAgingWhenDataOccupiedOnDiskIs="0" numOfWritersForMountpath="1001" usePnpWhenBlank="2" baseFolder="" markLibForMaintenance="2" useDPSettingsForPruning="2" NDMPServer="" mountPath="MP1" archGroupName="" isAutomaticallyManageDisk="0" createStoragePolicy="0" proxyPassword="" preventDataDelFromMntPth="2" archCopyId="0" backupRetentionDays="0" numOfWritersForLibrary="0" diskCapacity="0" resrvSpaceForSiloRestores="2" libSerialNumber="" objectAddress="0" lowWaterMark="0" preferMountPathWithFreeSpace="2">
        <hybridCloudOption enableHybridCloud="2">
            <diskLibrary _type_="9" />
        </hybridCloudOption>
        <savedCredential _type_="174" />
    </library>
</EVGui_ConfigureStorageLibraryResp>

JSON

{
    "library": {
        "deviceAccessType": 0,
        "opType": 0,
        "errorCode": 0,
        "deviceId": 0,
        "deviceName": "",
        "mediaAgentId": 2,
        "password": "",
        "warningWaterMark": 0,
        "preferMountPathAccordingToMA": 2,
        "loginName": "",
        "archCopyName": "",
        "mediaAgentName": "MA1",
        "deviceType": 0,
        "hideLibrary": 2,
        "isCloud": 0,
        "reserveSpaceInMB": 0,
        "preventDataBlockReferences": 2,
        "serverType": 0,
        "markDrive": 0,
        "mountPathId": 0,
        "libraryType": 0,
        "mountPathUsage": 0,
        "libraryName": "Library1",
        "stopDataAgingWhenDataOccupiedOnDiskIs": 0,
        "enablePruningOfAgedData": 2,
        "libraryId": 75,
        "archGroupId": 0,
        "description": "",
        "driveName": "",
        "startDataAgingWhenDataOccupiedOnDiskIs": 0,
        "numOfWritersForMountpath": 1001,
        "usePnpWhenBlank": 2,
        "baseFolder": "",
        "markLibForMaintenance": 2,
        "useDPSettingsForPruning": 2,
        "NDMPServer": "",
        "mountPath": "MP1",
        "archGroupName": "",
        "isAutomaticallyManageDisk": 0,
        "createStoragePolicy": 0,
        "proxyPassword": "",
        "preventDataDelFromMntPth": 2,
        "archCopyId": 0,
        "backupRetentionDays": 0,
        "numOfWritersForLibrary": 0,
        "diskCapacity": 0,
        "resrvSpaceForSiloRestores": 2,
        "libSerialNumber": "",
        "objectAddress": 0,
        "lowWaterMark": 0,
        "preferMountPathWithFreeSpace": 2,
        "hybridCloudOption": {
            "enableHybridCloud": 2,
            "diskLibrary": {
                "_type_": 9
            }
        },
        "savedCredential": {
            "_type_": 174
        }
    }
}