eveng 0.1.1

An API Client for EVE-NG
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
//! Types and clients for managing nodes within a lab.

use crate::interfaces::{Ethernet, InterfaceClient, InterfacesClient, Serial};
use crate::labs::{LabClient, LabPath};
use crate::templates::NodeTemplate;
use crate::utils::{WireMap, empty_string_is_none, private::Sealed};
use crate::{Client, Error, Result};

use serde::de::DeserializeOwned;
use serde::{Deserialize, Serialize};
use serde_json::Value;
use serde_repr::{Deserialize_repr, Serialize_repr};
use std::collections::HashMap;
use std::time::Duration;

/// Type to describe a node in a lab.
#[derive(Debug, Serialize, Deserialize)]
pub struct Node {
    /// Startup config status of the node.
    pub config: StartupConfig,
    /// Seconds to wait before starting the node.
    pub delay: u32,
    /// Icon used to display the node in the lab.
    pub icon: String,
    /// Image used to boot the node.
    pub image: String,
    /// Left margin of the node.
    pub left: u32,
    /// Name used to display the node in the lab.
    pub name: String,
    /// Type of the node.
    #[serde(rename = "type")]
    pub node_type: NodeType,
    /// Run status of the node.
    pub status: NodeStatus,
    /// Template used to provide default values for the node.
    pub template: String,
    /// Top margin of the node.
    pub top: u32,
    /// URL to the console session of the node.
    pub url: String,
    /// List of available startup config templates for the node.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub config_list: Option<Vec<Value>>,
    /// Type of console of the node.
    #[serde(
        deserialize_with = "empty_string_is_none",
        skip_serializing_if = "Option::is_none"
    )]
    pub console: Option<String>,
    /// ID of the node.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub id: Option<u32>,
    /// Number of configured CPUs on the node (QEMU only).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cpu: Option<u32>,
    /// CPU limit status of the node (QEMU only).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cpulimit: Option<u8>,
    /// Number of configured Ethernet interfaces/portgroups (Docker, Dynamips,
    /// IOL and QEMU).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub ethernet: Option<u32>,
    /// Idle PC for the node (Dynamips only).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub idlepc: Option<String>,
    /// NVRAM configured on the node, in kilobytes (IOL and Dynamips).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub nvram: Option<u32>,
    /// QEMU version used to boot the node (QEMU only).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub qemu_version: Option<String>,
    /// QEMU target architecture used to boot the node (QEMU only).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub qemu_arch: Option<String>,
    /// QEMU NIC model used for the node's interfaces (QEMU only).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub qemu_nic: Option<String>,
    /// Custom options passed to QEMU when creating the node (QEMU only).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub qemu_options: Option<String>,
    /// RAM configured on the node, in megabytes (Docker, Dynamips, IOL, QEMU).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub ram: Option<u32>,
    /// Number of configured Serial portgroups (IOL only).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub serial: Option<u32>,
    /// Module configured in slot 1 of the node (Dynamips only).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub slot1: Option<String>,
    /// Module configured in slot 2 of the node (Dynamips only).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub slot2: Option<String>,
    /// Module configured in slot 3 of the node (Dynamips only).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub slot3: Option<String>,
    /// Module configured in slot 4 of the node (Dynamips only).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub slot4: Option<String>,
    /// Module configured in slot 5 of the node (Dynamips only).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub slot5: Option<String>,
    /// Module configured in slot 6 of the node (Dynamips only).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub slot6: Option<String>,
    /// UUID configured for the node (QEMU only).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub uuid: Option<String>,
}

/// Type of the node.
#[derive(Debug, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum NodeType {
    /// A node backed by a Docker container.
    Docker,
    /// A node emulated by Dynamips.
    Dynamips,
    /// A node running an IOS on Linux image.
    Iol,
    /// A node emulated by QEMU.
    Qemu,
    /// A node running the Virtual PC Simulator.
    Vpcs,
}

impl std::fmt::Display for NodeType {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        let value = match self {
            NodeType::Qemu => "qemu",
            NodeType::Iol => "iol",
            NodeType::Docker => "docker",
            NodeType::Dynamips => "dynamips",
            NodeType::Vpcs => "vpcs",
        };

