diff --git a/dev/404.html b/dev/404.html index 0c1ec1df..4684968c 100644 --- a/dev/404.html +++ b/dev/404.html @@ -799,9 +799,22 @@ -
  • - + + + + + + + +
  • + + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/dev/boot/index.html b/dev/boot/index.html index 11e54f94..95d2d815 100644 --- a/dev/boot/index.html +++ b/dev/boot/index.html @@ -1007,9 +1007,22 @@ -
  • - + + + + + + + +
  • + + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/dev/branding/index.html b/dev/branding/index.html index 2636ffac..c610f84a 100644 --- a/dev/branding/index.html +++ b/dev/branding/index.html @@ -810,9 +810,22 @@ -
  • - + + + + + + + +
  • + + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/dev/cli/configure/index.html b/dev/cli/configure/index.html index e9d164eb..353eff70 100644 --- a/dev/cli/configure/index.html +++ b/dev/cli/configure/index.html @@ -917,9 +917,22 @@ -
  • - + + + + + + + +
  • + + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/dev/cli/introduction/index.html b/dev/cli/introduction/index.html index 2bf44dc5..d053eb71 100644 --- a/dev/cli/introduction/index.html +++ b/dev/cli/introduction/index.html @@ -881,9 +881,22 @@ -
  • - + + + + + + + +
  • + + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/dev/cli/keybindings/index.html b/dev/cli/keybindings/index.html index 5ade46d2..a0f2b998 100644 --- a/dev/cli/keybindings/index.html +++ b/dev/cli/keybindings/index.html @@ -863,9 +863,22 @@ -
  • - + + + + + + + +
  • + + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/dev/cli/netcalc/index.html b/dev/cli/netcalc/index.html index 725fd663..01aa08e0 100644 --- a/dev/cli/netcalc/index.html +++ b/dev/cli/netcalc/index.html @@ -872,9 +872,22 @@ -
  • - + + + + + + + +
  • + + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/dev/cli/quick/index.html b/dev/cli/quick/index.html index fff7cd0e..28c5c1b1 100644 --- a/dev/cli/quick/index.html +++ b/dev/cli/quick/index.html @@ -822,9 +822,22 @@ -
  • - + + + + + + + +
  • + + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/dev/cli/tcpdump/index.html b/dev/cli/tcpdump/index.html index 4f50c867..8b923859 100644 --- a/dev/cli/tcpdump/index.html +++ b/dev/cli/tcpdump/index.html @@ -872,9 +872,22 @@ -
  • - + + + + + + + +
  • + + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/dev/cli/text-editor/index.html b/dev/cli/text-editor/index.html index a1407ab5..080a7b1b 100644 --- a/dev/cli/text-editor/index.html +++ b/dev/cli/text-editor/index.html @@ -896,9 +896,22 @@ -
  • - + + + + + + + +
  • + + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/dev/cli/upgrade/index.html b/dev/cli/upgrade/index.html index 689ca36a..7676a911 100644 --- a/dev/cli/upgrade/index.html +++ b/dev/cli/upgrade/index.html @@ -822,9 +822,22 @@ -
  • - + + + + + + + +
  • + + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/dev/container/index.html b/dev/container/index.html index fbb2a550..100ec442 100644 --- a/dev/container/index.html +++ b/dev/container/index.html @@ -1094,9 +1094,22 @@ -
  • - + + + + + + + +
  • + + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/dev/developers-guide/index.html b/dev/developers-guide/index.html index 51ff6cf2..43e34762 100644 --- a/dev/developers-guide/index.html +++ b/dev/developers-guide/index.html @@ -810,9 +810,22 @@ -
  • - + + + + + + + +
  • + + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/dev/dhcp/index.html b/dev/dhcp/index.html index 76bec0a8..87db4de7 100644 --- a/dev/dhcp/index.html +++ b/dev/dhcp/index.html @@ -899,9 +899,22 @@ -
  • - + + + + + + + +
  • + + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/dev/discovery/index.html b/dev/discovery/index.html index c098cb7b..eaafc452 100644 --- a/dev/discovery/index.html +++ b/dev/discovery/index.html @@ -938,9 +938,22 @@ -
  • - + + + + + + + +
  • + + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/dev/eth-counters/index.html b/dev/eth-counters/index.html index 497d20d6..a75be2ae 100644 --- a/dev/eth-counters/index.html +++ b/dev/eth-counters/index.html @@ -812,9 +812,22 @@ -
  • - + + + + + + + +
  • + + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/dev/hardware/index.html b/dev/hardware/index.html index dc0fb8d5..ecb22d15 100644 --- a/dev/hardware/index.html +++ b/dev/hardware/index.html @@ -896,9 +896,22 @@ -
  • - + + + + + + + +
  • + + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/dev/index.html b/dev/index.html index 899c9eca..84fb5762 100644 --- a/dev/index.html +++ b/dev/index.html @@ -811,9 +811,22 @@ -
  • - + + + + + + + +
  • + + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/dev/introduction/index.html b/dev/introduction/index.html index b43c9540..4f36f9ca 100644 --- a/dev/introduction/index.html +++ b/dev/introduction/index.html @@ -894,9 +894,22 @@ -
  • - + + + + + + + +
  • + + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/dev/license/index.html b/dev/license/index.html index f618acd8..efab5985 100644 --- a/dev/license/index.html +++ b/dev/license/index.html @@ -820,9 +820,22 @@ -
  • - + + + + + + + +
  • + + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/dev/management/index.html b/dev/management/index.html index 279a3e61..d2cd9415 100644 --- a/dev/management/index.html +++ b/dev/management/index.html @@ -936,9 +936,22 @@ -
  • - + + + + + + + +
  • + + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/dev/netboot/index.html b/dev/netboot/index.html index 8081fcae..a92fd581 100644 --- a/dev/netboot/index.html +++ b/dev/netboot/index.html @@ -810,9 +810,22 @@ -
  • - + + + + + + + +
  • + + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/dev/networking/index.html b/dev/networking/index.html index 86690860..6b408aa7 100644 --- a/dev/networking/index.html +++ b/dev/networking/index.html @@ -1377,9 +1377,22 @@ -
  • - + + + + + + + +
  • + + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/dev/override-package/index.html b/dev/override-package/index.html index e2838530..ff97a82c 100644 --- a/dev/override-package/index.html +++ b/dev/override-package/index.html @@ -810,9 +810,22 @@ -
  • - + + + + + + + +
  • + + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/dev/qos/index.html b/dev/qos/index.html index 65927a71..a9740930 100644 --- a/dev/qos/index.html +++ b/dev/qos/index.html @@ -812,9 +812,22 @@ -
  • - + + + + + + + +
  • + + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/dev/scripting-prod/index.html b/dev/scripting-prod/index.html new file mode 100644 index 00000000..d028d772 --- /dev/null +++ b/dev/scripting-prod/index.html @@ -0,0 +1,1879 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + Production Testing - User's Guide + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + + + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + + + + + + +

    Scripting for Production Tests

    +

    This document shows how to set up and remotely script devices with a +focus on production testing.

    +

    VLAN Snake

    +

    As part of production tests, verification of Ethernet ports is usually +expected. A common way for devices with multiple bridged Ethernet ports +is to connect a test PC to two ports and send a ping traversing all +ports. This can be achieved by using VLANs, on the switch, as described +in this section. The resulting configuration file can be applied to the +running configuration of the produced unit, e.g, use config file restore +as described previously.

    +

    In this example we assume a 10 port switch, with ports e1-e10. The +following VLAN configuration and cable connections will be used:

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    VLAN & PortsConnect
    VLAN 10: e1 & e2e2 <=> e3
    VLAN 20: e3 & e4e4 <=> e5
    VLAN 30: e5 & e6e6 <=> e7
    VLAN 40: e7 & e8e8 <=> e9
    VLAN 50: e9 & e10
    +

    The test PC is connected to e1 and e10 via different interfaces +(alternatively, two different PCs are used).

    +
    +

    Tip

    +

    Configuration here is done via console. When configuring remotely +over SSH, remember to keep one IP address (the one used for the SSH +connection)! I.e., set a static IP address first, then perform the +VLAN configuration step.

    +
    +

    Configuration at Start

    +

    Starting out, we assume a configuration where all ports are network +interfaces (possibly with IPv6 enabled).

    +
    admin@example:/> show interfaces
