### Start Drive Service Task

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Initiates a drive service start task.

```APIDOC
## POST /v1/tasks

### Description
Initiates a drive service start task.

### Method
POST

### Endpoint
/v1/tasks

### Request Body
- **type** (string) - Required - Must be "startDriveService".
- **location** (string) - Required - The location of the drive in the format "drive_F`<f>`C`<c>`R`<r>`".

### Request Example
```bash
curl -k -b cookies.txt -H "Content-Type: application/json" -X POST https://192.0.2.0/web/api/v1/tasks -d "{\"type\": \"startDriveService\", \"location\": \"drive_F1C3R5\"}"
```

### Response
#### Success Response (200)
[Details about the success response structure would go here if provided in the source]
```

--------------------------------

### Configure Library Installation Details

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Updates the library's installation and contact information. Requires a JSON payload with details like location, address, city, state, country, contact person, and phone numbers.

```curl
curl -k -b cookies.txt -H "Content-Type: application/json" -X POST https://192.0.2.0/web/api/v1/library -d "{\"location\": \"Storage Lab\", \"address\": \"0 Main St\", \"city\": \"Phoenix\", \"state\": \"AZ\", \"country\": \"US\", \"contact\": \"J%20Doe\"}"
```

--------------------------------

### Start Drive Service Task

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Creates a task to start a drive service. The location format is drive_F<f>C<c>R<r>.

```bash
curl -k -b cookies.txt -H "Content-Type: application/json" -X POST https://192.0.2.0/web/api/v1/tasks -d "{\"type\":\"startDriveService\", \"location\":\"drive_F1C3R5\"}"
```

--------------------------------

### Get all logs

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a list of available log files on the system.

```APIDOC
## GET /v1/logs

### Description
Retrieves a list of available log files on the system.

### Method
GET

### Endpoint
/v1/logs
```

--------------------------------

### Get all power supplies

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a list of all power supplies in the system.

```APIDOC
## GET /v1/powerSupplies

### Description
Retrieves a list of all power supplies in the system.

### Method
GET

### Endpoint
/v1/powerSupplies
```

--------------------------------

### Get GUI Settings

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves the current GUI settings. Requires authentication.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/guiSettings
```

--------------------------------

### Get All Logs

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a list of available log files.

```curl
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/logs
```

--------------------------------

### Get All Power Supplies

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a list of all power supplies in the system.

```curl
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/powerSupplies
```

--------------------------------

### Get all node cards

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a list of all node cards installed in the system.

```APIDOC
## GET /v1/nodeCards

### Description
Retrieves a list of all node cards installed in the system.

### Method
GET

### Endpoint
/v1/nodeCards
```

--------------------------------

### Get all I/O stations

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a list of all configured I/O stations in the system.

```APIDOC
## GET /v1/ioStations

### Description
Retrieves a list of all configured I/O stations.

### Method
GET

### Endpoint
/v1/ioStations
```

--------------------------------

### Get All Roles

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a list of all available roles. Ensure cookies.txt is present.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/authentication/roles
```

--------------------------------

### Get All Tasks

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a list of all tasks. Ensure cookies.txt is available for authentication.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/tasks
```

--------------------------------

### Get All Syslog Servers

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a list of all configured syslog servers.

```APIDOC
## GET /v1/notification/syslog/servers

### Description
Retrieves a list of all configured syslog servers.

### Method
GET

### Endpoint
/v1/notification/syslog/servers

### Request Example
```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/notification/syslog/servers
```

### Response
#### Success Response (200)
[Details about the success response structure would go here if provided in the source]
```

--------------------------------

### Update library installation information

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Updates the physical installation details and contact information for the library.

```APIDOC
## PATCH /v1/library

### Description
Updates the physical installation details and contact information for the library.

### Method
PATCH

### Endpoint
/v1/library

### Parameters
#### Request Body
- **location** (string) - Optional - A description of the installation location.
- **address** (string) - Optional - The street address of the installation.
- **city** (string) - Optional - The city of the installation.
- **state** (string) - Optional - The state or province of the installation.
- **country** (string) - Optional - The country of the installation.
- **contact** (string) - Optional - The name of the library administrator.
- **telephone** (string) - Optional - The phone number of the library administrator.
- **secondaryTelephone** (string) - Optional - A backup phone number for the library administrator.
```

--------------------------------

### Get All Tasks

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a list of all tasks.

```APIDOC
## GET /v1/tasks