        f.write_str(value)
    }
}

/// Run status of the node.
#[derive(Debug, PartialEq, Eq, Serialize_repr, Deserialize_repr)]
#[repr(u8)]
pub enum NodeStatus {
    /// The node is not running.
    Stopped = 0,
    /// The node is booting.
    Starting = 1,
    /// The node is running.
    Running = 2,
    /// The node is shutting down.
    Stopping = 3,
}

/// Startup config status of the node.
#[derive(Debug, PartialEq, Eq, Serialize_repr, Deserialize_repr)]
#[repr(u8)]
pub enum StartupConfig {
    /// The node boots without a startup config.
    None = 0,
    /// The node boots from a previously exported startup config.
    Exported = 1,
}

impl From<u8> for StartupConfig {
    fn from(v: u8) -> Self {
        match v {
            0 => StartupConfig::None,
            1 => StartupConfig::Exported,
            _ => StartupConfig::None,
        }
    }
}

/// A client to manage nodes.
pub struct NodesClient {
    client: Client,
    path: LabPath,
}

impl NodesClient {
    pub(crate) fn new(client: Client, path: LabPath) -> Self {
        Self { client, path }
    }

    fn lab(&self) -> LabClient {
        LabClient::from_path(self.client.clone(), self.path.clone())
    }

    /// Lists all nodes.
    pub async fn list(&self) -> Result<HashMap<u32, Node>> {
        Ok(self
            .client
            .get::<WireMap<u32, Node>>(&format!("labs{}/nodes", self.path))
            .await?
            .into_data()?
            .0)
    }

    /// Adds a node.
    pub async fn add<T: TypedNode>(&self, params: AddNodeRequest<T>) -> Result<NodeClient> {
        self.lab().open().await?;

        #[derive(Deserialize)]
        struct CreateNodeResponse {
            id: u32,
        }

        let resp: CreateNodeResponse = self
            .client
            .post(&format!("labs{}/nodes", self.path), &params)
            .await?
            .into_data()?;

        Ok(NodeClient::new(
            self.client.clone(),
            self.path.clone(),
            resp.id,
        ))
    }

    /// Starts all nodes.
    pub async fn start(&self) -> Result<()> {
        self.lab().open().await?;

        self.client
            .get::<()>(&format!("labs{}/nodes/start", self.path))
            .await?;

        tokio::time::sleep(Duration::from_millis(500)).await;
        Ok(())
    }

    /// Stops all nodes.
    pub async fn stop(&self) -> Result<()> {
        self.lab().open().await?;

        self.client
            .get::<()>(&format!("labs{}/nodes/stop", self.path))
            .await?;

        tokio::time::sleep(Duration::from_millis(500)).await;
        Ok(())
    }

    /// Wipes the existing config of all nodes.
    pub async fn wipe(&self) -> Result<()> {
        self.lab().open().await?;

        self.client
            .get::<()>(&format!("labs{}/nodes/wipe", self.path))
            .await?;
        Ok(())
    }

    /// Exports the running config of all supported nodes as startup configs.
    pub async fn export(&self) -> Result<()> {
        self.lab().open().await?;

        self.client
            .get::<()>(&format!("labs{}/nodes/export", self.path))
            .await?;
        Ok(())
    }
}

/// A client to manage a single node.
pub struct NodeClient {
    client: Client,
    path: LabPath,
    id: u32,
}

impl NodeClient {
    pub(crate) fn new(client: Client, path: LabPath, id: u32) -> Self {
        Self { client, path, id }
    }

    fn lab(&self) -> LabClient {
        LabClient::from_path(self.client.clone(), self.path.clone())
    }

    /// Gets the details of the node.
    pub async fn get(&self) -> Result<Node> {
        self.client
            .get(&format!("labs{}/nodes/{}", self.path, self.id))
            .await?
            .into_data()
    }

    /// Gets the run status of the node.
    pub async fn status(&self) -> Result<NodeStatus> {
        Ok(self.get().await?.status)
    }

    /// Gets the type of the node.
    pub async fn node_type(&self) -> Result<NodeType> {
        Ok(self.get().await?.node_type)
    }