+lo              ethernet   UP          00:00:00:00:00:00
+                ipv4                   127.0.0.1/8 (static)
+                ipv6                   ::1/128 (static)
+e1              ethernet   LOWER-DOWN  00:53:00:06:11:01
+e2              ethernet   LOWER-DOWN  00:53:00:06:11:02
+e3              ethernet   LOWER-DOWN  00:53:00:06:11:03
+e4              ethernet   LOWER-DOWN  00:53:00:06:11:04
+e5              ethernet   LOWER-DOWN  00:53:00:06:11:05
+e6              ethernet   LOWER-DOWN  00:53:00:06:11:06
+e7              ethernet   LOWER-DOWN  00:53:00:06:11:07
+e8              ethernet   LOWER-DOWN  00:53:00:06:11:08
+e9              ethernet   LOWER-DOWN  00:53:00:06:11:09
+e10             ethernet   UP          00:53:00:06:11:0a
+                ipv6                   fe80::0053:00ff:fe06:110a/64 (link-layer)
+admin@example:/>
+
    +

    Creating Bridge and Adding Ports

    +

    The following example creates a bridge and adds all Ethernet ports +to it. On a device with layer-2 offloading (switch fabric), this sets +all ports in the same VLAN. The next section sets up VLAN isolation.

    +
    admin@example:/> configure
+admin@example:/config/> edit interface br0
+admin@example:/config/interface/br0/> end
+admin@example:/config/> set interface e1 bridge-port bridge br0
+admin@example:/config/> set interface e2 bridge-port bridge br0
+admin@example:/config/> set interface e3 bridge-port bridge br0
+admin@example:/config/> set interface e4 bridge-port bridge br0
+admin@example:/config/> set interface e5 bridge-port bridge br0
+admin@example:/config/> set interface e6 bridge-port bridge br0
+admin@example:/config/> set interface e7 bridge-port bridge br0
+admin@example:/config/> set interface e8 bridge-port bridge br0
+admin@example:/config/> set interface e9 bridge-port bridge br0
+admin@example:/config/> set interface e10 bridge-port bridge br0
+admin@example:/config/>
+
    +

    The interface status can be viewed using show interfaces after leaving +configuration context. When configuring via SSH, first assign an IP +address to br0 before leaving configuration context, e.g.

    +
    admin@example:/config/> set interface br0 ipv6 enabled
+
    +

    This enables IPv6 SLAAC, auto-configured address. Or skip leave and +stay in configuration context until you have completed all the device +setup, including setting IP address.

    +
    admin@example:/config/> leave