### Description
Retrieves a list of all tasks.

### Method
GET

### Endpoint
/v1/tasks

### Request Example
```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/tasks
```

### Response
#### Success Response (200)
[Details about the success response structure would go here if provided in the source]
```

--------------------------------

### Get All I/O Stations

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a list of all I/O stations configured in the system.

```curl
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/ioStations
```

--------------------------------

### Get All Roles

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a list of all available roles.

```APIDOC
## GET /v1/authentication/roles

### Description
Retrieves a list of all available roles.

### Method
GET

### Endpoint
/v1/authentication/roles

### Request Example
```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/authentication/roles
```

### Response
#### Success Response (200)
[Details about the success response structure would go here if provided in the source]
```

--------------------------------

### Get Syslog Servers

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves the list of configured syslog servers. Ensure cookies.txt is available.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/notification/syslog/servers
```

--------------------------------

### Get User Accounts

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a list of all user accounts configured on the tape library. Requires authentication.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/authentication/userAccounts
```

--------------------------------

### GET Work Items

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieve a list of all work items. Requires authentication via cookies.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/workItems
```

--------------------------------

### Get Session Policy

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves the session policy configuration for the tape library. Requires authentication.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/authentication/sessionPolicy
```

--------------------------------

### Get Specific Logical Library

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves details for a specific logical library by its name. Replace `<name>` with the actual library name.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/logicalLibraries/BackupLib
```

--------------------------------

### Get All Data Cartridges

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a list of all data cartridges available in the system.

```APIDOC
## GET /v1/dataCartridges

### Description
Retrieves a list of all data cartridges.

### Method
GET

### Endpoint
/v1/dataCartridges

### Response
#### Success Response (200)
- **cartridges** (array) - A list of data cartridge objects.
```

--------------------------------

### Get Specific Role by Name

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves details for a specific role using its name. Replace `<name>` with the role name.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/authentication/roles/Administrator
```

--------------------------------

### Create Volser Ranges for Logical Library

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Creates new Volser ranges within a logical library. Specify the start and end VOLSERs and whether to apply immediately.

```bash
curl -k -b cookies.txt -H "Content-Type: application/json" -X POST https://192.0.2.0/web/api/v1/logicalLibraries/LogLib_1/volserRanges -d "{\"start\": \"AAA000\", \"end\": \"BBB000\", \"applyNow\": \"yes\"}"
```

--------------------------------

### Get All Diagnostic Cartridges

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a list of all diagnostic cartridges available in the system.

```APIDOC
## GET /v1/diagnosticCartridges

### Description
Retrieves a list of all diagnostic cartridges.

### Method
GET

### Endpoint
/v1/diagnosticCartridges

### Response
#### Success Response (200)
- **cartridges** (array) - A list of diagnostic cartridge objects.
```

--------------------------------

### Get Active Sessions

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a list of active sessions on the tape library. Requires authentication.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/authentication/sessions
```

--------------------------------

### Get specific I/O station by location

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves details for a specific I/O station identified by its location.

```APIDOC
## GET /v1/iostations/`<location>`

### Description
Retrieves details for a specific I/O station.

### Method
GET

### Endpoint
/v1/iostations/`<location>`

### Parameters
#### Path Parameters
- **location** (string) - Required - The unique identifier for the I/O station.
```

--------------------------------

### Get Cleaning Cartridges List

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a list of all cleaning cartridges available in the tape library. Requires authentication.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/cleaningCartridges
```

--------------------------------

### Get Specific Power Supply

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves details for a specific power supply by its location identifier.

```curl
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/powerSupplies/powerSupply_F1PSa
```

--------------------------------

### Get Specific I/O Station

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves details for a specific I/O station by its location identifier.

```curl
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/iostations/ioStation_C3
```

--------------------------------

### Get Drive by Serial Number

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves information for a specific drive using its serial number. Requires authentication.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/drives/607BBFFFF8
```

--------------------------------

### Assign Drives to Logical Library

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Assigns drives to a logical library using their location or serial number. The example shows assigning a single drive.

```bash
curl -k -b cookies.txt -H "Content-Type: application/json" -X POST https://192.0.2.0/web/api/v1/logicalLibraries/LogLib_3/assignDrives -d "{\"drives\": \"drive_F1C2R4\"}"
```

--------------------------------