    /// Updates the details of the node.
    pub async fn edit<T: TypedNode>(&self, params: EditNodeRequest<T>) -> Result<()> {
        self.lab().open().await?;

        if matches!(params.status, NodeStatus::Running) {
            return Err(Error::Client(
                "Cannot edit node as it is still running.".to_string(),
            ));
        }

        self.client
            .put::<(), EditNodeRequest<T>>(&format!("labs{}/nodes/{}", self.path, self.id), &params)
            .await?;

        Ok(())
    }

    /// Deletes the node.
    pub async fn delete(self) -> Result<()> {
        self.lab().open().await?;

        if matches!(self.status().await?, NodeStatus::Running) {
            return Err(Error::Client(
                "Cannot delete node as it is still running.".to_string(),
            ));
        }

        self.client
            .delete::<()>(&format!("labs{}/nodes/{}", self.path, self.id))
            .await?;

        Ok(())
    }

    /// Starts the node.
    pub async fn start(&self) -> Result<()> {
        self.lab().open().await?;

        self.client
            .get::<()>(&format!("labs{}/nodes/{}/start", self.path, self.id))
            .await?;

        tokio::time::sleep(Duration::from_millis(500)).await;
        Ok(())
    }

    /// Stops the node.
    pub async fn stop(&self) -> Result<()> {
        self.lab().open().await?;

        self.client
            .get::<()>(&format!("labs{}/nodes/{}/stop", self.path, self.id))
            .await?;

        tokio::time::sleep(Duration::from_millis(500)).await;
        Ok(())
    }

    /// Wipes the existing config of the node.
    pub async fn wipe(&self) -> Result<()> {
        self.lab().open().await?;

        self.client
            .get::<()>(&format!("labs{}/nodes/{}/wipe", self.path, self.id))
            .await?;
        Ok(())
    }

    /// Exports the existing config of the node as a startup config. Returns
    /// an error if export is unsupported for the node.
    ///
    /// The node's existing config needs to be [wiped] before booting from the
    /// exported config.
    ///
    /// [wiped]: Self::wipe
    pub async fn export(&self) -> Result<()> {
        self.lab().open().await?;

        self.client
            .get::<()>(&format!("labs{}/nodes/{}/export", self.path, self.id))
            .await?;
        Ok(())
    }

    /// Returns a client to manage interfaces.
    pub fn interfaces(&self) -> InterfacesClient {
        InterfacesClient::new(self.client.clone(), self.path.clone(), self.id)
    }

    /// Returns a client to manage an ethernet interface.
    pub fn ethernet(&self, id: u32) -> InterfaceClient<Ethernet> {
        InterfaceClient::ethernet(self.client.clone(), self.path.clone(), self.id, id)
    }

    /// Returns a client to manage a serial interface.
    pub fn serial(&self, id: u32) -> InterfaceClient<Serial> {
        InterfaceClient::serial(self.client.clone(), self.path.clone(), self.id, id)
    }
}

/// Parameters specific to a node of type [`NodeType::Docker`].
#[derive(Debug, Default, Serialize, Deserialize)]
pub struct Docker {
    ethernet: u32,
    image: String,
    ram: u32,
}

/// Parameters specific to a node of type [`NodeType::Dynamips`].
#[derive(Debug, Default, Serialize, Deserialize)]
pub struct Dynamips {
    idlepc: String,
    image: String,
    nvram: u32,
    ram: u32,
    slot1: String,
    slot2: String,
    slot3: Option<String>,
    slot4: Option<String>,
    slot5: Option<String>,
    slot6: Option<String>,
}

/// Parameters specific to a node of type [`NodeType::Iol`].
#[derive(Debug, Default, Serialize, Deserialize)]
pub struct Iol {
    ethernet: u32,
    image: String,
    nvram: u32,
    ram: u32,
    serial: u32,
}

/// Parameters specific to a node of type [`NodeType::Qemu`].
#[derive(Debug, Default, Serialize, Deserialize)]
pub struct Qemu {
    cpu: u32,
    cpulimit: u8,
    ethernet: u32,
    image: String,
    ram: u32,
    qemu_version: String,
    qemu_arch: String,
    qemu_nic: String,
    qemu_options: String,
    uuid: String,
}

/// Parameters specific to a node of type [`NodeType::Vpcs`].
#[derive(Debug, Default, Serialize, Deserialize)]
pub struct Vpcs {
    #[serde(skip_serializing_if = "Option::is_none")]
    ethernet: Option<u32>,
}

