TapeArchiveAPI.md

TapeArchiveAPI

All URIs are relative to https://elements.local

Method	HTTP request	Description
archiveToTape	POST /api/2/archive/tape/archive
cancelAllTapeArchiveJobs	POST /api/2/archive/tape/jobs/cancel-all
checkTape	POST /api/2/archive/tape/library/check
createTape	POST /api/2/archive/tape/tapes
createTapeGroup	POST /api/2/archive/tape/groups
deleteTape	DELETE /api/2/archive/tape/tapes/{id}
deleteTapeArchiveJob	DELETE /api/2/archive/tape/jobs/{id}
deleteTapeGroup	DELETE /api/2/archive/tape/groups/{id}
formatTape	POST /api/2/archive/tape/library/format
getAllArchivedFileEntries	GET /api/2/archive/tape/files
getAllTapeArchiveJobs	GET /api/2/archive/tape/jobs
getAllTapeGroups	GET /api/2/archive/tape/groups
getAllTapes	GET /api/2/archive/tape/tapes
getArchivedFileEntry	GET /api/2/archive/tape/files/{id}
getTape	GET /api/2/archive/tape/tapes/{id}
getTapeArchiveJob	GET /api/2/archive/tape/jobs/{id}
getTapeArchiveJobSources	GET /api/2/archive/tape/jobs/{id}/sources
getTapeGroup	GET /api/2/archive/tape/groups/{id}
getTapeLibraryState	GET /api/2/archive/tape/library
loadTape	POST /api/2/archive/tape/library/load
moveTape	POST /api/2/archive/tape/library/move
patchTape	PATCH /api/2/archive/tape/tapes/{id}
patchTapeGroup	PATCH /api/2/archive/tape/groups/{id}
pauseTapeArchiveJob	POST /api/2/archive/tape/jobs/{id}/pause
refreshTapeLibraryState	POST /api/2/archive/tape/library/refresh
reindexTape	POST /api/2/archive/tape/library/reindex
removeFinishedTapeArchiveJobs	POST /api/2/archive/tape/jobs/remove-finished
restartTapeArchiveJob	POST /api/2/archive/tape/jobs/{id}/restart
restoreFromTape	POST /api/2/archive/tape/restore
resumeTapeArchiveJob	POST /api/2/archive/tape/jobs/{id}/resume
searchTapeArchive	POST /api/2/archive/tape/search
unloadTape	POST /api/2/archive/tape/library/unload
updateTape	PUT /api/2/archive/tape/tapes/{id}
updateTapeGroup	PUT /api/2/archive/tape/groups/{id}

archiveToTape

    open class func archiveToTape( archiveEndpointRequest: ArchiveEndpointRequest) -> Promise<[TapeJob]>

Required permissions * User account permission: ltfs:backup * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let archiveEndpointRequest = ArchiveEndpointRequest(source: [TapeJobSource(path: "path_example", options: "TODO", include: "include_example")], startDate: Date(), name: "name_example", group: 123, group2: 123, export: false, export2: false) // ArchiveEndpointRequest | 