### Get Syslog Server by IP Address

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a specific syslog server configuration by its IP address.

```APIDOC
## GET /v1/notification/syslog/servers/`<ipAddress>`

### Description
Retrieves a specific syslog server configuration by its IP address.

### Method
GET

### Endpoint
/v1/notification/syslog/servers/`<ipAddress>`

### Parameters
#### Path Parameters
- **ipAddress** (string) - Required - The IP address of the syslog server.

### Request Example
```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/notification/syslog/servers/192.0.2.11
```

### Response
#### Success Response (200)
[Details about the success response structure would go here if provided in the source]
```

--------------------------------

### Get Frame by Location

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves information for a specific frame using its location identifier. Requires authentication.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/frames/frame_F1
```

--------------------------------

### Create User Account

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Creates a new user account on the tape library with specified details including role, email, and password expiration. Requires authentication.

```bash
curl -k -b cookies.txt -H "Content-Type: application/json" -X POST https://192.0.2.0/web/api/v1/authentication/userAccounts -d "{\"name\":\"<name>\", \"role\":\"Administrator\", \"email\":\"username@example.com\", \"password\":\"mypassword\", \"expirePassword\": \"no\"}"
```

--------------------------------

### Get Accessors List (TS4500 Only)

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a list of all accessors available in the TS4500 tape library. Requires authentication.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/accessors
```

--------------------------------

### Get Event Fix Procedure

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves the recommended fix procedure for a specific event ID. Requires authentication.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/events/1038/fixProcedure
```

--------------------------------

### Get specific power supply by location

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves details for a specific power supply identified by its location.

```APIDOC
## GET /v1/powerSupplies/`<location>`

### Description
Retrieves details for a specific power supply.

### Method
GET

### Endpoint
/v1/powerSupplies/`<location>`

### Parameters
#### Path Parameters
- **location** (string) - Required - The unique identifier for the power supply.
```

--------------------------------

### Get Password Policy

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves the current password policy settings for the tape library. Requires authentication.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/authentication/passwordPolicy
```

--------------------------------

### Create New Logical Library

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Creates a new logical library with a specified name, drives, and media type. Ensure all parameters are correctly formatted.

```bash
curl -k -b cookies.txt -H "Content-Type: application/json" -X POST https://192.0.2.0/web/api/v1/logicalLibraries -d "{\"name\": \"Library_A\", \"drives\": [{\"drive_F1C2R4\", \"1013000276\"], \"mediaType\": \"LTO\"}"
```

--------------------------------

### Get Drive by Location

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves information for a specific drive using its location identifier. Requires authentication.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/drives/drive_F1C3R2
```

--------------------------------

### Get Event by ID

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves details for a specific event using its unique ID. Requires authentication.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/events/876
```

--------------------------------

### Create Inventory Task (All Tiers)

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Creates a task to inventory all tape tiers. The location can be 'library' or a specific frame.

```bash
curl -k -b cookies.txt -H "Content-Type: application/json" -X POST https://192.0.2.0/web/api/v1/tasks -d "{\"type\":\"inventoryAllTiers\", \"location\":\"library\"}"
```

--------------------------------

### List All Logical Libraries

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a list of all configured logical libraries. Ensure you have valid cookies for authentication.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/logicalLibraries
```

--------------------------------

### Get Data Cartridge Lifetime Metrics

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieve lifetime performance metrics for all data cartridges. This command provides aggregated data.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/dataCartridges/lifetimeMetrics
```

--------------------------------

### Get Specific User Account

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves details for a specific user account, identified by its name. Requires authentication.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/authenticatiion/userAccounts/myusername
```

--------------------------------

### Get Library Reports

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves reports specific to the library. Time filtering can be applied using 'after' and 'before' parameters.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/reports/library
```

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/reports/library%3Fafter=2024-06-12T10:00:00%26before=2024-06-12T12:00:00:00
```

--------------------------------

### Create Inventory Task (Tier 0/1)

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Creates a task to inventory Tier 0 and Tier 1 tapes. The location can be 'library' or a specific frame.

```bash
curl -k -b cookies.txt -H "Content-Type: application/json" -X POST https://192.0.2.0/web/api/v1/tasks -d "{\"type\":\"inventoryTier0and1\", \"location\":\"library\"}"
```

--------------------------------

### Get Role by Name

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a specific role by its name.

```APIDOC
## GET /v1/authentication/roles/`<name>`