/// Trait that binds static node types to [`NodeType`].
pub trait TypedNode: Default + Serialize + DeserializeOwned + Sealed {
    /// Type of the node.
    const NODE_TYPE: NodeType;
}

impl Sealed for Qemu {}
impl TypedNode for Qemu {
    const NODE_TYPE: NodeType = NodeType::Qemu;
}

impl Sealed for Docker {}
impl TypedNode for Docker {
    const NODE_TYPE: NodeType = NodeType::Docker;
}

impl Sealed for Dynamips {}
impl TypedNode for Dynamips {
    const NODE_TYPE: NodeType = NodeType::Dynamips;
}

impl Sealed for Vpcs {}
impl TypedNode for Vpcs {
    const NODE_TYPE: NodeType = NodeType::Vpcs;
}

impl Sealed for Iol {}
impl TypedNode for Iol {
    const NODE_TYPE: NodeType = NodeType::Iol;
}

/// Request to add a node.
#[derive(Debug, Serialize, Deserialize)]
pub struct AddNodeRequest<T> {
    count: u32,
    left: u32,
    #[serde(rename = "type")]
    node_type: NodeType,
    template: String,
    top: u32,
    config: StartupConfig,
    delay: u32,
    icon: String,
    name: String,

    #[serde(flatten, default)]
    params: T,
}

impl<T: TypedNode> AddNodeRequest<T> {
    fn from_template(template: &NodeTemplate) -> Result<Self> {
        if template.node_type != T::NODE_TYPE {
            return Err(Error::Client(format!(
                "Incorrect type, expected '{}', got '{}'",
                template.node_type,
                T::NODE_TYPE
            )));
        }

        if template.description.ends_with(".missing") {
            return Err(Error::Client(format!(
                "Cannot create node as image for template '{}' is missing",
                template.name
            )));
        }

        let mut defaults = template.defaults_map()?;
        defaults.insert("type".to_string(), serde_json::json!(template.node_type));
        defaults.insert("template".to_string(), serde_json::json!(template.name));
        defaults.insert("left".to_string(), serde_json::json!(0));
        defaults.insert("top".to_string(), serde_json::json!(0));
        defaults.insert("count".to_string(), serde_json::json!(1));

        serde_json::from_value(Value::Object(defaults)).map_err(Into::into)
    }

    /// Startup config status of the node.
    pub fn config(mut self, config: StartupConfig) -> Self {
        self.config = config;
        self
    }

    /// Seconds to wait before starting the node.
    pub fn delay(mut self, delay: u32) -> Self {
        self.delay = delay;
        self
    }

    /// Icon used to display the node in the lab.
    pub fn icon(mut self, icon: impl Into<String>) -> Self {
        self.icon = icon.into();
        self
    }

    /// Name used to display the node in the lab.
    pub fn name(mut self, name: impl Into<String>) -> Self {
        self.name = name.into();
        self
    }

    /// Position of the node in the lab.
    pub fn position(mut self, left: u32, top: u32) -> Self {
        self.left = left;
        self.top = top;
        self
    }
}

impl AddNodeRequest<Docker> {
    /// Creates a request to add a node of type [`NodeType::Docker`].
    pub fn docker(template: &NodeTemplate) -> Result<Self> {
        Self::from_template(template)
    }

    /// Number of configured Ethernet interfaces.
    pub fn ethernet(mut self, ethernet: u32) -> Self {
        self.params.ethernet = ethernet;
        self
    }

    /// Image used to boot the node.
    pub fn image(mut self, image: impl Into<String>) -> Self {
        self.params.image = image.into();
        self
    }

    /// RAM configured on the node, in megabytes.
    pub fn ram(mut self, ram: u32) -> Self {
        self.params.ram = ram;
        self
    }
}

impl AddNodeRequest<Dynamips> {
    /// Creates a request to add a node of type [`NodeType::Dynamips`].
    pub fn dynamips(template: &NodeTemplate) -> Result<Self> {
        Self::from_template(template)
    }

    /// Idle PC for the node.
    pub fn idlepc(mut self, idlepc: impl Into<String>) -> Self {
        self.params.idlepc = idlepc.into();
        self
    }

