proxmox-backup/src/api2/config/changer.rs

296 lines
6.9 KiB
Rust
Raw Normal View History

2020-12-08 08:04:56 +00:00
use anyhow::{bail, Error};
2021-01-06 10:06:50 +00:00
use ::serde::{Deserialize, Serialize};
2020-12-08 08:04:56 +00:00
use serde_json::Value;
2021-01-06 10:06:50 +00:00
use proxmox::api::{
api,
Router,
RpcEnvironment,
schema::parse_property_string,
};
2020-12-08 08:04:56 +00:00
use crate::{
config,
api2::types::{
2020-12-08 10:24:38 +00:00
PROXMOX_CONFIG_DIGEST_SCHEMA,
CHANGER_NAME_SCHEMA,
2020-12-08 08:04:56 +00:00
LINUX_DRIVE_PATH_SCHEMA,
2021-01-06 10:06:50 +00:00
SLOT_ARRAY_SCHEMA,
EXPORT_SLOT_LIST_SCHEMA,
2020-12-08 08:04:56 +00:00
ScsiTapeChanger,
LinuxTapeDrive,
2020-12-08 08:04:56 +00:00
},
2021-01-21 16:25:32 +00:00
tape::{
2020-12-08 08:04:56 +00:00
linux_tape_changer_list,
check_drive_path,
},
};
#[api(
protected: true,
2020-12-08 08:04:56 +00:00
input: {
properties: {
name: {
schema: CHANGER_NAME_SCHEMA,
2020-12-08 08:04:56 +00:00
},
path: {
schema: LINUX_DRIVE_PATH_SCHEMA,
},
2021-01-06 10:06:50 +00:00
"export-slots": {
schema: EXPORT_SLOT_LIST_SCHEMA,
optional: true,
},
2020-12-08 08:04:56 +00:00
},
},
)]
/// Create a new changer device
pub fn create_changer(
name: String,
path: String,
2021-01-06 10:06:50 +00:00
export_slots: Option<String>,
2020-12-08 08:04:56 +00:00
) -> Result<(), Error> {
let _lock = config::drive::lock()?;
let (mut config, _digest) = config::drive::config()?;
let linux_changers = linux_tape_changer_list();
check_drive_path(&linux_changers, &path)?;
let existing: Vec<ScsiTapeChanger> = config.convert_to_typed_array("changer")?;
for changer in existing {
if changer.name == name {
bail!("Entry '{}' already exists", name);
}
if changer.path == path {
bail!("Path '{}' already in use by '{}'", path, changer.name);
}
2020-12-08 08:04:56 +00:00
}
let item = ScsiTapeChanger {
name: name.clone(),
path,
2021-01-06 10:06:50 +00:00
export_slots,
2020-12-08 08:04:56 +00:00
};
config.set_data(&name, "changer", &item)?;
config::drive::save_config(&config)?;
Ok(())
}
#[api(
input: {
properties: {
name: {
schema: CHANGER_NAME_SCHEMA,
2020-12-08 08:04:56 +00:00
},
},
},
returns: {
type: ScsiTapeChanger,
},
)]
/// Get tape changer configuration
pub fn get_config(
name: String,
_param: Value,
mut rpcenv: &mut dyn RpcEnvironment,
) -> Result<ScsiTapeChanger, Error> {
let (config, digest) = config::drive::config()?;
let data: ScsiTapeChanger = config.lookup("changer", &name)?;
rpcenv["digest"] = proxmox::tools::digest_to_hex(&digest).into();
Ok(data)
}
#[api(
input: {
properties: {},
},
returns: {
description: "The list of configured changers (with config digest).",
type: Array,
items: {
type: ScsiTapeChanger,
2020-12-08 08:04:56 +00:00
},
},
)]
/// List changers
pub fn list_changers(
_param: Value,
mut rpcenv: &mut dyn RpcEnvironment,
) -> Result<Vec<ScsiTapeChanger>, Error> {
2020-12-08 08:04:56 +00:00
let (config, digest) = config::drive::config()?;
let list: Vec<ScsiTapeChanger> = config.convert_to_typed_array("changer")?;
2020-12-08 08:04:56 +00:00
rpcenv["digest"] = proxmox::tools::digest_to_hex(&digest).into();
2020-12-08 08:04:56 +00:00
Ok(list)
}
2021-01-06 10:06:50 +00:00
#[api()]
#[derive(Serialize, Deserialize)]
#[allow(non_camel_case_types)]
#[serde(rename_all = "kebab-case")]
/// Deletable property name
pub enum DeletableProperty {
/// Delete export-slots.
export_slots,
}
2020-12-08 08:04:56 +00:00
#[api(
protected: true,
2020-12-08 08:04:56 +00:00
input: {
properties: {
name: {
schema: CHANGER_NAME_SCHEMA,
2020-12-08 08:04:56 +00:00
},
path: {
schema: LINUX_DRIVE_PATH_SCHEMA,
optional: true,
},
2021-01-06 10:06:50 +00:00
"export-slots": {
schema: EXPORT_SLOT_LIST_SCHEMA,
optional: true,
},
delete: {
description: "List of properties to delete.",
type: Array,
optional: true,
items: {
type: DeletableProperty,
},
},
2020-12-08 10:24:38 +00:00
digest: {
schema: PROXMOX_CONFIG_DIGEST_SCHEMA,
optional: true,
},
},
2020-12-08 08:04:56 +00:00
},
)]
/// Update a tape changer configuration
pub fn update_changer(
name: String,
path: Option<String>,
2021-01-06 10:06:50 +00:00
export_slots: Option<String>,
delete: Option<Vec<DeletableProperty>>,
2020-12-08 10:24:38 +00:00
digest: Option<String>,
2020-12-08 08:04:56 +00:00
_param: Value,
) -> Result<(), Error> {
let _lock = config::drive::lock()?;
2020-12-08 10:24:38 +00:00
let (mut config, expected_digest) = config::drive::config()?;
if let Some(ref digest) = digest {
let digest = proxmox::tools::hex_to_digest(digest)?;
crate::tools::detect_modified_configuration_file(&digest, &expected_digest)?;
}
2020-12-08 08:04:56 +00:00
let mut data: ScsiTapeChanger = config.lookup("changer", &name)?;
2021-01-06 10:06:50 +00:00
if let Some(delete) = delete {
for delete_prop in delete {
match delete_prop {
DeletableProperty::export_slots => {
data.export_slots = None;
}
}
}
}
2020-12-08 08:04:56 +00:00
if let Some(path) = path {
let changers = linux_tape_changer_list();
check_drive_path(&changers, &path)?;
data.path = path;
}
2021-01-06 10:06:50 +00:00
if let Some(export_slots) = export_slots {
let slots: Value = parse_property_string(
&export_slots, &SLOT_ARRAY_SCHEMA
)?;
let mut slots: Vec<String> = slots
.as_array()
.unwrap()
.iter()
.map(|v| v.to_string())
.collect();
slots.sort();
if slots.is_empty() {
data.export_slots = None;
} else {
let slots = slots.join(",");
data.export_slots = Some(slots);
}
}
2020-12-08 08:04:56 +00:00
config.set_data(&name, "changer", &data)?;
config::drive::save_config(&config)?;
Ok(())
}
#[api(
protected: true,
2020-12-08 08:04:56 +00:00
input: {
properties: {
name: {
schema: CHANGER_NAME_SCHEMA,
2020-12-08 08:04:56 +00:00
},
},
},
)]
/// Delete a tape changer configuration
pub fn delete_changer(name: String, _param: Value) -> Result<(), Error> {
let _lock = config::drive::lock()?;
let (mut config, _digest) = config::drive::config()?;
match config.sections.get(&name) {
Some((section_type, _)) => {
if section_type != "changer" {
bail!("Entry '{}' exists, but is not a changer device", name);
}
config.sections.remove(&name);
},
None => bail!("Delete changer '{}' failed - no such entry", name),
}
let drive_list: Vec<LinuxTapeDrive> = config.convert_to_typed_array("linux")?;
for drive in drive_list {
if let Some(changer) = drive.changer {
if changer == name {
bail!("Delete changer '{}' failed - used by drive '{}'", name, drive.name);
}
}
}
2020-12-08 08:04:56 +00:00
config::drive::save_config(&config)?;
Ok(())
}
const ITEM_ROUTER: Router = Router::new()
.get(&API_METHOD_GET_CONFIG)
.put(&API_METHOD_UPDATE_CHANGER)
.delete(&API_METHOD_DELETE_CHANGER);
pub const ROUTER: Router = Router::new()
.get(&API_METHOD_LIST_CHANGERS)
.post(&API_METHOD_CREATE_CHANGER)
.match_all("name", &ITEM_ROUTER);