### Description
Retrieves a specific role by its name.

### Method
GET

### Endpoint
/v1/authentication/roles/`<name>`

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the role to retrieve.

### Request Example
```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/authentication/roles/Administrator
```

### Response
#### Success Response (200)
[Details about the success response structure would go here if provided in the source]
```

--------------------------------

### Get Drive Reports

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves reports related to drives. Time filtering is available using 'after' and 'before' parameters.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/reports/drives
```

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/reports/drives%3Fafter=2024-06-12T10:00:00%26before=2024-06-12T12:00:00:00
```

--------------------------------

### Get Task by ID

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a specific task by its ID.

```APIDOC
## GET /v1/tasks/`<ID>`

### Description
Retrieves a specific task by its ID.

### Method
GET

### Endpoint
/v1/tasks/`<ID>`

### Parameters
#### Path Parameters
- **ID** (string) - Required - The ID of the task to retrieve.

### Request Example
```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/tasks/82
```

### Response
#### Success Response (200)
[Details about the success response structure would go here if provided in the source]
```

--------------------------------

### Create Inventory Task (All Tiers)

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Initiates an inventory task for all storage tiers.

```APIDOC
## POST /v1/tasks

### Description
Initiates an inventory task for all storage tiers.

### Method
POST

### Endpoint
/v1/tasks

### Request Body
- **type** (string) - Required - Must be "inventoryAllTiers".
- **location** (string) - Required - Can be "library" or "frame_F`<f>`".

### Request Example
```bash
curl -k -b cookies.txt -H "Content-Type: application/json" -X POST https://192.0.2.0/web/api/v1/tasks -d "{\"type\": \"inventoryAllTiers\", \"location\": \"library\"}"
```

### Response
#### Success Response (200)
[Details about the success response structure would go here if provided in the source]
```

--------------------------------

### Get Syslog Server by IP Address

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves details for a specific syslog server using its IP address. Replace `<ipAddress>` with the server's IP.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/notification/syslog/servers/192.0.2.11
```

--------------------------------

### Create Inventory Task (Tier 0 and 1)

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Initiates an inventory task for Tier 0 and Tier 1 storage.

```APIDOC
## POST /v1/tasks

### Description
Initiates an inventory task for Tier 0 and Tier 1 storage.

### Method
POST

### Endpoint
/v1/tasks

### Request Body
- **type** (string) - Required - Must be "inventoryTier0and1".
- **location** (string) - Required - Can be "library" or "frame_F`<f>`".

### Request Example
```bash
curl -k -b cookies.txt -H "Content-Type: application/json" -X POST https://192.0.2.0/web/api/v1/tasks -d "{\"type\": \"inventoryTier0and1\", \"location\": \"library\"}"
```

### Response
#### Success Response (200)
[Details about the success response structure would go here if provided in the source]
```

--------------------------------

### List All Drives

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a list of all available drives. Requires authentication.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/drives
```

--------------------------------

### Get Fibre Channel Port by Location

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves information for a specific Fibre Channel port using its location identifier. Requires authentication.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/fcports/fcPort_F1C1R4P0
```

--------------------------------

### Create User Account

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Creates a new user account with specified details.

```APIDOC
## POST /v1/authentication/userAccounts

### Description
Creates a new user account on the system.

### Method
POST

### Endpoint
/web/api/v1/authentication/userAccounts

### Parameters
#### Request Body
- **name** (string) - Required - The name for the new user account.
- **role** (string) - Required - The role assigned to the user (e.g., "Administrator").
- **email** (string) - Required - The email address for the user.
- **password** (string) - Required - The initial password for the user.
- **expirePassword** (string) - Optional - Specifies if the password should expire. Accepted values: "yes", "no".

### Request Example
```json
{
  "name": "<name>",
  "role": "Administrator",
  "email": "username@example.com",
  "password": "mypassword",
  "expirePassword": "no"
}
```

### Response
#### Success Response (200)
(Response body schema not provided in source)

#### Response Example
(No example provided in source)
```

--------------------------------

### Get library information

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves general information about the tape library.

```APIDOC
## GET /v1/library

### Description
Retrieves general information about the tape library.

### Method
GET

### Endpoint
/v1/library
```

--------------------------------