+admin@example:/>
+admin@example:/> show interfaces
+INTERFACE       PROTOCOL   STATE       DATA
+br0             bridge
+│               ethernet   UP          00:53:00:06:11:01
+├ e1            bridge     LOWER-DOWN
+├ e2            bridge     LOWER-DOWN
+├ e3            bridge     LOWER-DOWN
+├ e4            bridge     LOWER-DOWN
+├ e5            bridge     LOWER-DOWN
+├ e6            bridge     LOWER-DOWN
+├ e7            bridge     LOWER-DOWN
+├ e8            bridge     LOWER-DOWN
+├ e9            bridge     LOWER-DOWN
+â”” e10           bridge     FORWARDING
+lo              ethernet   UP          00:00:00:00:00:00
+                ipv4                   127.0.0.1/8 (static)
+                ipv6                   ::1/128 (static)
+admin@example:/>
+
    +

    Assign VLANs to Ports

    +

    Now, configure VLANs as outlined previously: default VID +for ingress (PVID), which is done per port, and egress mode (untagged), +which is done at the bridge level. See the VLAN bridges section for +more information.

    +
    admin@example:/>
+admin@example:/> configure
+admin@example:/config/> set interface e1 bridge-port pvid 10
+admin@example:/config/> set interface e2 bridge-port pvid 10
+admin@example:/config/> set interface e3 bridge-port pvid 20
+admin@example:/config/> set interface e4 bridge-port pvid 20
+admin@example:/config/> set interface e5 bridge-port pvid 30
+admin@example:/config/> set interface e6 bridge-port pvid 30
+admin@example:/config/> set interface e7 bridge-port pvid 40
+admin@example:/config/> set interface e8 bridge-port pvid 40
+admin@example:/config/> set interface e9 bridge-port pvid 50
+admin@example:/config/> set interface e10 bridge-port pvid 50
+admin@example:/config/> edit interface br0
+admin@example:/config/interface/br0/> edit bridge vlans
+admin@example:/config/interface/br0/bridge/vlans/> set vlan 10 untagged e1
+admin@example:/config/interface/br0/bridge/vlans/> set vlan 10 untagged e2
+admin@example:/config/interface/br0/bridge/vlans/> set vlan 20 untagged e3
+admin@example:/config/interface/br0/bridge/vlans/> set vlan 20 untagged e4
+admin@example:/config/interface/br0/bridge/vlans/> set vlan 30 untagged e5
+admin@example:/config/interface/br0/bridge/vlans/> set vlan 30 untagged e6
+admin@example:/config/interface/br0/bridge/vlans/> set vlan 40 untagged e7
+admin@example:/config/interface/br0/bridge/vlans/> set vlan 40 untagged e8
+admin@example:/config/interface/br0/bridge/vlans/> set vlan 50 untagged e9
+admin@example:/config/interface/br0/bridge/vlans/> set vlan 50 untagged e10
+admin@example:/config/interface/br0/bridge/vlans/> leave
+admin@example:/>
+
    +

    Interface status would now should something like the following

    +
    admin@example:/> show interfaces
+INTERFACE       PROTOCOL   STATE       DATA
+br0             bridge
+│               ethernet   UP          00:53:00:06:11:01
+├ e1            bridge     LOWER-DOWN  vlan:10u pvid:10
+├ e2            bridge     LOWER-DOWN  vlan:10u pvid:10
+├ e3            bridge     LOWER-DOWN  vlan:20u pvid:20
+├ e4            bridge     LOWER-DOWN  vlan:20u pvid:20
+├ e5            bridge     LOWER-DOWN  vlan:30u pvid:30
+├ e6            bridge     LOWER-DOWN  vlan:30u pvid:30
+├ e7            bridge     LOWER-DOWN  vlan:40u pvid:40
+├ e8            bridge     LOWER-DOWN  vlan:40u pvid:40
+├ e9            bridge     LOWER-DOWN  vlan:50u pvid:50
+â”” e10           bridge     FORWARDING  vlan:50u pvid:50
+lo              ethernet   UP          00:00:00:00:00:00
+                ipv4                   127.0.0.1/8 (static)
+                ipv6                   ::1/128 (static)
+admin@example:/>
+
    +

    Connect Cables and Test

    +

    We can now connect the PC to e1 and e10, while the other ports are +patched according to above. We should see link up and +FORWARDING on all ports in the bridge.

    +
    admin@example:/> show interfaces
+INTERFACE       PROTOCOL   STATE       DATA
+br0             bridge
+│               ethernet   UP          00:53:00:06:11:01
+├ e1            bridge     FORWARDING  vlan:10u pvid:10
+├ e2            bridge     FORWARDING  vlan:10u pvid:10
+├ e3            bridge     FORWARDING  vlan:20u pvid:20
+├ e4            bridge     FORWARDING  vlan:20u pvid:20
+├ e5            bridge     FORWARDING  vlan:30u pvid:30
+├ e6            bridge     FORWARDING  vlan:30u pvid:30
+├ e7            bridge     FORWARDING  vlan:40u pvid:40
+├ e8            bridge     FORWARDING  vlan:40u pvid:40
+├ e9            bridge     FORWARDING  vlan:50u pvid:50
+â”” e10           bridge     FORWARDING  vlan:50u pvid:50
+lo              ethernet   UP          00:00:00:00:00:00
+                ipv4                   127.0.0.1/8 (static)
+                ipv6                   ::1/128 (static)
+admin@example:/>
+
    +

    Here we use IPv6 ping all hosts (ff02::1) on PC interface eth1 to +check reachability to the other interface of the PC.

    +
    +

    Tip

    +

    We recommend using network namespaces (Linux only) on the PC to ensure +that traffic is actually sent out to the switch, rather than being +looped back internally. Alternatively, use two separate PCs.

    +
    +
    ~ $ ping -L ff02::1%eth1
