Skip to content

Commit b7d73eb

Browse files
marciocloudflareOxyjun
marciocloudflare
and
Oxyjun
authored
[MWAN Conn] Serial console (#20001)
* added dhcp info bootstrap serial * added activation language * added content * indent * refined steps and code * refined text * added changelog * corrected date * Update src/content/partials/magic-wan/connector/configure-connectors.mdx Co-authored-by: Jun Lee <[email protected]> * Update src/content/partials/magic-wan/connector/configure-connectors.mdx Co-authored-by: Jun Lee <[email protected]> * Update src/content/partials/magic-wan/connector/configure-connectors.mdx Co-authored-by: Jun Lee <[email protected]> --------- Co-authored-by: Jun Lee <[email protected]>
1 parent b18543b commit b7d73eb

File tree

2 files changed

+148
-8
lines changed

2 files changed

+148
-8
lines changed

‎src/content/partials/magic-wan/connector/configure-connectors.mdx‎

Lines changed: 144 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -76,10 +76,36 @@ You cannot enable high availability for an existing Connector on-ramp. To add hi
7676

7777
## DHCP vs static IP connections
7878

79-
{props.productName} uses a DHCP connection at first boot to download your settings and go through the activation process. However, if you need to use a static IP in your {props.productName}, and this is a fresh install:
80-
1. Connect {props.productNameType} to a DHCP port with access to the Internet.
81-
2. Go through the [setup flow](#set-up-cloudflare-dashboard) below and activate your Connector.
82-
3. Refer to [WAN with a static IP address](#wan-with-a-static-ip-address).
79+
{ props.magicWord === "hardware" && (
80+
<>
81+
<p>At first boot, Magic WAN Connector needs to reach out to Cloudflare to download your settings and go through the activation process. If any of the networks plugged into your Connector are DHCP enabled, does not use a VLAN, and have an Internet connection, that process is handled automatically. However, if all of the networks require more information to utilize, (such as a network with static IPs, or tagged VLAN networks) your Magic WAN Connector might need some more information to proceed. There are couple of ways to provide that information. Choose the one that fits your workflow: </p>
82+
83+
<AnchorHeading title="Option one - Activate on a DHCP Network" depth={3} />
84+
<ol>
85+
<li>Connect Magic WAN Connector to a DHCP port with access to the Internet.</li>
86+
<li>Go through the <a href="#set-up-cloudflare-dashboard">setup flow</a> below and activate your Connector.</li>
87+
<li>Refer to <a href="#wan-with-a-static-ip-address">WAN with a static IP address</a>.</li>
88+
</ol>
89+
90+
<AnchorHeading title="Option two - Bootstrap via Serial Console" depth={3} />
91+
<p>Refer to the <a href="#bootstrap-via-serial-console"> Bootstrap workflow</a>.</p>
92+
93+
</>
94+
)
95+
}
96+
97+
{ props.magicWord === "virtual" && (
98+
<>
99+
<p>Virtual Connector uses a DHCP connection at first boot to download your settings and go through the activation process. However, if you need to use a static IP in your Virtual Connector, and this is a fresh install:</p>
100+
<ol>
101+
<li>Connect the machine with your Virtual Connector VM to a DHCP port with access to the Internet.</li>
102+
<li>Go through the <a href="#set-up-cloudflare-dashboard">setup flow</a> below and activate your Connector.</li>
103+
<li>Refer to <a href="#wan-with-a-static-ip-address">WAN with a static IP address</a>.</li>
104+
</ol>
105+
</>
106+
)
107+
}
108+
83109

84110
---
85111

@@ -371,11 +397,25 @@ After finishing your Connector configuration, you need to add it to a site. <Ren
371397

372398
{props.shippedLanguage}, and will only establish a connection to the Cloudflare network when it is activated. Cloudflare recommends leaving it deactivated until you finish [setting it up in the dashboard](#1-add-a-connector-on-ramp).
373399

374-
When the Connector is first activated, one of the ports must be connected to the Internet through a device that supports DHCP. This is required so that the Connector can reach the Cloudflare global network and download the required configurations that you [set up](#1-add-a-connector-on-ramp).
400+
{ props.magicWord === "hardware" && (
401+
<>
402+
<p>When the Connector is first activated, you need to have Internet connection. If you chose to set up your Connector with DHCP you will need to have one of the Connector ports connected to the Internet through a device that supports DHCP. This is required so that the Connector can reach the Cloudflare global network and download the required configurations that you <a href="#1-add-a-connector-on-ramp">set up</a>.</p>
403+
<p> If you set up your Connector with a static IP through the bootstrap method, you do not need a DHCP port. Refer to <a href="#dhcp-vs-static-ip-connections"> DHCP vs static IP connections</a> for more information.</p>
375404

376-
:::caution
377-
Remember to connect Magic WAN Connector through a route that supports DHCP for its first connection to the Internet. Otherwise, the Connector will not work.
378-
:::
405+
<Aside type="caution">Remember that if you chose the DHCP method you have to connect Magic WAN Connector through a route that supports DHCP for its first connection to the Internet. Otherwise, the Connector will not work.</Aside>
406+
</>
407+
)
408+
}
409+
410+
{ props.magicWord === "virtual" && (
411+
<>
412+
<p>When the Connector is first activated, one of the ports must be connected to the Internet through a device that supports DHCP. This is required so that the Connector can reach the Cloudflare global network and download the required configurations that you <a href="#1-add-a-connector-on-ramp">set up</a>.</p>
413+
414+
<Aside type="caution">Remember to connect Magic WAN Connector through a route that supports DHCP for its first connection to the Internet. Otherwise, the Connector will not work.</Aside>
415+
416+
</>
417+
)
418+
}
379419

380420
When you are ready to connect your Magic WAN Connector to the Cloudflare network:
381421

@@ -446,6 +486,102 @@ When you are ready to connect your Magic WAN Connector to the Cloudflare network
446486
)
447487
}
448488

489+
{ props.magicWord === "hardware" && (
490+
<>
491+
<AnchorHeading title="Bootstrap via Serial Console" depth={2} />
492+
<p>Advanced users can locally configure their Magic WAN Connector to work in a static IP configuration. This local method does not require having access to a DHCP Internet connection. However, it does require being comfortable with using tools to access the serial port on Magic WAN Connector as well as using a serial terminal client to access the Connector's environment.</p>
493+
<p>Below is a detailed description of how to use the serial port to configure your Magic WAN Connector locally.</p>
494+
495+
<AnchorHeading title="Equipment required" depth={3} />
496+
<p>To access the serial port on Magic WAN Connector you will need the following equipment:</p>
497+
<ul>
498+
<li>The Magic WAN Connector appliance</li>
499+
<li>A Phillips-head screwdriver</li>
500+
<li>A micro-USB to USB-A cable (there should be one included in the packaging of your Connector)</li>
501+
<li>A computer with an available USB port</li>
502+
<li>A serial terminal client</li>
503+
<li>Optional: if needed, a USB-A to USB-C converter dongle if your computer requires it</li>
504+
</ul>
505+
506+
<AnchorHeading title="1. Access Magic WAN Connector's serial port" depth={3} />
507+
<ol>
508+
<li>Using the Phillips screwdriver, loosen the screw covering the serial console panel on the back of the Magic WAN Connector and turn the panel out of the way.
509+
<ol>
510+
<li>Pictures and more instructions can be found on <a href="https://www.dell.com/support/kbdoc/en-us/000134440/how-to-access-console-port-of-dell-emc-networking-virtual-edge-platform-1405-series" target="_blank" rel="noopener noreferrer">Dell's Technical Documents</a>.</li>
511+
</ol>
512+
</li>
513+
<li>Connect your computer to the Magic WAN Connector using the USB cable.</li>
514+
</ol>
515+
516+
<AnchorHeading title="Default password to access Connector" depth={4} />
517+
<p>Your Connector's default password is the serial number (also known as a Service Tag for Dell devices), all uppercase followed by an "!" (for example, <code>A1B2C3D!</code>)</p>
518+
519+
<AnchorHeading title="2. Install a serial terminal client" depth={3} />
520+
<p>To access Magic WAN Connector's environment you need a serial terminal client. Follow the instructions below to install one, based on your operating system.</p>
521+
522+
<AnchorHeading title="Windows" depth={4} />
523+
<p>Cloudflare recommends using PuTTY for Windows. Download PuTTY from the <a href="https://www.putty.org/" target="_blank" rel="noopener noreferrer">official website</a> and then install it.</p>
524+
<ol>
525+
<li>Check the COM port of the USB to UART device in the Windows Device Manager. It should show up as something similar to <code>Silicon Labs CP210x USB to UART Bridge (COMX)</code>.</li>
526+
<li>Take note of the value in the parentheses (COMX).
527+
<ol>
528+
<li>Refer to the <a href="https://infohub.delltechnologies.com/l/virtual-edge-platform-vep-1405-series-diag-os-and-tools-release-notes/bios-installation-and-configuration" target="_blank" rel="noopener noreferrer">Dell Documentation Page</a> for more details on creating a serial console connection.</li>
529+
</ol>
530+
</li>
531+
<li>Launch PuTTY.</li>
532+
<li>Under <strong>Category</strong>, make sure that <strong>Session</strong> (the first item) is selected.</li>
533+
<li>Under <strong>Connection type</strong>, select <strong>Serial</strong>.</li>
534+
<li>In the <strong>Serial Line</strong>, type in the COM port found in step 2 (for example, <code>COM1</code>).</li>
535+
<li>In the <strong>Speed</strong>, enter <code>115200</code>.</li>
536+
<li>Select <strong>Open</strong> on the bottom of the dialog box. A terminal window should pop up.</li>
537+
<li>The screen may need to be manually refreshed when a new device is connected. You can do that by pressing <code>CTRL + C</code>.</li>
538+
</ol>
539+
540+
<AnchorHeading title="macOS" depth={4} />
541+
<p>Cloudflare recommends installing Screen for macOS. You can install Screen via <code>brew install screen</code>. If you do not have <code>brew</code> installed, follow the instructions on <a href="https://brew.sh/" target="_blank" rel="noopener noreferrer">Brew's Official Website</a> to install it.</p>
542+
<ol>
543+
<li>Open the macOS Terminal.</li>
544+
<li>Run <code>ls /dev/cu.*</code> to list the connected serial devices.</li>
545+
<li>The command should return an output similar to <code>/dev/cu.usbserial-0001</code>. Copy this output to the clipboard or note this down somewhere else.</li>
546+
<li>Run <code>sudo screen -adRUS {`<`}PATH_FROM_STEP_3{`>`} 115200</code>.</li>
547+
<li>The screen may need to be manually refreshed when a new device is connected. You can do that by pressing <code>CMD + C</code>.</li>
548+
</ol>
549+
550+
<AnchorHeading title="Linux" depth={4} />
551+
<p>Cloudflare recommends installing Screen for Linux. You can install Screen via your package manager of choice. For example, for Debian/Ubuntu, install by running <code>sudo apt update && sudo apt install screen</code></p>
552+
553+
<ol>
554+
<li>Open Terminal.</li>
555+
<li>List the connected serial devices by running <code>ls /dev/serial/by-id/*</code>.</li>
556+
<li>The command should return an output similar to <code>/dev/serial/by-id/usb-Silicon_Labs_CP2102_USB_to_UART_Bridge_Controller_0001-if00-port0</code>. Copy this to the clipboard or note this down.</li>
557+
<li>Run <code>sudo screen -adRUS {`<`}THE PATH FROM STEP 3{`>`}; 115200</code>.</li>
558+
<li>The screen may need to be manually refreshed when a new device is connected. You can do that by pressing <code>CTRL + C</code>.</li>
559+
</ol>
560+
561+
<AnchorHeading title="3. Configure a static IP on Magic WAN Connector" depth={3} />
562+
<ol>
563+
<li>Log into the Connector.
564+
<ol>
565+
<li>You will be prompted to change your password if you attempt to log in with the default password.</li>
566+
</ol>
567+
</li>
568+
<li>From the menu, go to <strong>Bootstrap</strong> with the arrow keys and select it with the Enter key.</li>
569+
<li>Select the Jack (physical port) you want to configure for the initialization of the connector.</li>
570+
<li>Enter the VLAN tag (if applicable) of the network. Leave it blank if untagged.</li>
571+
<li>Select whether the network is DHCP or static.</li>
572+
573+
<Aside>The main reason to use the bootstrapper is if every network the Connector is plugged into is either static, behind a VLAN, or both. If you find yourself here and configuring a network with DHCP and no VLAN, you are probably not in the right place. See the section on configuring your Connector <a href="#set-up-cloudflare-dashboard">via the dashboard</a>.</Aside>
574+
575+
576+
<li>Enter the IP address you would like the connector to have in CIDR form (for example, <code>10.0.0.2/24</code>).</li>
577+
<li>Enter the IP address of the Internet gateway (this must be in the same subnet as the previous IP address you entered and must not be the same address).</li>
578+
<li>Select <strong>Save</strong> and confirm that you want to use the new settings.</li>
579+
<li>The Connector will download the rest of the settings from Cloudflare. The last heartbeat of the Connector should update once it has made contact with Cloudflare.</li>
580+
</ol>
581+
</>
582+
)
583+
}
584+
449585
---
450586

451587
## About high availability configurations

‎src/content/release-notes/magic-wan.yaml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ productLink: "/magic-wan/"
55
productArea: Cloudflare One
66
productAreaLink: /cloudflare-one/changelog/
77
entries:
8+
- publish_date: "2025-02-14"
9+
title: Local console access for bootstrapping Magic WAN Connector
10+
description: |-
11+
Magic WAN Connector can now be configured to connect to the Cloudflare network via a static IP assignment through local console.
812
- publish_date: "2024-12-12"
913
title: LAN Policy improvements for the Magic WAN Connector
1014
description: |-

0 commit comments

Comments
 (0)