### Get Data Cartridge by Internal Address

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieve details for a specific data cartridge using its internal address. Replace 'FF0412' with the actual internal address.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/dataCartridges/FF0412
```

--------------------------------

### Get All Node Cards

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a list of all node cards in the system.

```curl
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/nodeCards
```

--------------------------------

### Login to Tape Library API

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Use this command to log in to the tape library API. It requires a username and password and saves session cookies for subsequent requests.

```bash
curl -k -c cookies.txt -H "Content-Type: application/json" -X POST https://192.0.2.0/web/api/v1/login -d "{\"user\":\"myusername\",\"password\":\"mypassword\"}"
```

--------------------------------

### Get Library Information

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves general information about the tape library.

```curl
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/library
```

--------------------------------

### Get specific log file

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a specific log file by its filename.

```APIDOC
## GET /v1/logs/`<filename>`

### Description
Retrieves a specific log file by its filename.

### Method
GET

### Endpoint
/v1/logs/`<filename>`

### Parameters
#### Path Parameters
- **filename** (string) - Required - The name of the log file to retrieve.
```

--------------------------------

### List All Events

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a list of all system events. Requires authentication.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/events
```

--------------------------------

### Get Specific Log File

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a specific log file by its filename.

```curl
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/logs/TS4500_LOG_FA004_20240507102856.zip
```

--------------------------------

### Configure Encryption for Logical Library

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Configures the encryption method for a logical library. Specify the desired encryption method, such as 'applicationManaged'.

```bash
curl -k -b cookies.txt -H "Content-Type: application/json" -X POST https://192.0.2.0/web/api/v1/logicalLibraries/{name}/configureEncryption -d "{\"method\": \"applicationManaged\"}"
```

--------------------------------

### Calibrate Library Task

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Creates a task to calibrate the library. Requires an accessor ID.

```bash
curl -k -b cookies.txt -H "Content-Type: application/json" -X POST https://192.0.2.0/web/api/v1/tasks -d "{\"type\":\"calibrateLibrary\", \"accessor\":\"accessor_Aa\"}"
```

--------------------------------

### List All Frames

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a list of all available frames. Requires authentication.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/frames
```

--------------------------------

### Get Diagnostic Cartridge Lifetime Metrics

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves the lifetime metrics for all diagnostic cartridges.

```APIDOC
## GET /v1/diagnosticCartridges/lifetimeMetrics

### Description
Retrieves the lifetime metrics for all diagnostic cartridges.

### Method
GET

### Endpoint
/v1/diagnosticCartridges/lifetimeMetrics

### Response
#### Success Response (200)
- **metrics** (object) - An object containing lifetime metrics for diagnostic cartridges.
```

--------------------------------

### Get Data Cartridge Lifetime Metrics

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves the lifetime metrics for all data cartridges.

```APIDOC
## GET /v1/dataCartridges/lifetimeMetrics

### Description
Retrieves the lifetime metrics for all data cartridges.

### Method
GET

### Endpoint
/v1/dataCartridges/lifetimeMetrics

### Response
#### Success Response (200)
- **metrics** (object) - An object containing lifetime metrics for data cartridges.
```

--------------------------------

### GUI Settings API

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Endpoint for retrieving GUI settings.

```APIDOC
## GET /v1/guiSettings

### Description
Retrieves the current GUI settings.

### Method
GET

### Endpoint
/v1/guiSettings

### Request Example
```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/guiSettings
```

### Response
#### Success Response (200)
- **guiSettings** (object) - An object containing the current GUI settings.
```

--------------------------------

### Add Syslog Server

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Adds a new syslog server configuration.

```APIDOC
## POST /v1/notification/syslog/servers

### Description
Adds a new syslog server configuration.

### Method
POST

### Endpoint
/v1/notification/syslog/servers

### Request Body
- **address** (string) - Required - The IP address of the syslog server.
- **port** (integer) - Required - The port number for the syslog server.
- **subscribed** (array of strings) - Optional - A list of notification types to subscribe to (e.g., "error", "warning", "information").

### Request Example
```bash
curl -k -b cookies.txt -H "Content-Type: application/json" -X POST https://192.0.2.0/web/api/v1/notification/syslog/servers -d "{\"address\": \"192.0.2.11\", \"port\": \"514\", \"subscribed\": \"error\"}"
```