    /// Image used to boot the node.
    pub fn image(mut self, image: impl Into<String>) -> Self {
        self.params.image = image.into();
        self
    }

    /// NVRAM configured on the node, in kilobytes.
    pub fn nvram(mut self, nvram: u32) -> Self {
        self.params.nvram = nvram;
        self
    }

    /// RAM configured on the node, in megabytes.
    pub fn ram(mut self, ram: u32) -> Self {
        self.params.ram = ram;
        self
    }

    /// Module configured in slot 1 of the node.
    pub fn slot1(mut self, slot1: impl Into<String>) -> Self {
        self.params.slot1 = slot1.into();
        self
    }

    /// Module configured in slot 2 of the node.
    pub fn slot2(mut self, slot2: impl Into<String>) -> Self {
        self.params.slot2 = slot2.into();
        self
    }

    /// Module configured in slot 3 of the node.
    pub fn slot3(mut self, slot3: impl Into<String>) -> Self {
        self.params.slot3 = Some(slot3.into());
        self
    }

    /// Module configured in slot 4 of the node.
    pub fn slot4(mut self, slot4: impl Into<String>) -> Self {
        self.params.slot4 = Some(slot4.into());
        self
    }

    /// Module configured in slot 5 of the node.
    pub fn slot5(mut self, slot5: impl Into<String>) -> Self {
        self.params.slot5 = Some(slot5.into());
        self
    }

    /// Module configured in slot 6 of the node.
    pub fn slot6(mut self, slot6: impl Into<String>) -> Self {
        self.params.slot6 = Some(slot6.into());
        self
    }
}

impl AddNodeRequest<Iol> {
    /// Creates a request to add a node of type [`NodeType::Iol`].
    pub fn iol(template: &NodeTemplate) -> Result<Self> {
        Self::from_template(template)
    }

    /// Number of configured Ethernet portgroups.
    /// A portgroup configures 4 interfaces.
    pub fn ethernet(mut self, ethernet: u32) -> Self {
        self.params.ethernet = ethernet;
        self
    }

    /// Image used to boot the node.
    pub fn image(mut self, image: impl Into<String>) -> Self {
        self.params.image = image.into();
        self
    }

    /// NVRAM configured on the node, in kilobytes.
    pub fn nvram(mut self, nvram: u32) -> Self {
        self.params.nvram = nvram;
        self
    }

    /// RAM configured on the node, in megabytes.
    pub fn ram(mut self, ram: u32) -> Self {
        self.params.ram = ram;
        self
    }

    /// Number of configured Serial portgroups.
    /// A portgroup configures 4 interfaces.
    pub fn serial(mut self, serial: u32) -> Self {
        self.params.serial = serial;
        self
    }
}

impl AddNodeRequest<Qemu> {
    /// Creates a request to add a node of type [`NodeType::Qemu`].
    pub fn qemu(template: &NodeTemplate) -> Result<Self> {
        Self::from_template(template)
    }

    /// Number of configured CPUs on the node.
    pub fn cpu(mut self, cpu: u32) -> Self {
        self.params.cpu = cpu;
        self
    }

    /// Flag to indicate CPU limit status.
    pub fn cpulimit(mut self, cpulimit: u8) -> Self {
        self.params.cpulimit = cpulimit;
        self
    }

    /// Number of configured Ethernet interfaces.
    pub fn ethernet(mut self, ethernet: u32) -> Self {
        self.params.ethernet = ethernet;
        self
    }

    /// Image used to boot the node.
    pub fn image(mut self, image: impl Into<String>) -> Self {
        self.params.image = image.into();
        self
    }

    /// RAM configured on the node, in megabytes.
    pub fn ram(mut self, ram: u32) -> Self {
        self.params.ram = ram;
        self
    }

    /// QEMU version used to boot the node.
    pub fn qemu_version(mut self, qemu_version: impl Into<String>) -> Self {
        self.params.qemu_version = qemu_version.into();
        self
    }

    /// QEMU target architecture used to boot the node.
    pub fn qemu_arch(mut self, qemu_arch: impl Into<String>) -> Self {
        self.params.qemu_arch = qemu_arch.into();
        self
    }

