Tape_drives

(By tape library) Lists all tape drives.

get

API Key Scope: tape_drives / index

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

tape_library_idstringRequired

Numeric ID, serial, or name of tape library.

Query parameters

limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

sort_bystring[]Optional

Sort results by attribute.

Can sort on multiple attributes, separated by |. Order direction can be suffixing the attribute by either :asc (default) or :desc.

idstringOptional

Filter on id

namestringOptional

Filter on name

serialstringOptional

Filter on serial

commentstringOptional

Filter on comment

scsi_addressstringOptional

Filter on scsi address

vendorstringOptional

Filter on vendor

productstringOptional

Filter on product

firmwarestringOptional

Filter on firmware

devicestringOptional

Filter on device

sgdevicestringOptional

Filter on sgdevice

libsostringOptional

Filter on libso

acsstringOptional

Filter on acs

lsmstringOptional

Filter on lsm

panelstringOptional

Filter on panel

transportstringOptional

Filter on transport

statusstringOptional

Filter on status

fullstringOptional

Filter on full

mount_countstringOptional

Filter on mount count

use_tostringOptional

Filter on use to

use_bystringOptional

Filter on use by

barcodestringOptional

Filter on barcode

task_idstringOptional

Filter on task id

use_file_processed_sizestringOptional

Filter on use file processed size

use_file_size_to_processstringOptional

Filter on use file size to process

use_file_name_processedstringOptional

Filter on use file name processed

bandwidthstringOptional

Filter on bandwidth

Responses

200

List of tape drives.

application/json

countintegerRead-onlyOptionalExample: 1

get

/tape_libraries/{tape_library_id}/tape_drives

HTTPcURLJavaScriptPython

GET /api/v2/tape_libraries/{tape_library_id}/tape_drives HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

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
    }
  ]
}

(By tape library) Creates a new tape drive.

post

API Key Scope: tape_drives / create

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

tape_library_idstringRequired

Numeric ID, serial, or name of tape library.

Body

application/json

Responses

201

A specific tape drive.

application/json

422

The received resource was not correctly formatted.

application/json

post

/tape_libraries/{tape_library_id}/tape_drives

HTTPcURLJavaScriptPython

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
}

Lists tape drives devices.

get

API Key Scope: tape_drives / devices

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

tape_library_idstringRequired

Numeric ID, serial, or name of tape library.

Query parameters

job_idstringOptional

ID of active job

Responses

200

List of tape drives devices.

application/json

or

202

An active job that may be queued, working, completed or failed.

application/json

500

An active job that may be queued, working, completed or failed.

application/json

get

/tape_libraries/{tape_library_id}/tape_drives/-/devices

HTTPcURLJavaScriptPython

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"
    }
  ]
}

Lists all tape drives.

get

API Key Scope: tape_drives / index

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Query parameters

limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

sort_bystring[]Optional

Sort results by attribute.

Can sort on multiple attributes, separated by |. Order direction can be suffixing the attribute by either :asc (default) or :desc.

idstringOptional

Filter on id

tape_library_idstringOptional

Filter on tape library id

namestringOptional

Filter on name

serialstringOptional

Filter on serial

commentstringOptional

Filter on comment

scsi_addressstringOptional

Filter on scsi address

vendorstringOptional

Filter on vendor

productstringOptional

Filter on product

firmwarestringOptional

Filter on firmware

devicestringOptional

Filter on device

sgdevicestringOptional

Filter on sgdevice

libsostringOptional

Filter on libso

acsstringOptional

Filter on acs

lsmstringOptional

Filter on lsm

panelstringOptional

Filter on panel

transportstringOptional

Filter on transport

statusstringOptional

Filter on status

fullstringOptional

Filter on full

mount_countstringOptional

Filter on mount count

use_tostringOptional

Filter on use to

use_bystringOptional

Filter on use by

barcodestringOptional

Filter on barcode

task_idstringOptional

Filter on task id

use_file_processed_sizestringOptional

Filter on use file processed size

use_file_size_to_processstringOptional

Filter on use file size to process

use_file_name_processedstringOptional

Filter on use file name processed

bandwidthstringOptional

Filter on bandwidth

Responses

200

List of tape drives.

application/json

countintegerRead-onlyOptionalExample: 1

get

/tape_drives

HTTPcURLJavaScriptPython

GET /api/v2/tape_drives HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

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
    }
  ]
}

Displays a specific tape drive.

get

API Key Scope: tape_drives / show

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