### Response
#### Success Response (200)
[Details about the success response structure would go here if provided in the source]
```

--------------------------------

### Get Specific Node Card

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves details for a specific node card using its ID.

```curl
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/nodeCards/65
```

--------------------------------

### List All Ethernet Ports

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a list of all available Ethernet ports. Requires authentication.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/ethernetPorts
```

--------------------------------

### Test Drive Task

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Creates a task to test a specific drive. The location format is drive_F<f>C<c>R<r>.

```bash
curl -k -b cookies.txt -H "Content-Type: application/json" -X POST https://192.0.2.0/web/api/v1/tasks -d "{\"type\":\"testDrive\", \"location\": \"drive_F1C5R3\"}"
```

--------------------------------

### Get Specific Accessor

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves details for a specific accessor, identified by its location. Requires authentication.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/accessors/accessor_Aa
```

--------------------------------

### Complete Drive Service Task

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Initiates a drive service completion task.

```APIDOC
## POST /v1/tasks

### Description
Initiates a drive service completion task.

### Method
POST

### Endpoint
/v1/tasks

### Request Body
- **type** (string) - Required - Must be "completeDriveService".
- **location** (string) - Required - The location of the drive in the format "drive_F`<f>`C`<c>`R`<r>`".

### Request Example
```bash
curl -k -b cookies.txt -H "Content-Type: application/json" -X POST https://192.0.2.0/web/api/v1/tasks -d "{\"type\": \"completeDriveService\", \"location\": \"drive_F1C3R5\"}"
```

### Response
#### Success Response (200)
[Details about the success response structure would go here if provided in the source]
```

--------------------------------

### Save Library Configuration

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Saves the current library configuration to a file. The output is directed to `dbfile.dbz`.

```curl
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/library/saveConfig --output dbfile.dbz
```

--------------------------------

### Get Specific Session

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves information about a specific session, identified by its name. Requires authentication.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/authentication/sessions/admin
```

--------------------------------

### List Work Items

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a list of all current work items. This is a GET request to the /web/api/v1/workItems endpoint.

```APIDOC
## GET /web/api/v1/workItems

### Description
Retrieves a list of all current work items.

### Method
GET

### Endpoint
/web/api/v1/workItems

### Response
#### Success Response (200)
[Details about the response structure would go here if provided in the source]
```

--------------------------------

### Add Syslog Server

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Adds a new syslog server configuration. Specify address, port, and subscribed event types.

```bash
curl -k -b cookies.txt -H "Content-Type: application/json" -X POST https://192.0.2.0/web/api/v1/notification/syslog/servers -d "{\"address\": \"192.0.2.11\", \"port\": \"514\", \"subscribed\": \"error\"}"
```

--------------------------------

### List All Slots

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a list of all available slots in the tape library.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/slots
```

--------------------------------

### Enable Drive Beacon

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Enables the beacon for a drive. Requires authentication and JSON content type. Note: This uses POST, not PUT as implied by the endpoint description. Can be used with location or serial number.

```bash
curl -k -b cookies.txt -H "Content-Type: application/json" -X POST https://192.0.2.0/web/api/v1/drives/drive_F1C2R2 -d "{\"beacon\":\"enabled\"}"
```

```bash
curl -k -b cookies.txt -H "Content-Type: application/json" -X POST https://192.0.2.0/web/api/v1/drives/607BBFFFF8 -d "{\"beacon\":\"enabled\"}"
```

--------------------------------

### Get specific node card by ID

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves details for a specific node card identified by its ID.

```APIDOC
## GET /v1/nodeCards/`<ID>`

### Description
Retrieves details for a specific node card.

### Method
GET

### Endpoint
/v1/nodeCards/`<ID>`

### Parameters
#### Path Parameters
- **ID** (string) - Required - The unique identifier for the node card.
```

--------------------------------

### Calibrate Library Task

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Initiates a library calibration task.

```APIDOC
## POST /v1/tasks

### Description
Initiates a library calibration task.

### Method
POST

### Endpoint
/v1/tasks

### Request Body
- **type** (string) - Required - Must be "calibrateLibrary".
- **accessor** (string) - Required - The accessor identifier, e.g., "accessor_A`<a|b>`".

### Request Example
```bash
curl -k -b cookies.txt -H "Content-Type: application/json" -X POST https://192.0.2.0/web/api/v1/tasks -d "{\"type\": \"calibrateLibrary\", \"accessor\": \"accessor_Aa\"}"
```