    /// QEMU NIC model used for the interfaces of the node.
    pub fn qemu_nic(mut self, qemu_nic: impl Into<String>) -> Self {
        self.params.qemu_nic = qemu_nic.into();
        self
    }

    /// Custom options passed to QEMU to boot the node.
    pub fn qemu_options(mut self, qemu_options: impl Into<String>) -> Self {
        self.params.qemu_options = qemu_options.into();
        self
    }

    /// UUID configured for the node.
    pub fn uuid(mut self, uuid: impl Into<String>) -> Self {
        self.params.uuid = uuid.into();
        self
    }
}

impl AddNodeRequest<Vpcs> {
    /// Creates a request to add a node of type [`NodeType::Vpcs`].
    pub fn vpcs(template: &NodeTemplate) -> Result<Self> {
        Self::from_template(template)
    }
}

/// Creates a request to edit a node.
#[derive(Debug, Serialize, Deserialize)]
pub struct EditNodeRequest<T> {
    left: u32,
    top: u32,
    config: StartupConfig,
    delay: u32,
    icon: String,
    name: String,
    #[serde(rename = "type")]
    node_type: NodeType,
    #[serde(skip_serializing)]
    status: NodeStatus,
    template: String,

    #[serde(flatten, default)]
    params: T,
}

impl<T: TypedNode> EditNodeRequest<T> {
    pub(crate) fn from_node(node: &Node) -> Result<Self> {
        if node.node_type != T::NODE_TYPE {
            return Err(Error::Client(format!(
                "Incorrect type, expected '{}', got '{}'",
                node.node_type,
                T::NODE_TYPE
            )));
        }

        let value = serde_json::to_value(node)?;
        serde_json::from_value(value).map_err(Into::into)
    }

    /// Startup config status of the node.
    pub fn config(mut self, config: StartupConfig) -> Self {
        self.config = config;
        self
    }

    /// Seconds to wait before starting the node.
    pub fn delay(mut self, delay: u32) -> Self {
        self.delay = delay;
        self
    }

    /// Icon used to display the node in the lab.
    pub fn icon(mut self, icon: impl Into<String>) -> Self {
        self.icon = icon.into();
        self
    }

    /// Name used to display the node in the lab.
    pub fn name(mut self, name: impl Into<String>) -> Self {
        self.name = name.into();
        self
    }

    /// Position of the node in the lab.
    pub fn position(mut self, left: u32, top: u32) -> Self {
        self.left = left;
        self.top = top;
        self
    }
}

impl EditNodeRequest<Docker> {
    /// Creates a request to edit a node of type [`NodeType::Docker`].
    pub fn docker(node: &Node) -> Result<Self> {
        Self::from_node(node)
    }

    /// Number of configured Ethernet interfaces.
    pub fn ethernet(mut self, ethernet: u32) -> Self {
        self.params.ethernet = ethernet;
        self
    }

    /// Image used to boot the node.
    pub fn image(mut self, image: impl Into<String>) -> Self {
        self.params.image = image.into();
        self
    }

    /// RAM configured on the node, in megabytes.
    pub fn ram(mut self, ram: u32) -> Self {
        self.params.ram = ram;
        self
    }
}

impl EditNodeRequest<Dynamips> {
    /// Creates a request to edit a node of type [`NodeType::Dynamips`].
    pub fn dynamips(node: &Node) -> Result<Self> {
        Self::from_node(node)
    }

    /// Idle PC for the node.
    pub fn idlepc(mut self, idlepc: impl Into<String>) -> Self {
        self.params.idlepc = idlepc.into();
        self
    }

    /// Image used to boot the node.
    pub fn image(mut self, image: impl Into<String>) -> Self {
        self.params.image = image.into();
        self
    }

    /// NVRAM configured on the node, in kilobytes.
    pub fn nvram(mut self, nvram: u32) -> Self {
        self.params.nvram = nvram;
        self
    }

    /// RAM configured on the node, in megabytes.
    pub fn ram(mut self, ram: u32) -> Self {
        self.params.ram = ram;
        self
    }

    /// Module configured in slot 1 of the node.
    pub fn slot1(mut self, slot1: impl Into<String>) -> Self {
        self.params.slot1 = slot1.into();
        self
    }