+PING ff02::1%eth1(ff02::1%eth1) 56 data bytes
+64 bytes from fe80::488a:a35f:9d41:ac9c%eth1: icmp_seq=1 ttl=64 time=0.496 ms
+64 bytes from fe80::488a:a35f:9d41:ac9c%eth1: icmp_seq=2 ttl=64 time=0.514 ms
+64 bytes from fe80::488a:a35f:9d41:ac9c%eth1: icmp_seq=3 ttl=64 time=0.473 ms
+64 bytes from fe80::488a:a35f:9d41:ac9c%eth1: icmp_seq=4 ttl=64 time=0.736 ms
+64 bytes from fe80::488a:a35f:9d41:ac9c%eth1: icmp_seq=5 ttl=64 time=0.563 ms
+64 bytes from fe80::488a:a35f:9d41:ac9c%eth1: icmp_seq=6 ttl=64 time=0.507 ms
+^C
+--- ff02::1%eth1 ping statistics ---
+6 packets transmitted, 6 received, 0% packet loss, time 5108ms
+rtt min/avg/max/mdev = 0.473/0.548/0.736/0.088 ms
+~ $
+
    +

    We can verify that traffic goes through the switch by disconnecting +one of the patch cables, e.g., between e4 and e5

    +
    ~ $ ping -L ff02::1%eth1
+PING ff02::1%eth1(ff02::1%eth1) 56 data bytes
+64 bytes from fe80::488a:a35f:9d41:ac9c%eth1: icmp_seq=1 ttl=64 time=0.510 ms
+64 bytes from fe80::488a:a35f:9d41:ac9c%eth1: icmp_seq=2 ttl=64 time=0.448 ms
+64 bytes from fe80::488a:a35f:9d41:ac9c%eth1: icmp_seq=3 ttl=64 time=0.583 ms
+64 bytes from fe80::488a:a35f:9d41:ac9c%eth1: icmp_seq=4 ttl=64 time=0.515 ms
+64 bytes from fe80::488a:a35f:9d41:ac9c%eth1: icmp_seq=5 ttl=64 time=0.521 ms
+64 bytes from fe80::488a:a35f:9d41:ac9c%eth1: icmp_seq=6 ttl=64 time=0.495 ms
+64 bytes from fe80::488a:a35f:9d41:ac9c%eth1: icmp_seq=7 ttl=64 time=0.743 ms
+... Disconnecting patch cable, thus losing packets
+... and reconnecting again. Connectivity resumes.
+64 bytes from fe80::488a:a35f:9d41:ac9c%eth1: icmp_seq=16 ttl=64 time=0.961 ms
+64 bytes from fe80::488a:a35f:9d41:ac9c%eth1: icmp_seq=17 ttl=64 time=0.513 ms
+64 bytes from fe80::488a:a35f:9d41:ac9c%eth1: icmp_seq=18 ttl=64 time=0.794 ms
+64 bytes from fe80::488a:a35f:9d41:ac9c%eth1: icmp_seq=19 ttl=64 time=0.755 ms
+64 bytes from fe80::488a:a35f:9d41:ac9c%eth1: icmp_seq=20 ttl=64 time=0.779 ms
+^C
+--- ff02::1%eth1 ping statistics ---
+20 packets transmitted, 12 received, 40% packet loss, time 19432ms
+rtt min/avg/max/mdev = 0.448/0.634/0.961/0.156 ms
+~ $
+
    +

    Set IP Address

    +

    The configuration so far does not provide a means to connect to the +switch management via SSH or NETCONF, as the switch has no IP address. +The example below shows how to add the switch to VLAN 10 (as used for +ports e1 and e2) and enables IPv6.

    +
    admin@example:/config/> edit interface vlan10
+admin@example:/config/interface/vlan10/> set vlan lower-layer-if br0
+admin@example:/config/interface/vlan10/> set ipv6 enabled
+admin@example:/config/interface/vlan10/> show
+type vlan;
+ipv6 {
+  enabled true;
+}
+vlan {
+  tag-type c-vlan;
+  id 10;
+  lower-layer-if br0;
+}
+admin@example:/config/interface/vlan10/>
+admin@example:/config/interface/vlan10/> end
+admin@example:/config/> edit interface br0 bridge vlans
+admin@example:/config/interface/br0/bridge/vlans/> set vlan 10 tagged br0
+admin@example:/config/interface/br0/bridge/vlans/> leave
+admin@example:/>
+
    +

    Interface vlan10 with an auto-configured IPv6 address should appear.

    +
    admin@example:/> show interfaces
+INTERFACE       PROTOCOL   STATE       DATA
+br0             bridge                 vlan:10t
+│               ethernet   UP          00:53:00:06:11:01
+├ e1            bridge     FORWARDING  vlan:10u pvid:10
+├ e2            bridge     FORWARDING  vlan:10u pvid:10
+├ e3            bridge     FORWARDING  vlan:20u pvid:20
+├ e4            bridge     FORWARDING  vlan:20u pvid:20
+├ e5            bridge     FORWARDING  vlan:30u pvid:30
+├ e6            bridge     FORWARDING  vlan:30u pvid:30
+├ e7            bridge     FORWARDING  vlan:40u pvid:40
+├ e8            bridge     FORWARDING  vlan:40u pvid:40
+├ e9            bridge     FORWARDING  vlan:50u pvid:50
+â”” e10           bridge     FORWARDING  vlan:50u pvid:50
+lo              ethernet   UP          00:00:00:00:00:00
+                ipv4                   127.0.0.1/8 (static)
+                ipv6                   ::1/128 (static)
+vlan10          ethernet   UP          00:53:00:06:11:01
+│               ipv6                   fe80::0053:00ff:fe06:1101/64 (link-layer)
+â”” br0           ethernet   UP          00:53:00:06:11:01
+admin@example:/>
+
    +

    When pinging "IPv6 all hosts" from the PC, there should be two +responses for every ping, one from the switch and one from the PC +attached to e10.

    +
    ~ $ ping -L ff02::1%eth1