### Response
#### Success Response (200)
[Details about the success response structure would go here if provided in the source]
```

--------------------------------

### Update Library Firmware Task

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Initiates a library firmware update. Requires a firmware file and type information.

```bash
curl -k -b cookies.txt -H "Content-Type: application/multipart/form-data" POST https://192.0.2.0/web/api/v1/tasks -F "filename=@TS4500_11100-05G.afwz; type=application/octet-stream" -F "{\"type\": \"updateLibraryFirmware\"}; type= application/json"
```

--------------------------------

### Test Drive Task

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Initiates a drive test task.

```APIDOC
## POST /v1/tasks

### Description
Initiates a drive test task.

### Method
POST

### Endpoint
/v1/tasks

### Request Body
- **type** (string) - Required - Must be "testDrive".
- **location** (string) - Required - The location of the drive in the format "drive_F`<f>`C`<c>`R`<r>`".

### Request Example
```bash
curl -k -b cookies.txt -H "Content-Type: application/json" -X POST https://192.0.2.0/web/api/v1/tasks -d "{\"type\": \"testDrive\", \"location\": \"drive_F1C5R3\"}"
```

### Response
#### Success Response (200)
[Details about the success response structure would go here if provided in the source]
```

--------------------------------

### List All Fibre Channel Ports

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a list of all available Fibre Channel ports. Requires authentication.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/fcPorts
```

--------------------------------

### Get Accessor Reports

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves reports related to accessors. This can be filtered by time using 'after' and 'before' parameters.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/reports/accessors
```

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/reports/accessors%3Fafter=2024-06-12T10:00:00%26before=2024-06-12T12:00:00:00
```

--------------------------------

### List All Data Cartridges

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Use this command to retrieve a list of all data cartridges managed by the system. Ensure you have the necessary authentication cookies.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/dataCartridges
```

--------------------------------

### Restore Library Configuration

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Restores the library configuration from a specified file (`dbfile.dbz`). This is a multipart form data upload.

```curl
curl -k -v -b cookies.txt -H "Content-Type: application/x-www-form-urlencoded" POST https://192.0.2.0/web/api/v1/library/restoreConfig -F 'filename=@dbfile.dbz; type=application/octet-stream'
```

--------------------------------

### Get Diagnostic Cartridge by Internal Address

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves details for a specific diagnostic cartridge using its internal address.

```APIDOC
## GET /v1/diagnosticCartridges/`<internalAddress>`

### Description
Retrieves details for a specific diagnostic cartridge using its internal address.

### Method
GET

### Endpoint
/v1/diagnosticCartridges/{internalAddress}

### Parameters
#### Path Parameters
- **internalAddress** (string) - Required - The internal address of the diagnostic cartridge.
```

--------------------------------

### Get Data Cartridge by Internal Address

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves details for a specific data cartridge using its internal address.

```APIDOC
## GET /v1/dataCartridges/`<internalAddress>`

### Description
Retrieves details for a specific data cartridge using its internal address.

### Method
GET

### Endpoint
/v1/dataCartridges/{internalAddress}

### Parameters
#### Path Parameters
- **internalAddress** (string) - Required - The internal address of the data cartridge.
```

--------------------------------

### Login

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Logs into the REST over Ethernet API. Requires username and password.

```APIDOC
## Login

### Description
Logs into the REST over Ethernet API using provided credentials.

### Method
POST

### Endpoint
/web/api/v1/login

### Parameters
#### Request Body
- **user** (string) - Required - The username for authentication.
- **password** (string) - Required - The password for authentication.

### Request Example
```json
{
  "user": "myusername",
  "password": "mypassword"
}
```

### Response
#### Success Response (200)
Cookies are set for subsequent requests.

