Create Tape Library

Product version: 10.11

Last modified: 31 July 2024

Creates a new tape library.

Endpoint

https://<Director_IP_address>:4443/c/router

Tenant Endpoint

For tenants of the multi-tenant product the endpoint must be:

https://<Director_IP_address>:4443/t/<tenant_UUID>/c/router

Request Example

This is an example of creating a tape library in a local folder on the assigned Transporter host.

curl

Copy

curl --request POST \
     --url https://<Director_IP_address>:4443/c/router \
     --header "content-type: application/json" \
     --cookie @cookies.txt \
     --data '{ 
            "action": "TapeLibraryManagement", 
            "method": "create", 
            "data": [{ 
           "id": null,
                  "compression": "HARDWARE_BASED",
                  "icon": "",
                  "locationId": 1,
                  "locationName": "",
                  "lockReasons": null,
                  "mediaPoolId": null,
                  "mediaPoolName": null,
                  "name": "VTL",
                  "offlineLocationId": 2,
                  "offlineLocationName": null,
                  "text": "",
                  "transporterId": 1,
                  "transporterName": "",
                  "blockSize": 262144,
                  "changer": {
                         "checked": true,
                         "deviceName": "HP-Compag-5000",
                         "disabledCheck": false,
                         "discovered": false,
                         "icon": "",
                         "iconCls": "iconTl24 icon24_0",
                         "id": null,
                         "path": "library_2",
                         "scsiAddress": "1:1:1:1",
                         "serialNumber": "qMB3XTGEZdaRjfMT",
                         "slots": null,
                         "text": "",
                         "uuid": "67453fce-e58d-4ed1-a926-65b8ff16202",
                         "drives": [
                                 {
                                 "checked": true,
                                 "deviceName": "library_2_drive_0",
                                 "disabledCheck": false,
                                 "discovered": false,
                                 "icon": "",
                                 "iconCls": "iconTd24 icon24_0",
                                 "index": 0,
                                 "path": "library_2_drive_0",
                                 "previousIndex": 0,
                                 "scsiAddress": "1:1:1:2",
                                 "serialNumber": "df46KWKPsayeFocu",
                                 "text": "",
                                 "uuid": "10453fce-e58d-4ed1-a926-65b28f17001"
                                 },
                                 {
                                 "checked": true,
                                 "deviceName": "library_2_drive_1",
                                 "disabledCheck": false,
                                 "discovered": false,
                                 "icon": "",
                                 "iconCls": "iconTd24 icon24_0",
                                 "index": 1,
                                 "path": "library_2_drive_1",
                                 "previousIndex": 1,
                                 "scsiAddress": "1:1:1:2",
                                 "serialNumber": "mapurxrowxb3d9dy",
                                 "text": "",
                                 "uuid": "00653fce-e58d-4ed1-28hj-65b28f17555"
                                 }
                    ]
                              }
                    }], 
            "type": "rpc", 
            "tid": 1}'

Request Fields

Field	Type	Value(s)	Description
`action`	string	`BackupManagement`	The action that is invoked
`method`	string	`create`	The method that is invoked
`data`	array		Data of a backup repository to be created
`type`	string	`rpc`	Type of communication protocol
`tid`	int	`1`	Transaction ID. Used to identify the request by both the client and the server

data

Field	Type	Description
`compression`	string	Compression level of the tape device. Possible values: `DISABLED, HARDWARE_BASED, SOFTWARE_BASED_FAST, SOFTWARE_BASED_MEDIUM, SOFTWARE_BASED_BEST`
`id`	int	Tape library ID. For the create method, this field is ignored
`name`	string	Tape library name
`transporterId`	`long`	ID of the assigned Transporter
`transporterName`	string	Name of the assigned Transporter
`blockSize`	int	Block size of the current tape device. Default value: `256 KB`
`locationId`	int	ID of the location of tape library
`locationName`	string	Name of location of tape library. Default value: "`My office`"
`mediaPoolId`	int	ID of the media pool of tape library
`mediaPoolName`	string	Name of media pool of tape library
`offlineLocationId`	int	ID of the location for tapes ejected from this tape library
`offlineLocationName`	string	Name of the location for tapes ejected from this tape library
`changer`
`id`	`long`	The changer ID
`deviceName`	string	Tape device name
`scsiAddress`	string	Changer SCSI address
`serialNumber`	string	The changer serial number
`path`	string	The path of changer
`uuid`	string	The changer UUID
`discovered`	boolean	Used only for handling the product GUI: true means the changer was added once to the product and it is cleared in the changers list
`checked`	boolean	Used only for handling the product GUI: true means the changer is selected in the changers list
`drives`
`uuid`	string	The tape library drive UUID
`id`	`long`	The tape library drive ID
`deviceName`	string	The tape library drive name
`path`	string	The path of the tape library drive
`scsiAddress`	string	SCSI address of the tape library drive
`serialNumber`	string	The tape library drive serial number

Response Sample

curl

Copy

 {
    "action": "TapeLibraryManagement",
    "method": "create",
    "tid": "1",
    "type": "rpc",
    "message": null,
    "where": null,
    "cause": null,
    "data": 35
}

Response Fields

Field	Value	Description
`message`	string	Message if the request failed
`where`	string	Reference to the method where problem occurred
`cause`	string	Cause of failure
`data`	`long`	ID of the tape library, which is created