+PING ff02::1%eth1(ff02::1%eth1) 56 data bytes
+64 bytes from fe80::488a:a35f:9d41:ac9c%eth1: icmp_seq=1 ttl=64 time=0.508 ms
+64 bytes from fe80::0053:00ff:fe06:1101%eth1: icmp_seq=1 ttl=64 time=0.968 ms
+64 bytes from fe80::488a:a35f:9d41:ac9c%eth1: icmp_seq=2 ttl=64 time=0.866 ms
+64 bytes from fe80::0053:00ff:fe06:1101%eth1: icmp_seq=2 ttl=64 time=0.867 ms
+64 bytes from fe80::0053:00ff:fe06:1101%eth1: icmp_seq=3 ttl=64 time=0.467 ms
+64 bytes from fe80::488a:a35f:9d41:ac9c%eth1: icmp_seq=3 ttl=64 time=0.469 ms
+64 bytes from fe80::488a:a35f:9d41:ac9c%eth1: icmp_seq=4 ttl=64 time=0.452 ms
+64 bytes from fe80::0053:00ff:fe06:1101%eth1: icmp_seq=4 ttl=64 time=0.453 ms
+^C
+--- ff02::1%eth1 ping statistics ---
+4 packets transmitted, 4 received, +4 duplicates, 0% packet loss, time 3031ms
+rtt min/avg/max/mdev = 0.452/0.631/0.968/0.211 ms
+~ $
+
    +

    It should now be possible to access the switch from the PC via SSH (or NETCONF).

    +
    ~ $ ssh admin@fe80::0053:00ff:fe06:1101%eth1
+admin@fe80::0053:00ff:fe06:1101%eth1's password:
+.-------.
+|  . .  | Infix OS — Immutable.Friendly.Secure
+|-. v .-| https://kernelkit.org
+'-'---'-'
+
+Run the command 'cli' for interactive OAM
+
+admin@example:~$ exit
+~ $
+
    +

    See previous sections on backup and restore of +the created configuration.

    + + + + + + + + + + + + + +
    +
    + + + +
    + +
    + +
    + +
    +
    +
    + +
    + Copyright © 2025 The KernelKit Authors +
    + + +
    + +
    +
    +
    + +
    +
    +
    +
    + + + + + + + + + + + + \ No newline at end of file diff --git a/dev/scripting-restconf/index.html b/dev/scripting-restconf/index.html new file mode 100644 index 00000000..0d5e6c96 --- /dev/null +++ b/dev/scripting-restconf/index.html @@ -0,0 +1,1612 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + Remote RESTCONF - User's Guide + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + + + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + + + + + + +

    Examples using RESTCONF

    +

    Factory Reset

    +
    ~$ curl -kX POST -u admin:admin \
+        -H "Content-Type: application/yang-data+json" \
+        https://example.local/restconf/operations/ietf-factory-default:factory-reset
+curl: (56) OpenSSL SSL_read: error:0A000126:SSL routines::unexpected eof while reading, errno 0
+
    +

    System Reboot

    +
    ~$ curl -kX POST -u admin:admin \
+        -H "Content-Type: application/yang-data+json" \
+        https://example.local/restconf/operations/ietf-system:system-restart
+
    +

    Set Date and Time

    +

    Here's an example of an RPC that takes input/argument:

    +
    ~$ curl -kX POST -u admin:admin \
+        -H "Content-Type: application/yang-data+json" \
+        -d '{"ietf-system:input": {"current-datetime": "2024-04-17T13:48:02-01:00"}}' \
+        https://example.local/restconf/operations/ietf-system:set-current-datetime
+
    +

    You can verify that the changes took by a remote SSH command:

    +
    ~$ ssh admin@example.local 'date'
+Wed Apr 17 14:48:12 UTC 2024
+~$
+
    +

    Read Hostname

    +

    Example of fetching JSON configuration data to stdout:

    +
    ~$ curl -kX GET -u admin:admin \
+        -H 'Accept: application/yang-data+json' \
+        https://example.local/restconf/data/ietf-system:system/hostname
+{
+  "ietf-system:system": {
+    "hostname": "foo"
+  }
+}
+
    +

    Set Hostname

    +

    Example of inline JSON data:

    +
    ~$ curl -kX PATCH -u admin:admin \
+     -H 'Content-Type: application/yang-data+json' \
+     -d '{"ietf-system:system":{"hostname":"bar"}}' \
+     https://example.local/restconf/data/ietf-system:system
+
    +

    Copy Running to Startup

    +

    No copy command available yet to copy between datastores, and the +Rousette back-end also does not support "write-through" to the +startup datastore.

    +

    To save running-config to startup-config, use the following example to +fetch running to a local file and then update startup with it:

    +
    ~$ curl -kX GET -u admin:admin -o running-config.json \