TapeArchiveAPI.archiveToTape(archiveEndpointRequest: archiveEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
archiveEndpointRequest	ArchiveEndpointRequest

Return type

[TapeJob]

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

cancelAllTapeArchiveJobs

    open class func cancelAllTapeArchiveJobs() -> Promise<Void>

Required permissions * User account permission: None (read) / ltfs:manage (write) * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK


TapeArchiveAPI.cancelAllTapeArchiveJobs().then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

This endpoint does not need any parameter.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

checkTape

    open class func checkTape( tapeLibraryFsckEndpointRequest: TapeLibraryFsckEndpointRequest) -> Promise<Void>

Required permissions * User account permission: ltfs:manage * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let tapeLibraryFsckEndpointRequest = TapeLibraryFsckEndpointRequest(barcode: "barcode_example") // TapeLibraryFsckEndpointRequest | 

TapeArchiveAPI.checkTape(tapeLibraryFsckEndpointRequest: tapeLibraryFsckEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
tapeLibraryFsckEndpointRequest	TapeLibraryFsckEndpointRequest

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createTape

    open class func createTape( tapeUpdate: TapeUpdate) -> Promise<Tape>

Required permissions * User account permission: None (read) / ltfs:tapegroups:manage (write) * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let tapeUpdate = TapeUpdate(name: "name_example", uuid: "uuid_example", generation: 123, customA: "customA_example", customB: "customB_example", customC: "customC_example", customD: "customD_example", freeSpace: 123, loadCounter: 123, errorCounter: 123, errorReason: "errorReason_example", active: false, lto: "lto_example", group: 123) // TapeUpdate | 

TapeArchiveAPI.createTape(tapeUpdate: tapeUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
tapeUpdate	TapeUpdate

Return type

Tape

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createTapeGroup

    open class func createTapeGroup( tapeGroupUpdate: TapeGroupUpdate) -> Promise<TapeGroup>

Required permissions * User account permission: None (read) / ltfs:tapegroups:manage (write) * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let tapeGroupUpdate = TapeGroupUpdate(tapes: [TapeReference(id: 123, rootEntry: 123, name: "name_example", uuid: "uuid_example", generation: 123, customA: "customA_example", customB: "customB_example", customC: "customC_example", customD: "customD_example", freeSpace: 123, loadCounter: 123, errorCounter: 123, errorReason: "errorReason_example", active: false, lto: "lto_example", group: 123)], name: "name_example") // TapeGroupUpdate | 

TapeArchiveAPI.createTapeGroup(tapeGroupUpdate: tapeGroupUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
tapeGroupUpdate	TapeGroupUpdate

Return type

TapeGroup

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteTape

    open class func deleteTape( id: Int) -> Promise<Void>

Required permissions * User account permission: None (read) / ltfs:tapegroups:manage (write) * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this tape.

TapeArchiveAPI.deleteTape(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this tape.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteTapeArchiveJob

    open class func deleteTapeArchiveJob( id: String) -> Promise<Void>

Required permissions * User account permission: None (read) / ltfs:manage (write) * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = "id_example" // String | 

TapeArchiveAPI.deleteTapeArchiveJob(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	String

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteTapeGroup

    open class func deleteTapeGroup( id: Int) -> Promise<Void>

Required permissions * User account permission: None (read) / ltfs:tapegroups:manage (write) * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this tape group.

TapeArchiveAPI.deleteTapeGroup(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this tape group.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

formatTape

    open class func formatTape( tapeLibraryFormatEndpointRequest: TapeLibraryFormatEndpointRequest) -> Promise<Void>

Required permissions * User account permission: ltfs:manage * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let tapeLibraryFormatEndpointRequest = TapeLibraryFormatEndpointRequest(barcode: "barcode_example") // TapeLibraryFormatEndpointRequest | 

TapeArchiveAPI.formatTape(tapeLibraryFormatEndpointRequest: tapeLibraryFormatEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
tapeLibraryFormatEndpointRequest	TapeLibraryFormatEndpointRequest

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllArchivedFileEntries

    open class func getAllArchivedFileEntries( id: Double? = nil,  isDir: String? = nil,  name: String? = nil,  fullpath: String? = nil,  parent: Double? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[TapeFile]>

Required permissions * User account permission: ltfs:search (read) / ltfs:manage (write) * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Double | Filter the returned list by `id`. (optional)
let isDir = "isDir_example" // String | Filter the returned list by `is_dir`. (optional)
let name = "name_example" // String | Filter the returned list by `name`. (optional)
let fullpath = "fullpath_example" // String | Filter the returned list by `fullpath`. (optional)
let parent = 987 // Double | Filter the returned list by `parent`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

TapeArchiveAPI.getAllArchivedFileEntries(id: id, isDir: isDir, name: name, fullpath: fullpath, parent: parent, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	Double	Filter the returned list by `id`.	[optional]
isDir	String	Filter the returned list by `is_dir`.	[optional]
name	String	Filter the returned list by `name`.	[optional]
fullpath	String	Filter the returned list by `fullpath`.	[optional]
parent	Double	Filter the returned list by `parent`.	[optional]
ordering	String	Which field to use when ordering the results.	[optional]
limit	Int	Number of results to return per page.	[optional]
offset	Int	The initial index from which to return the results.	[optional]

Return type

[TapeFile]

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllTapeArchiveJobs

    open class func getAllTapeArchiveJobs( ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[TapeJob]>

Required permissions * User account permission: None (read) / ltfs:manage (write) * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

TapeArchiveAPI.getAllTapeArchiveJobs(ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
ordering	String	Which field to use when ordering the results.	[optional]
limit	Int	Number of results to return per page.	[optional]
offset	Int	The initial index from which to return the results.	[optional]

Return type

[TapeJob]

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllTapeGroups

    open class func getAllTapeGroups( id: Double? = nil,  name: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[TapeGroup]>

Required permissions * User account permission: None (read) / ltfs:tapegroups:manage (write) * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Double | Filter the returned list by `id`. (optional)
let name = "name_example" // String | Filter the returned list by `name`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

TapeArchiveAPI.getAllTapeGroups(id: id, name: name, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	Double	Filter the returned list by `id`.	[optional]
name	String	Filter the returned list by `name`.	[optional]
ordering	String	Which field to use when ordering the results.	[optional]
limit	Int	Number of results to return per page.	[optional]
offset	Int	The initial index from which to return the results.	[optional]

Return type

[TapeGroup]

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllTapes

    open class func getAllTapes( id: Double? = nil,  name: String? = nil,  group: Double? = nil,  groupIsnull: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[Tape]>

Required permissions * User account permission: None (read) / ltfs:tapegroups:manage (write) * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Double | Filter the returned list by `id`. (optional)
let name = "name_example" // String | Filter the returned list by `name`. (optional)
let group = 987 // Double | Filter the returned list by `group`. (optional)
let groupIsnull = "groupIsnull_example" // String | Filter the returned list by `group__isnull`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

TapeArchiveAPI.getAllTapes(id: id, name: name, group: group, groupIsnull: groupIsnull, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	Double	Filter the returned list by `id`.	[optional]
name	String	Filter the returned list by `name`.	[optional]
group	Double	Filter the returned list by `group`.	[optional]
groupIsnull	String	Filter the returned list by `group__isnull`.	[optional]
ordering	String	Which field to use when ordering the results.	[optional]
limit	Int	Number of results to return per page.	[optional]
offset	Int	The initial index from which to return the results.	[optional]

Return type

[Tape]

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getArchivedFileEntry

    open class func getArchivedFileEntry( id: Int) -> Promise<TapeFile>

Required permissions * User account permission: ltfs:search (read) / ltfs:manage (write) * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Archived file entry.

TapeArchiveAPI.getArchivedFileEntry(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this Archived file entry.

Return type

TapeFile

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTape

    open class func getTape( id: Int) -> Promise<Tape>

Required permissions * User account permission: None (read) / ltfs:tapegroups:manage (write) * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this tape.

TapeArchiveAPI.getTape(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this tape.

Return type

Tape

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTapeArchiveJob

    open class func getTapeArchiveJob( id: String) -> Promise<TapeJob>

Required permissions * User account permission: None (read) / ltfs:manage (write) * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = "id_example" // String | 

TapeArchiveAPI.getTapeArchiveJob(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	String

Return type

TapeJob

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTapeArchiveJobSources

    open class func getTapeArchiveJobSources( id: String) -> Promise<[TapeJobSource]>

Required permissions * User account permission: None (read) / ltfs:manage (write) * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = "id_example" // String | 

TapeArchiveAPI.getTapeArchiveJobSources(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	String

Return type

[TapeJobSource]

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTapeGroup

    open class func getTapeGroup( id: Int) -> Promise<TapeGroup>

Required permissions * User account permission: None (read) / ltfs:tapegroups:manage (write) * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this tape group.

TapeArchiveAPI.getTapeGroup(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this tape group.

Return type

TapeGroup

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTapeLibraryState

    open class func getTapeLibraryState() -> Promise<TapeLibraryEndpointResponse>

Required permissions * User account permission: ltfs:manage * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK


TapeArchiveAPI.getTapeLibraryState().then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

This endpoint does not need any parameter.

Return type

TapeLibraryEndpointResponse

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

loadTape

    open class func loadTape( tapeLibraryLoadEndpointRequest: TapeLibraryLoadEndpointRequest) -> Promise<Void>

Required permissions * User account permission: ltfs:manage * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let tapeLibraryLoadEndpointRequest = TapeLibraryLoadEndpointRequest(barcode: "barcode_example") // TapeLibraryLoadEndpointRequest | 

TapeArchiveAPI.loadTape(tapeLibraryLoadEndpointRequest: tapeLibraryLoadEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
tapeLibraryLoadEndpointRequest	TapeLibraryLoadEndpointRequest

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

moveTape

    open class func moveTape( tapeLibraryMoveEndpointRequest: TapeLibraryMoveEndpointRequest) -> Promise<Void>

Required permissions * User account permission: ltfs:manage * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let tapeLibraryMoveEndpointRequest = TapeLibraryMoveEndpointRequest(barcode: "barcode_example", slot: 123) // TapeLibraryMoveEndpointRequest | 

TapeArchiveAPI.moveTape(tapeLibraryMoveEndpointRequest: tapeLibraryMoveEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
tapeLibraryMoveEndpointRequest	TapeLibraryMoveEndpointRequest

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchTape

    open class func patchTape( id: Int,  tapePartialUpdate: TapePartialUpdate) -> Promise<Tape>

Required permissions * User account permission: None (read) / ltfs:tapegroups:manage (write) * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this tape.
let tapePartialUpdate = TapePartialUpdate(name: "name_example", uuid: "uuid_example", generation: 123, customA: "customA_example", customB: "customB_example", customC: "customC_example", customD: "customD_example", freeSpace: 123, loadCounter: 123, errorCounter: 123, errorReason: "errorReason_example", active: false, lto: "lto_example", group: 123) // TapePartialUpdate | 

TapeArchiveAPI.patchTape(id: id, tapePartialUpdate: tapePartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this tape.
tapePartialUpdate	TapePartialUpdate

Return type

Tape

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchTapeGroup

    open class func patchTapeGroup( id: Int,  tapeGroupPartialUpdate: TapeGroupPartialUpdate) -> Promise<TapeGroup>

Required permissions * User account permission: None (read) / ltfs:tapegroups:manage (write) * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this tape group.
let tapeGroupPartialUpdate = TapeGroupPartialUpdate(tapes: [TapeReference(id: 123, rootEntry: 123, name: "name_example", uuid: "uuid_example", generation: 123, customA: "customA_example", customB: "customB_example", customC: "customC_example", customD: "customD_example", freeSpace: 123, loadCounter: 123, errorCounter: 123, errorReason: "errorReason_example", active: false, lto: "lto_example", group: 123)], name: "name_example") // TapeGroupPartialUpdate | 

TapeArchiveAPI.patchTapeGroup(id: id, tapeGroupPartialUpdate: tapeGroupPartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this tape group.
tapeGroupPartialUpdate	TapeGroupPartialUpdate

Return type

TapeGroup

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

pauseTapeArchiveJob

    open class func pauseTapeArchiveJob( id: String) -> Promise<Void>

Required permissions * User account permission: None (read) / ltfs:manage (write) * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = "id_example" // String | 

TapeArchiveAPI.pauseTapeArchiveJob(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	String

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

refreshTapeLibraryState

    open class func refreshTapeLibraryState() -> Promise<Void>

Required permissions * User account permission: ltfs:manage * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK


TapeArchiveAPI.refreshTapeLibraryState().then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

This endpoint does not need any parameter.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

reindexTape

    open class func reindexTape( tapeLibraryReindexEndpointRequest: TapeLibraryReindexEndpointRequest) -> Promise<Void>

Required permissions * User account permission: ltfs:manage * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let tapeLibraryReindexEndpointRequest = TapeLibraryReindexEndpointRequest(barcode: "barcode_example") // TapeLibraryReindexEndpointRequest | 

TapeArchiveAPI.reindexTape(tapeLibraryReindexEndpointRequest: tapeLibraryReindexEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
tapeLibraryReindexEndpointRequest	TapeLibraryReindexEndpointRequest

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

removeFinishedTapeArchiveJobs

    open class func removeFinishedTapeArchiveJobs() -> Promise<Void>

Required permissions * User account permission: None (read) / ltfs:manage (write) * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK


TapeArchiveAPI.removeFinishedTapeArchiveJobs().then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

This endpoint does not need any parameter.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

restartTapeArchiveJob

    open class func restartTapeArchiveJob( id: String) -> Promise<Void>

Required permissions * User account permission: None (read) / ltfs:manage (write) * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = "id_example" // String | 

TapeArchiveAPI.restartTapeArchiveJob(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	String

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

restoreFromTape

    open class func restoreFromTape( restoreEndpointRequest: RestoreEndpointRequest) -> Promise<TapeJob>

Required permissions * User account permission: ltfs:restore * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let restoreEndpointRequest = RestoreEndpointRequest(name: "name_example", source: [TapeJobSource(path: "path_example", options: "TODO", include: "include_example")], exclude: ["exclude_example"], tape: "tape_example", export: false, startDate: Date()) // RestoreEndpointRequest | 

TapeArchiveAPI.restoreFromTape(restoreEndpointRequest: restoreEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
restoreEndpointRequest	RestoreEndpointRequest

Return type

TapeJob

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

resumeTapeArchiveJob

    open class func resumeTapeArchiveJob( id: String) -> Promise<Void>

Required permissions * User account permission: None (read) / ltfs:manage (write) * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = "id_example" // String | 

TapeArchiveAPI.resumeTapeArchiveJob(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	String

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

searchTapeArchive

    open class func searchTapeArchive( searchEndpointRequest: SearchEndpointRequest) -> Promise<SearchEndpointResponse>

Required permissions * User account permission: ltfs:search * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let searchEndpointRequest = SearchEndpointRequest(query: "query_example", exclude: "exclude_example", offset: 123, limit: 123, dirsOnly: false, namesOnly: false, tapes: false) // SearchEndpointRequest | 

TapeArchiveAPI.searchTapeArchive(searchEndpointRequest: searchEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
searchEndpointRequest	SearchEndpointRequest

Return type

SearchEndpointResponse

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unloadTape

    open class func unloadTape( tapeLibraryUnloadEndpointRequest: TapeLibraryUnloadEndpointRequest) -> Promise<Void>

Required permissions * User account permission: ltfs:manage * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let tapeLibraryUnloadEndpointRequest = TapeLibraryUnloadEndpointRequest(barcode: "barcode_example") // TapeLibraryUnloadEndpointRequest | 

TapeArchiveAPI.unloadTape(tapeLibraryUnloadEndpointRequest: tapeLibraryUnloadEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
tapeLibraryUnloadEndpointRequest	TapeLibraryUnloadEndpointRequest

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateTape

    open class func updateTape( id: Int,  tapeUpdate: TapeUpdate) -> Promise<Tape>

Required permissions * User account permission: None (read) / ltfs:tapegroups:manage (write) * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this tape.
let tapeUpdate = TapeUpdate(name: "name_example", uuid: "uuid_example", generation: 123, customA: "customA_example", customB: "customB_example", customC: "customC_example", customD: "customD_example", freeSpace: 123, loadCounter: 123, errorCounter: 123, errorReason: "errorReason_example", active: false, lto: "lto_example", group: 123) // TapeUpdate | 

TapeArchiveAPI.updateTape(id: id, tapeUpdate: tapeUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this tape.
tapeUpdate	TapeUpdate

Return type

Tape

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateTapeGroup

    open class func updateTapeGroup( id: Int,  tapeGroupUpdate: TapeGroupUpdate) -> Promise<TapeGroup>

Required permissions * User account permission: None (read) / ltfs:tapegroups:manage (write) * License component: ltfs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this tape group.
let tapeGroupUpdate = TapeGroupUpdate(tapes: [TapeReference(id: 123, rootEntry: 123, name: "name_example", uuid: "uuid_example", generation: 123, customA: "customA_example", customB: "customB_example", customC: "customC_example", customD: "customD_example", freeSpace: 123, loadCounter: 123, errorCounter: 123, errorReason: "errorReason_example", active: false, lto: "lto_example", group: 123)], name: "name_example") // TapeGroupUpdate | 

TapeArchiveAPI.updateTapeGroup(id: id, tapeGroupUpdate: tapeGroupUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this tape group.
tapeGroupUpdate	TapeGroupUpdate

Return type

TapeGroup

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]