#### Response Example
(No specific response body shown, relies on cookie setting)
```

--------------------------------

### Update Drive Use Mode (Verification)

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Sets the use mode for a drive to 'verification'. Requires authentication and JSON content type. Can be used with location or serial number.

```bash
curl -k -b cookies.txt -H "Content-Type: application/json" -X PUT https://192.0.2.0/web/api/v1/drives/drive_F1C2R4 -d "{\"use\":\"verification\"}"
```

```bash
curl -k -b cookies.txt -H "Content-Type: application/json" -X PUT  https://192.0.2.0/web/api/v1/drives/607BBFFFF8 -d "{\"use\":\"verification\"}"
```

--------------------------------

### Configure NTP Settings for Library

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Configures Network Time Protocol (NTP) settings for the library, including enabling/disabling and specifying primary/secondary addresses. Requires a JSON payload.

```curl
curl -k -b cookies.txt -H "Content-Type: application/json" -X POST https://192.0.2.0/web/api/v1/library -d "{\"ntpMode\": \"enabled\", \"primaryNtpAddress\": \"192.0.2.1\", \"secondaryNtpAddress\": \"192.0.2.1\"}"
```

--------------------------------

### Update Drive Firmware Task

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Initiates a drive firmware update. Requires a firmware file and drive location.

```bash
curl -k -b cookies.txt -H "Content-Type: application/multipart/form-data" POST https://192.0.2.0/web/api/v1/tasks -F "filename=@D3I4_A0B.fcp_fj_D.fmrz; type=application/octet-stream" -F "{\"type\": \"updateDriveFirmware\", \"location\":\"drive_F1C4R4\"}; type= application/json"
```

--------------------------------

### Initiate Drive Cleaning by Serial Number

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Initiates the cleaning process for a specific drive identified by its serial number. Requires authentication and JSON content type.

```bash
curl -k -b cookies.txt -H "Content-Type: application/json" -X POST https://192.0.2.0/web/api/v1/drives/607BBFFFF8/clean
```

--------------------------------

### Get Ethernet Port by Location

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves information for a specific Ethernet port using its location identifier. Requires authentication.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/ethernetPorts/ethernetPort_F1Pa
```

--------------------------------

### Get Diagnostic Cartridge by Volser

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves details for a specific diagnostic cartridge using its Volume Serial Number (Volser).

```APIDOC
## GET /v1/diagnosticCartridges/`<volser>`

### Description
Retrieves details for a specific diagnostic cartridge using its Volume Serial Number (Volser).

### Method
GET

### Endpoint
/v1/diagnosticCartridges/{volser}

### Parameters
#### Path Parameters
- **volser** (string) - Required - The Volume Serial Number (Volser) of the diagnostic cartridge.
```

--------------------------------

### Get Data Cartridge by Volser

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves details for a specific data cartridge using its Volume Serial Number (Volser).

```APIDOC
## GET /v1/dataCartridges/`<volser>`

### Description
Retrieves details for a specific data cartridge using its Volume Serial Number (Volser).

### Method
GET

### Endpoint
/v1/dataCartridges/{volser}

### Parameters
#### Path Parameters
- **volser** (string) - Required - The Volume Serial Number (Volser) of the data cartridge.
```

--------------------------------

### Restore library configuration

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Restores the tape library configuration from a specified backup file.

```APIDOC
## POST /v1/library/restoreConfig

### Description
Restores the tape library configuration from a specified backup file.

### Method
POST

### Endpoint
/v1/library/restoreConfig

### Parameters
#### Request Body
- **filename** (file) - Required - The configuration backup file (e.g., dbfile.dbz) to restore from. Content type should be multipart/form-data.
```

--------------------------------

### Get Specific Task by ID

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves details for a specific task using its ID. Replace `<ID>` with the actual task ID.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/tasks/82
```

--------------------------------

### User Accounts

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieves a list of all user accounts configured on the system.

```APIDOC
## GET /v1/authentication/userAccounts

### Description
Retrieves a list of all user accounts.

### Method
GET

### Endpoint
/web/api/v1/authentication/userAccounts

### Parameters
(No parameters)

### Response
#### Success Response (200)
(Response body schema not provided in source)

#### Response Example
(No example provided in source)
```

--------------------------------

### Calibrate Frame Task (TS4500)

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Creates a task to calibrate a specific frame within the library (TS4500 only). Requires location and accessor.

```bash
curl -k -b cookies.txt -H "Content-Type: application/json" -X POST https://192.0.2.0/web/api/v1/tasks -d "{\"type\":\"calibrateFrame\", \"location\":\"frame_F1\", \"accessor\": \"accessor_Aa\"}"
```

--------------------------------

### Get Diagnostic Cartridge Lifetime Metrics

Source: https://github.com/ibm/tape-automation/blob/master/rest-over-ethernet/roecurl.md

Retrieve lifetime performance metrics for all diagnostic cartridges. This command provides aggregated data.

```bash
curl -k -b cookies.txt -X GET https://192.0.2.0/web/api/v1/diagnosticCartridges/lifetimeMetrics
```