+        -H 'Accept: application/yang-data+json'       \
+         https://example.local/restconf/ds/ietf-datastores:running
+
+~$ curl -kX PUT -u admin:admin -d @running-config.json \
+        -H 'Content-Type: application/yang-data+json'  \
+        https://example.local/restconf/ds/ietf-datastores:startup
+
    + + + + + + + + + + + + + +
    +
    + + + +
    + +
    + +
    + +
    +
    +
    + +
    + Copyright © 2025 The KernelKit Authors +
    + + +
    + +
    +
    +
    + +
    +
    +
    +
    + + + + + + + + + + + + \ No newline at end of file diff --git a/dev/scripting-sysrepocfg/index.html b/dev/scripting-sysrepocfg/index.html new file mode 100644 index 00000000..b4dfda1b --- /dev/null +++ b/dev/scripting-sysrepocfg/index.html @@ -0,0 +1,2017 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + Advanced Usage - User's Guide + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + + + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + + + + + + +

    Examples using SSH and sysrepocfg

    +

    sysrepocfg can be used to interact with the YANG models when logged +in to infix. Thus, set config, read config, read status and RPC +can be conducted using sysrepocfg for supported YANG models. It is +possible to make configuration changes by operating on the startup +database.

    +

    See sysrepocfg for information. Examples below will utilize

    +
      +
    • sysrepocfg -I FILE -fjson -d DATABASE to import/write a JSON + formatted configuration file to the specified database.
      • +
    • sysrepocfg -E FILE -fjson -d DATABASE to edit/merge JSON formatted + configuration in FILE with the specified database.
      • +
    • sysrepocfg -R FILE -fjson to execute remote procedure call (RPC) + defined in FILE (JSON formatted).
      • +
    • sysrepocfg -X -fjson -d DATABASE -x xpath to read configuration or + status from specified database.
      • +
    +

    For importing (-I) and editing (-E), -d running is typically used in +examples below. Specify -d startup to apply changes to startup +configuration. Exporting (-X) could operate on configuration (e.g., +-d running) or status (-d operational).

    +

    Some commands require a file as input. In the examples below we assume +it has been transferred to the device in advance, e.g. using scp:

    +
    ~$ cat file.json
+{
+   "ietf-factory-default:factory-reset": {
+   }
+}
+~$ scp file.json admin@example.local:/tmp/file.json
+~$
+
    +

    Factory Reset

    +
    ~$ cat file.json
+{
+   "ietf-factory-default:factory-reset": {
+   }
+}
+~$ scp file.json admin@example.local:/tmp/file.json
+~$ ssh admin@example.local 'sysrepocfg -fjson -R /tmp/file.json'
+^C
+~$
+
    +

    See Factory Reset for another (simpler) +alternative.

    +

    If it is only wished to copy factory config to running config the +following RPC is available

    +
    ~$ cat file.json
+{
+   "infix-factory-default:factory-default": {
+   }
+}
+~$ scp file.json admin@example.local:/tmp/file.json
+~$ ssh admin@example.local 'sysrepocfg -fjson -R /tmp/file.json'
+^C
+~$
+
    +

    System Reboot

    +
    ~$ cat /tmp/file.json
+{
+   "ietf-system:system-restart": {
+   }
+}
+~$ scp file.json admin@example.local:/tmp/file.json
+~$ ssh admin@example.local 'sysrepocfg -fjson -R /tmp/file.json'
+~$
+
    +

    See System Reboot for another (simpler) +alternative.

    +

    Set Date and Time

    +
    ~$ ssh admin@example.local 'date'
+Sun Nov 20 10:20:23 UTC 2005
+~$ cat file.json
+{
+   "ietf-system:set-current-datetime": {
+      "current-datetime": "2024-04-17T13:48:02-01:00"
+   }
+}
+~$ scp file.json admin@example.local:/tmp/file.json
+~$ ssh admin@example.local 'sysrepocfg -fjson -R /tmp/file.json'
+~$ ssh admin@example.local 'date'
+Wed Apr 17 14:48:12 UTC 2024
+~$
+
    +

    See Set Date and Time for another +(simpler) alternative.

    +

    Remote Control of Ethernet Ports

    +

    Reading administrative status of interface e0 of running configuration.

    +
    ~$ ssh admin@example.local 'sysrepocfg -X -fjson -d running -e report-all \
+       -x \"/ietf-interfaces:interfaces/interface[name='e0']/enabled\"'
+{
+  "ietf-interfaces:interfaces": {
+    "interface": [
+      {
+        "name": "e0",
+        "enabled": true
+      }
+    ]
+  }
+}
+~$
+
    +
    +

    Note

    +

    Without -e report-all argument the line "enabled: true would not +be shown as true is default.

    +
    +
    ~$ ssh admin@example.local "sysrepocfg -X -fjson -d running \
+       -x \"/ietf-interfaces:interfaces/interface[name='e0']/enabled\""
+{
+  "ietf-interfaces:interfaces": {
+    "interface": [
+      {
+        "name": "e0"
+      }
+    ]
+  }
+}
+~$
+
    +

    Setting the administrative status of interface e0 of running configuration.

    +
    $ cat file.json
+{
+  "ietf-interfaces:interfaces": {
+    "interface": [
+      {
+        "name": "e0",
+        "enabled": false
+      }
+    ]
+  }
+}
+~$ scp file.json admin@example.local:/tmp/file.json
+~$ ssh admin@example.local 'sysrepocfg -E /tmp/file.json -fjson -d running'
+~$
+
    +

    Enable/Disable DHCPv4 client

    +

    Enabling DHCPv4 client on interface e0, with current default options.

    +
    ~$ cat /tmp/file.json
+{
+  "infix-dhcp-client:dhcp-client": {
+    "enabled": true,
+    "client-if": [
+      {
+        "if-name": "e0"
+      }
+    ]
+  }
+}
+~$ scp file.json admin@example.local:/tmp/file.json
+~$ ssh admin@example.local 'sysrepocfg -E /tmp/file.json -fjson -d running'
+~$
+
    +

    Disabling DHCPv4 client.

    +
    ~$ cat /tmp/file.json
+{
+  "infix-dhcp-client:dhcp-client": {
+    "enabled": false
+  }
+}
+~$ scp file.json admin@example.local:/tmp/file.json
+~$ ssh admin@example.local 'sysrepocfg -E /tmp/file.json -fjson -d running'
+~$
+
    +

    Configuration for client interface e0 remains, but does not apply as +DHCPv4 is disabled.

    +
    admin@example:~$ sysrepocfg -X -fjson -d running -x "/infix-dhcp-client:dhcp-client"
