Struct cml::rest::CmlUser

pub struct CmlUser { /* fields omitted */ }

Implementations

impl CmlUser

pub fn host(&self) -> &str

pub fn username(&self) -> &str

pub fn roles(&self) -> Vec<&str>

pub async fn labs(&self, show_all: bool) -> Result<Vec<String>, CmlError>

Get a list of labs visible to the user.

show_all: If true (and the user is an admin), returns a list of all labs.

pub async fn lab(&self, lab_id: &str) -> Result<Option<Lab>, CmlError>

Gets a lab’s information. If the lab is not found, returns Ok(None)

pub async fn lab_nodes(
    &self,
    lab_id: &str
) -> Result<Option<Vec<String>>, CmlError>

Get’s a list of the lab’s nodes.

pub async fn lab_node(
    &self,
    lab_id: &str,
    node_id: &str
) -> Result<Option<SimpleNode>, CmlError>

pub async fn lab_node_config(
    &self,
    lab_id: &str,
    node_id: &str
) -> Result<Option<String>, CmlError>

Gets the currently saved configuration for the device. May not match the currently running configuration.

pub async fn lab_node_state(
    &self,
    lab_id: &str,
    node_id: &str
) -> Result<Option<State>, CmlError>

pub async fn lab_node_start(
    &self,
    lab_id: &str,
    node_id: &str
) -> Result<Option<State>, CmlError>

pub async fn lab_node_stop(
    &self,
    lab_id: &str,
    node_id: &str
) -> Result<Option<()>, CmlError>

pub async fn lab_node_keys_console(
    &self,
    lab_id: &str,
    node_id: &str,
    line: Option<u64>
) -> Result<Option<String>, CmlError>

pub async fn lab_topology(
    &self,
    lab_id: &str,
    include_configurations: bool
) -> Result<Option<LabTopology>, CmlError>

pub async fn lab_topologies<'b, I: IntoIterator<Item = &'b S>, S: AsRef<str> + 'b>(
    &self,
    lab_ids: I,
    include_configurations: bool
) -> Result<Vec<(&'b str, Option<LabTopology>)>, CmlError>

pub async fn keys_console(
    &self,
    show_all: bool
) -> Result<HashMap<String, Console>, CmlError>

Returns the currently available console lines. This does not show lines from shutdown devices.

pub async fn keys_vnc(
    &self,
    show_all: bool
) -> Result<HashMap<String, VNC>, CmlError>

Returns the currently available keys for devices capable of VNC. This does not show keys from shutdown or disabled devices.

pub async fn extract_node_config(
    &self,
    lab_id: &str,
    node_id: &str
) -> Result<Option<String>, CmlError>

Extracts the configuration from a running node

Returns None if the lab nor node cannot be found

pub async fn simplified_node_definitions(
    &self
) -> Result<Vec<SimpleNodeDefinition>, CmlError>

Trait Implementations

impl Clone for CmlUser

fn clone(&self) -> CmlUser

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CmlUser

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.