    /// Module configured in slot 2 of the node.
    pub fn slot2(mut self, slot2: impl Into<String>) -> Self {
        self.params.slot2 = slot2.into();
        self
    }

    /// Module configured in slot 3 of the node.
    pub fn slot3(mut self, slot3: impl Into<String>) -> Self {
        self.params.slot3 = Some(slot3.into());
        self
    }

    /// Module configured in slot 4 of the node.
    pub fn slot4(mut self, slot4: impl Into<String>) -> Self {
        self.params.slot4 = Some(slot4.into());
        self
    }

    /// Module configured in slot 5 of the node.
    pub fn slot5(mut self, slot5: impl Into<String>) -> Self {
        self.params.slot5 = Some(slot5.into());
        self
    }

    /// Module configured in slot 6 of the node.
    pub fn slot6(mut self, slot6: impl Into<String>) -> Self {
        self.params.slot6 = Some(slot6.into());
        self
    }
}

impl EditNodeRequest<Iol> {
    /// Creates a request to edit a node of type [`NodeType::Iol`].
    pub fn iol(node: &Node) -> Result<Self> {
        Self::from_node(node)
    }

    /// Number of configured Ethernet portgroups.
    /// A portgroup configures 4 interfaces.
    pub fn ethernet(mut self, ethernet: u32) -> Self {
        self.params.ethernet = ethernet;
        self
    }

    /// Image used to boot the node.
    pub fn image(mut self, image: impl Into<String>) -> Self {
        self.params.image = image.into();
        self
    }

    /// NVRAM configured on the node, in kilobytes.
    pub fn nvram(mut self, nvram: u32) -> Self {
        self.params.nvram = nvram;
        self
    }

    /// RAM configured on the node, in megabytes.
    pub fn ram(mut self, ram: u32) -> Self {
        self.params.ram = ram;
        self
    }

    /// Number of configured Serial portgroups.
    /// A portgroup configures 4 interfaces.
    pub fn serial(mut self, serial: u32) -> Self {
        self.params.serial = serial;
        self
    }
}

impl EditNodeRequest<Qemu> {
    /// Creates a request to edit a node of type [`NodeType::Qemu`].
    pub fn qemu(node: &Node) -> Result<Self> {
        Self::from_node(node)
    }

    /// Number of configured CPUs on the node.
    pub fn cpu(mut self, cpu: u32) -> Self {
        self.params.cpu = cpu;
        self
    }

    /// Flag to indicate CPU limit status.
    pub fn cpulimit(mut self, cpulimit: u8) -> Self {
        self.params.cpulimit = cpulimit;
        self
    }

    /// Number of configured Ethernet interfaces.
    pub fn ethernet(mut self, ethernet: u32) -> Self {
        self.params.ethernet = ethernet;
        self
    }

    /// Image used to boot the node.
    pub fn image(mut self, image: impl Into<String>) -> Self {
        self.params.image = image.into();
        self
    }

    /// RAM configured on the node, in megabytes.
    pub fn ram(mut self, ram: u32) -> Self {
        self.params.ram = ram;
        self
    }

    /// QEMU version used to boot the node.
    pub fn qemu_version(mut self, qemu_version: impl Into<String>) -> Self {
        self.params.qemu_version = qemu_version.into();
        self
    }

    /// QEMU target architecture used to boot the node.
    pub fn qemu_arch(mut self, qemu_arch: impl Into<String>) -> Self {
        self.params.qemu_arch = qemu_arch.into();
        self
    }

    /// QEMU NIC model used for the interfaces of the node.
    pub fn qemu_nic(mut self, qemu_nic: impl Into<String>) -> Self {
        self.params.qemu_nic = qemu_nic.into();
        self
    }

    /// Custom options passed to QEMU to boot the node.
    pub fn qemu_options(mut self, qemu_options: impl Into<String>) -> Self {
        self.params.qemu_options = qemu_options.into();
        self
    }

    /// UUID configured for the node.
    pub fn uuid(mut self, uuid: impl Into<String>) -> Self {
        self.params.uuid = uuid.into();
        self
    }
}

impl EditNodeRequest<Vpcs> {
    /// Creates a request to edit a node of type [`NodeType::Vpcs`].
    pub fn vpcs(node: &Node) -> Result<Self> {
        Self::from_node(node)
    }
}