+{
+  "infix-dhcp-client:dhcp-client": {
+    "enabled": false,
+    "client-if": [
+      {
+        "if-name": "e0"
+      }
+    ]
+  }
+}
+admin@example:~$
+
    +

    To fully remove the DHCPv4 client configuration or a specific +client-if with sysrepocfg, one would need to read out the full +configuration, remove relevant parts and read back.

    +

    Enable/Disable IPv6

    +

    IPv6 is typically enabled on all interfaces by default. The example +below shows IPv4 and IPv6 addresses assigned on e0.

    +
    ~$ ssh admin@example.local 'ip addr show dev e0'
+2: e0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UP group default qlen 1000
+    link/ether 02:00:00:00:00:00 brd ff:ff:ff:ff:ff:ff
+    inet 10.0.2.15/24 scope global proto dhcp e0
+       valid_lft forever preferred_lft forever
+    inet6 fec0::ff:fe00:0/64 scope site dynamic mngtmpaddr proto kernel_ra
+       valid_lft 86380sec preferred_lft 14380sec
+    inet6 fe80::ff:fe00:0/64 scope link proto kernel_ll
+       valid_lft forever preferred_lft forever
+~$
+
    +

    IPv6 is enabled/disabled per interface. The example below disables IPv6 +on interface e0.

    +
    ~$ cat /tmp/file.json
+{
+  "ietf-interfaces:interfaces": {
+    "interface": [
+      {
+        "name": "e0",
+        "ietf-ip:ipv6": {
+          "enabled": false
+        }
+      }
+    ]
+  }
+}
+~$ scp file.json admin@example.local:/tmp/file.json
+~$ ssh admin@example.local 'sysrepocfg -E /tmp/file.json -fjson -d running'
+~$ ssh admin@example.local 'ip addr show dev e0'
+2: e0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UP group default qlen 1000
+    link/ether 02:00:00:00:00:00 brd ff:ff:ff:ff:ff:ff
+    inet 10.0.2.15/24 scope global proto dhcp e0
+       valid_lft forever preferred_lft forever
+~$
+
    +

    Change a Binary Setting

    +

    A YANG binary type setting is Base64 encoded and requires a little bit +more tricks. We take the opportunity to showcase a shell script helper: +/usr/bin/text-editor, which works just like the text-editor command +in the CLI, but this one takes an XPath argument to the binary leaf to +edit.

    +

    Stripped down, it looks something like this:

    +
    if tmp=$(sysrepocfg -G "$xpath"); then
+    file=$(mktemp)
+
+    echo "$tmp" | base64 -d > "$file"
+    if edit "$file"; then
+        tmp=$(base64 -w0 < "$file")
+        sysrepocfg -S "$xpath" -u "$tmp"
+    fi
+
+    rm -f "$file"
+else
+    echo "Failed to retrieve value for $xpath"
+    exit 1
+fi
+
    +

    An example container configuration, with an embedded file that is +mounted to /var/www/index.html can look like this:

    +
      "infix-containers:containers": {
+    "container": [
+      {
+        "name": "web",
+        "image": "oci-archive:/lib/oci/curios-httpd-latest.tar.gz",
+        "hostname": "web",
+        "network": {
+          "interface": [
+            {
+              "name": "veth-sys0"
+            }
+          ]
+        },
+        "mount": [
+          {
+            "name": "index.html",
+            "content": "PCFET0NUWVBFIGh0bWwjibberish.shortened.down==",
+            "target": "/var/www/index.html"
+          }
+        ]
+      }
+    ]
+  }
+
    +

    The command to edit this file, and restart the container with the new +contents, look like this:

    +
    admin@infix:~$ cfg edit "/infix-containers:containers/container[name='web']/mount[name='index.html']/content"
+
    +

    Backup Configuration

    +

    Displaying running or startup configuration is possible with +sysrepocfg -X, as shown below.

    +
    ~$ ssh admin@example.local 'sysrepocfg -X -fjson -d running'
