Tape Drives
API Key Scope: tape_drives / index
Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID, serial, or name of tape library.
The number of items to display for pagination.
The number of items to skip for pagination.
Sort results by attribute.
Can sort on multiple attributes, separated by |.
Order direction can be suffixing the attribute by either :asc (default) or :desc.
Filter on id
Filter on name
Filter on serial
Filter on comment
Filter on scsi address
Filter on vendor
Filter on product
Filter on firmware
Filter on device
Filter on sgdevice
Filter on libso
Filter on acs
Filter on lsm
Filter on panel
Filter on transport
Filter on status
Filter on full
Filter on mount count
Filter on use to
Filter on use by
Filter on barcode
Filter on task id
Filter on use file processed size
Filter on use file size to process
Filter on use file name processed
Filter on bandwidth
List of tape drives.
1GET /api/v2/tape_libraries/{tape_library_id}/tape_drives HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
List of tape drives.
{
"count": 1,
"tape_drives": [
{
"serial": "C0F9000A01",
"scsi_address": 256,
"vendor": "IBM",
"product": "ULT3580-TD5",
"firmware": "D711",
"device": "/dev/st5",
"sgdevice": "/dev/sg8",
"id": 1,
"tape_library_id": 2,
"name": "",
"comment": "",
"libso": "drive_lto",
"acs": 1,
"lsm": 1,
"panel": 1,
"transport": 1,
"status": "online",
"full": 1,
"mount_count": 1,
"use_to": "Idle",
"use_by": "Idle",
"barcode": "NOD407L5",
"task_id": 14,
"use_file_processed_size": 1,
"use_file_size_to_process": 1,
"use_file_name_processed": "text",
"bandwidth": 1
}
]
}API Key Scope: tape_drives / create
Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID, serial, or name of tape library.
C0F9000A01256IBMULT3580-TD5D711When saved, device may be prefixed by n (eg. /dev/nst5)
/dev/st5/dev/sg8This ID is not unique. Only unique among a tape library.
12drive_ltoonlinePossible values: IdleIdleNOD407L514A specific tape drive.
C0F9000A01256IBMULT3580-TD5D711When saved, device may be prefixed by n (eg. /dev/nst5)
/dev/st5/dev/sg8This ID is not unique. Only unique among a tape library.
12drive_ltoonlinePossible values: IdleIdleNOD407L514The received resource was not correctly formatted.
POST /api/v2/tape_libraries/{tape_library_id}/tape_drives HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 202
{
"scsi_address": 256,
"vendor": "IBM",
"product": "ULT3580-TD5",
"firmware": "D711",
"device": "/dev/st5",
"sgdevice": "/dev/sg8",
"name": "",
"comment": "",
"libso": "drive_lto",
"acs": 1,
"lsm": 1,
"panel": 1,
"transport": 1
}{
"serial": "C0F9000A01",
"scsi_address": 256,
"vendor": "IBM",
"product": "ULT3580-TD5",
"firmware": "D711",
"device": "/dev/st5",
"sgdevice": "/dev/sg8",
"id": 1,
"tape_library_id": 2,
"name": "",
"comment": "",
"libso": "drive_lto",
"acs": 1,
"lsm": 1,
"panel": 1,
"transport": 1,
"status": "online",
"full": 1,
"mount_count": 1,
"use_to": "Idle",
"use_by": "Idle",
"barcode": "NOD407L5",
"task_id": 14,
"use_file_processed_size": 1,
"use_file_size_to_process": 1,
"use_file_name_processed": "text",
"bandwidth": 1
}API Key Scope: tape_drives / devices
Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID, serial, or name of tape library.
ID of active job
List of tape drives devices.
An active job that may be queued, working, completed or failed.
An active job that may be queued, working, completed or failed.
GET /api/v2/tape_libraries/{tape_library_id}/tape_drives/-/devices HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
"tape_drives": [
{
"serial": "C0F9000A01",
"scsi_address": 256,
"vendor": "IBM",
"product": "ULT3580-TD5",
"firmware": "D711",
"device": "/dev/st5",
"sgdevice": "/dev/sg8"
}
]
}API Key Scope: tape_drives / index
Pass the username and password of a user in the authorization header. This currently gives full access.
The number of items to display for pagination.
The number of items to skip for pagination.
Sort results by attribute.
Can sort on multiple attributes, separated by |.
Order direction can be suffixing the attribute by either :asc (default) or :desc.
Filter on id
Filter on tape library id
Filter on name
Filter on serial
Filter on comment
Filter on scsi address
Filter on vendor
Filter on product
Filter on firmware
Filter on device
Filter on sgdevice
Filter on libso
Filter on acs
Filter on lsm
Filter on panel
Filter on transport
Filter on status
Filter on full
Filter on mount count
Filter on use to
Filter on use by
Filter on barcode
Filter on task id
Filter on use file processed size
Filter on use file size to process
Filter on use file name processed
Filter on bandwidth
List of tape drives.
1GET /api/v2/tape_drives HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
List of tape drives.
{
"count": 1,
"tape_drives": [
{
"serial": "C0F9000A01",
"scsi_address": 256,
"vendor": "IBM",
"product": "ULT3580-TD5",
"firmware": "D711",
"device": "/dev/st5",
"sgdevice": "/dev/sg8",
"id": 1,
"tape_library_id": 2,
"name": "",
"comment": "",
"libso": "drive_lto",
"acs": 1,
"lsm": 1,
"panel": 1,
"transport": 1,
"status": "online",
"full": 1,
"mount_count": 1,
"use_to": "Idle",
"use_by": "Idle",
"barcode": "NOD407L5",
"task_id": 14,
"use_file_processed_size": 1,
"use_file_size_to_process": 1,
"use_file_name_processed": "text",
"bandwidth": 1
}
]
}API Key Scope: tape_drives / show
Pass the username and password of a user in the authorization header. This currently gives full access.
Serial, or name of tape drive.
A specific tape drive.
C0F9000A01256IBMULT3580-TD5D711When saved, device may be prefixed by n (eg. /dev/nst5)
/dev/st5/dev/sg8This ID is not unique. Only unique among a tape library.
12drive_ltoonlinePossible values: IdleIdleNOD407L514GET /api/v2/tape_drives/{tape_drive_serial} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
A specific tape drive.
{
"serial": "C0F9000A01",
"scsi_address": 256,
"vendor": "IBM",
"product": "ULT3580-TD5",
"firmware": "D711",
"device": "/dev/st5",
"sgdevice": "/dev/sg8",
"id": 1,
"tape_library_id": 2,
"name": "",
"comment": "",
"libso": "drive_lto",
"acs": 1,
"lsm": 1,
"panel": 1,
"transport": 1,
"status": "online",
"full": 1,
"mount_count": 1,
"use_to": "Idle",
"use_by": "Idle",
"barcode": "NOD407L5",
"task_id": 14,
"use_file_processed_size": 1,
"use_file_size_to_process": 1,
"use_file_name_processed": "text",
"bandwidth": 1
}API Key Scope: tape_drives / update
Pass the username and password of a user in the authorization header. This currently gives full access.
Serial, or name of tape drive.
C0F9000A01256IBMULT3580-TD5D711When saved, device may be prefixed by n (eg. /dev/nst5)
/dev/st5/dev/sg8This ID is not unique. Only unique among a tape library.
12drive_ltoonlinePossible values: IdleIdleNOD407L514A specific tape drive.
C0F9000A01256IBMULT3580-TD5D711When saved, device may be prefixed by n (eg. /dev/nst5)
/dev/st5/dev/sg8This ID is not unique. Only unique among a tape library.
12drive_ltoonlinePossible values: IdleIdleNOD407L514The received resource was not correctly formatted.
PUT /api/v2/tape_drives/{tape_drive_serial} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 202
{
"scsi_address": 256,
"vendor": "IBM",
"product": "ULT3580-TD5",
"firmware": "D711",
"device": "/dev/st5",
"sgdevice": "/dev/sg8",
"name": "",
"comment": "",
"libso": "drive_lto",
"acs": 1,
"lsm": 1,
"panel": 1,
"transport": 1
}{
"serial": "C0F9000A01",
"scsi_address": 256,
"vendor": "IBM",
"product": "ULT3580-TD5",
"firmware": "D711",
"device": "/dev/st5",
"sgdevice": "/dev/sg8",
"id": 1,
"tape_library_id": 2,
"name": "",
"comment": "",
"libso": "drive_lto",
"acs": 1,
"lsm": 1,
"panel": 1,
"transport": 1,
"status": "online",
"full": 1,
"mount_count": 1,
"use_to": "Idle",
"use_by": "Idle",
"barcode": "NOD407L5",
"task_id": 14,
"use_file_processed_size": 1,
"use_file_size_to_process": 1,
"use_file_name_processed": "text",
"bandwidth": 1
}API Key Scope: tape_drives / destroy
Pass the username and password of a user in the authorization header. This currently gives full access.
Serial, or name of tape drive.
Tape drive destroyed.
No content
DELETE /api/v2/tape_drives/{tape_drive_serial} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
Tape drive destroyed.
No content
API Key Scope: tape_drive_stats / show
Pass the username and password of a user in the authorization header. This currently gives full access.
Serial, or name of tape drive.
A specific tape drive statistic.
The requested resource was not found. The detailed error will be of type not_found.
GET /api/v2/tape_drives/{tape_drive_serial}/tape_drive_stat HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
"log_time": "text",
"serial": "text",
"total_corrected_write_errors": 1,
"total_write_retries": 1,
"total_write_kbytes_processed": 1,
"total_uncorrected_write_errors": 1,
"total_corrected_read_errors": 1,
"total_read_retries": 1,
"total_read_kbytes_processed": 1,
"total_uncorrected_read_errors": 1,
"total_channel_write_bytes": 1,
"total_device_write_bytes": 1,
"total_device_read_bytes": 1,
"total_channel_read_bytes": 1,
"cleaning_requested": 1,
"total_mbytes_processed_since_cleaning": 1,
"lifetime_load_cycles": 1,
"lifetime_cleaning_cycles": 1,
"lifetime_power_on_time": 1,
"lifetime_volume_loads": 1,
"lifetime_cleaning_operations": 1,
"lifetime_power_on_hours": 1,
"lifetime_medium_motion": 1,
"lifetime_meters_of_tape_processed": 1,
"lifetime_medium_motion_when_incompatible_medium_was_loaded": 1,
"lifetime_power_on_hours_when_temperature_cond_occured": 1,
"lifetime_power_on_hours_when_power_consumption_cond_occured": 1,
"medium_motion_hours_last_success_cleaning": 1,
"medium_motion_hours_second_success_cleaning": 1,
"medium_motion_hours_third_success_cleaning": 1,
"lifetime_power_on_emergency_eject_occured": 1,
"lifetime_power_cycles": 1,
"volume_loads_last_param_reset": 1,
"hard_write_errors": 1,
"hard_read_errors": 1,
"read_duty_cycle": 1,
"write_duty_cycle": 1,
"activity_duty_cycle": 1,
"volume_not_present_duty_cycle": 1,
"ready_duty_cycle": 1,
"accumulated_transitions_to_active": 1,
"accumulated_transitions_to_idle": 1
}API Key Scope: tape_drive_stats / index
Pass the username and password of a user in the authorization header. This currently gives full access.
The number of items to display for pagination.
The number of items to skip for pagination.
List of tape drive statistics.
1The requested resource was not found. The detailed error will be of type not_found.
GET /api/v2/tape_drive_stats HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
"count": 1,
"tape_drive_stats": [
{
"log_time": "text",
"serial": "text",
"total_corrected_write_errors": 1,
"total_write_retries": 1,
"total_write_kbytes_processed": 1,
"total_uncorrected_write_errors": 1,
"total_corrected_read_errors": 1,
"total_read_retries": 1,
"total_read_kbytes_processed": 1,
"total_uncorrected_read_errors": 1,
"total_channel_write_bytes": 1,
"total_device_write_bytes": 1,
"total_device_read_bytes": 1,
"total_channel_read_bytes": 1,
"cleaning_requested": 1,
"total_mbytes_processed_since_cleaning": 1,
"lifetime_load_cycles": 1,
"lifetime_cleaning_cycles": 1,
"lifetime_power_on_time": 1,
"lifetime_volume_loads": 1,
"lifetime_cleaning_operations": 1,
"lifetime_power_on_hours": 1,
"lifetime_medium_motion": 1,
"lifetime_meters_of_tape_processed": 1,
"lifetime_medium_motion_when_incompatible_medium_was_loaded": 1,
"lifetime_power_on_hours_when_temperature_cond_occured": 1,
"lifetime_power_on_hours_when_power_consumption_cond_occured": 1,
"medium_motion_hours_last_success_cleaning": 1,
"medium_motion_hours_second_success_cleaning": 1,
"medium_motion_hours_third_success_cleaning": 1,
"lifetime_power_on_emergency_eject_occured": 1,
"lifetime_power_cycles": 1,
"volume_loads_last_param_reset": 1,
"hard_write_errors": 1,
"hard_read_errors": 1,
"read_duty_cycle": 1,
"write_duty_cycle": 1,
"activity_duty_cycle": 1,
"volume_not_present_duty_cycle": 1,
"ready_duty_cycle": 1,
"accumulated_transitions_to_active": 1,
"accumulated_transitions_to_idle": 1
}
]
}Last updated
Was this helpful?