tape_drive_serialstringRequired

Serial, or name of tape drive.

Responses

200

A specific tape drive.

application/json

get

/tape_drives/{tape_drive_serial}

HTTPcURLJavaScriptPython

GET /api/v2/tape_drives/{tape_drive_serial} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

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
}

Updates a specific tape drive.

put

API Key Scope: tape_drives / update

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

tape_drive_serialstringRequired

Serial, or name of tape drive.

Body

application/json

Responses

200

A specific tape drive.

application/json

422

The received resource was not correctly formatted.

application/json

put

/tape_drives/{tape_drive_serial}

HTTPcURLJavaScriptPython

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
}

Destroys a specific tape drive.

delete

API Key Scope: tape_drives / destroy

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

tape_drive_serialstringRequired

Serial, or name of tape drive.

Responses

204

Tape drive destroyed.

delete

/tape_drives/{tape_drive_serial}

HTTPcURLJavaScriptPython

DELETE /api/v2/tape_drives/{tape_drive_serial} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

204

Tape drive destroyed.

No content

Display statistic for a specific tape drive.

get

API Key Scope: tape_drive_stats / show

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

tape_drive_serialstringRequired

Serial, or name of tape drive.

Responses

200

A specific tape drive statistic.

application/json

log_timestringRead-onlyOptional

serialstringRead-onlyOptional

total_corrected_write_errorsintegerRead-onlyOptional

total_write_retriesintegerRead-onlyOptional

total_write_kbytes_processedintegerRead-onlyOptional

total_uncorrected_write_errorsintegerRead-onlyOptional

total_corrected_read_errorsintegerRead-onlyOptional

total_read_retriesintegerRead-onlyOptional

total_read_kbytes_processedintegerRead-onlyOptional

total_uncorrected_read_errorsintegerRead-onlyOptional

total_channel_write_bytesintegerRead-onlyOptional

total_device_write_bytesintegerRead-onlyOptional

total_device_read_bytesintegerRead-onlyOptional

total_channel_read_bytesintegerRead-onlyOptional

cleaning_requestedintegerRead-onlyOptional

total_mbytes_processed_since_cleaningintegerRead-onlyOptional

lifetime_load_cyclesintegerRead-onlyOptional

lifetime_cleaning_cyclesintegerRead-onlyOptional

lifetime_power_on_timeintegerRead-onlyOptional

lifetime_volume_loadsintegerRead-onlyOptional

lifetime_cleaning_operationsintegerRead-onlyOptional

lifetime_power_on_hoursintegerRead-onlyOptional

lifetime_medium_motionintegerRead-onlyOptional

lifetime_meters_of_tape_processedintegerRead-onlyOptional

lifetime_medium_motion_when_incompatible_medium_was_loadedintegerRead-onlyOptional

lifetime_power_on_hours_when_temperature_cond_occuredintegerRead-onlyOptional

lifetime_power_on_hours_when_power_consumption_cond_occuredintegerRead-onlyOptional

medium_motion_hours_last_success_cleaningintegerRead-onlyOptional

medium_motion_hours_second_success_cleaningintegerRead-onlyOptional

medium_motion_hours_third_success_cleaningintegerRead-onlyOptional

lifetime_power_on_emergency_eject_occuredintegerRead-onlyOptional

lifetime_power_cyclesintegerRead-onlyOptional

volume_loads_last_param_resetintegerRead-onlyOptional

hard_write_errorsintegerRead-onlyOptional

hard_read_errorsintegerRead-onlyOptional

read_duty_cycleintegerRead-onlyOptional

write_duty_cycleintegerRead-onlyOptional

activity_duty_cycleintegerRead-onlyOptional

volume_not_present_duty_cycleintegerRead-onlyOptional

ready_duty_cycleintegerRead-onlyOptional

accumulated_transitions_to_activeintegerRead-onlyOptional

accumulated_transitions_to_idleintegerRead-onlyOptional

404

The requested resource was not found. The detailed error will be of type not_found.

application/json

get

/tape_drives/{tape_drive_serial}/tape_drive_stat

HTTPcURLJavaScriptPython

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
}

List all tape drive statistics.

get

API Key Scope: tape_drive_stats / index

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Query parameters

limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

Responses

200

List of tape drive statistics.

application/json

countintegerRead-onlyOptionalExample: 1

404

The requested resource was not found. The detailed error will be of type not_found.

application/json

get

/tape_drive_stats

HTTPcURLJavaScriptPython

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
    }
  ]
}