+{
+  "ieee802-dot1ab-lldp:lldp": {
+    "infix-lldp:enabled": true
+...
+~$
+
    +

    An example for backing up startup configuration from remote PC.

    +
    ~$ ssh admin@example.local 'sysrepocfg -X -fjson -d startup > /tmp/backup.json'
+~$ scp admin@example.local:/tmp/backup.json .
+~$
+
    +

    Or possibly skip intermediate storage of file

    +
    ~$ ssh admin@example.local 'sysrepocfg -X -fjson -d startup' > backup.json
+~$
+
    +

    A final example is to only use scp. This is simpler, but only works to +backup the startup configuration (not running).

    +
    ~$ scp admin@example.local:/cfg/startup-config.cfg backup.json
+~$
+
    +

    Restore Configuration

    +

    To restore a backup configuration to startup, the simplest way is to use +scp and reboot as shown below

    +
    ~$ scp admin@example.local:/cfg/startup-config.cfg backup.json
+~$ ssh admin@example.local 'reboot'
+Connection to switch.local closed by remote host.
+~$
+
    +

    An alternative method to restore a backup configuration is to use the +sysrepocfg -I FILE (import) command.

    +

    The example below imports the backup configuration to startup, and +reboots the unit.

    +
    ~$ scp backup.json admin@example.local:/tmp/
+~$ ssh admin@example.local 'sudo sysrepocfg -I /tmp/backup.json -fjson -d startup'
+~$ ssh admin@example.local 'reboot'
+Connection to switch.local closed by remote host.
+~$
+
    +
    +

    Note

    +

    The login credentials (hash) for the admin user are stored as part +of the configuration file. When replacing a switch and applying the +backed up configuration from the former switch, the password on the +replacement unit will also change.

    +
    +

    Copy Running to Startup

    +

    The following command reads out the running config via sysrepocfg -X +and writes the result to the startup configuration.

    +
    ~$ ssh admin@example.local 'sysrepocfg -X -fjson -d running > /cfg/startup-config.cfg'
+~$
+
    +

    An alternative is to write it to a temporary file, and use sysrepocfg +-I to import it to startup.

    +
    ~$ ssh admin@example.local 'sysrepocfg -X -fjson -d running > /tmp/running.json'
+~$ ssh admin@example.local 'sysrepocfg -I /tmp/running.json -fjson -d startup'
+~$
+
    +

    Read Hardware Information

    +

    The IETF Hardware YANG model has been augmented for ONIE formatted +production data stored in EEPROMs, if available. For details, see the +VPD documentation and the ietf-hardware and infix-hardware +YANG models.

    +
    ~$ ssh admin@example.local 'sysrepocfg -X -fjson -d operational -x /ietf-hardware:hardware'
+{
+  "ietf-hardware:hardware": {
+    "component": [
+      {
+        "name": "product",
+        "class": "infix-hardware:vpd",
+        "serial-num": "12345",
+        "model-name": "Switch2010",
+        "mfg-date": "2024-01-30T16:42:37+00:00",
+        "infix-hardware:vpd-data": {
+          "product-name": "Switch2010",
+          "part-number": "ABC123-001",
+          "serial-number": "007",
+          "mac-address": "00:53:00:01:23:45",
+          "manufacture-date": "01/30/2024 16:42:37",
+          "num-macs": 11,
+          "manufacturer": "ACME Production",
+          "vendor": "SanFran Networks"
+        }
+      },
+      {
+        "name": "USB",
+        "class": "infix-hardware:usb",
+        "state": {
+          "admin-state": "unlocked",
+          "oper-state": "enabled"
+        }
+      }
+    ]
+  }
+}
+~$
+
    + + + + + + + + + + + + + +
    +
    + + + +
    + +
    + +
    + +
    +
    +
    + +
    + Copyright © 2025 The KernelKit Authors +
    + + +
    + +
    +
    +
    + +
    +
    +
    +
    + + + + + + + + + + + + \ No newline at end of file diff --git a/dev/scripting/index.html b/dev/scripting/index.html index e04574df..b9af5c27 100644 --- a/dev/scripting/index.html +++ b/dev/scripting/index.html @@ -16,7 +16,7 @@ - + @@ -24,7 +24,7 @@ - Scripting Infix - User's Guide + Introduction - User's Guide @@ -115,7 +115,7 @@
    - Scripting Infix + Introduction
    @@ -814,6 +814,48 @@ + + + + + + + +
  • + + + + + + + + + + +
    • + +
  • Factory Reset @@ -898,8 +972,8 @@
    • - -
  • + +
  • System Reboot @@ -907,8 +981,8 @@
    • - -
  • + +
  • Set Date and Time @@ -916,8 +990,8 @@
    • - -
  • + +
  • Remote Control of Ethernet Ports @@ -925,17 +999,17 @@
    • - -
  • - + +
  • + - Check Device's Network Connectivity + Check Network Connectivity
    • - -
  • + +
  • System Upgrade @@ -943,286 +1017,23 @@
    • - -
  • - + +
  • + - Controlling LEDs for Production Tests + Controlling LEDs -
    • - -
  • - - - Reading Power Feed Status for Production Tests - - - -
    • - - - -
  • - + - Examples using SSH and sysrepocfg + Reading Power Feed Status - - -
    • - -
  • - - - Examples using RESTCONF - - - - - -
    • - -
  • - - - Miscellaneous - - - - -
    • @@ -1240,6 +1051,83 @@ +
  • + + + + + + Advanced Usage + + + + + +
    • + + + + + + + + + + +
  • + + + + + + Remote RESTCONF + + + + + +
    • + + + + + + + + + + +
  • + + + + + + Production Testing + + + + + +
    • + + + + + + + + + + + + + + + + + +
  • @@ -1628,7 +1516,7 @@
  • - Admin User Not Authorized? + Admin User Not Authorized @@ -1645,6 +1533,38 @@ + + +
    • + +
  • Factory Reset @@ -1652,8 +1572,8 @@
    • - -
  • + +
  • System Reboot @@ -1661,8 +1581,8 @@
    • - -
  • + +
  • Set Date and Time @@ -1670,8 +1590,8 @@
    • - -
  • + +
  • Remote Control of Ethernet Ports @@ -1679,17 +1599,17 @@
    • - -
  • - + +
  • + - Check Device's Network Connectivity + Check Network Connectivity
    • - -
  • + +
  • System Upgrade @@ -1697,286 +1617,23 @@
    • - -
  • - + +
  • + - Controlling LEDs for Production Tests + Controlling LEDs -
    • - -
  • - - - Reading Power Feed Status for Production Tests - - - -
    • - - - -
  • - + - Examples using SSH and sysrepocfg + Reading Power Feed Status - - -
    • - -
  • - - - Examples using RESTCONF - - - - - -
    • - -
  • - - - Miscellaneous - - - - -
    • @@ -2009,22 +1666,19 @@ for help on locating it.

    to a remote device over SSH, use Linux/UNIX. With advances lately in both Windows and macOS, many of the user friendly tools previously only available in Linux are now available there too.

    - +

    The shell prompt for the PC laptop side:

    ~$
    - +

    The shell prompt when logged in to an Infix device:

    admin@example:~$
    -
    -

    Note: the shell script commands used here are the raw variants -which the CLI usually wraps in a warm and snugly blanket. Meaning -they may change over time, while the CLI wrappers do not. That -being said, please let us know if you find any inconsistencies.

    -
    +
    +

    Note

    +

    The shell script commands used here are the raw variants which the CLI +usually wraps in a warm and snugly blanket. Meaning they may change +over time, while the CLI wrappers do not. That being said, please +let us know if you find any inconsistencies.

    +

    Tips