Networks

1. Introduction

Networks, in general, are the core of connectivity between computers/devices across the internet using IP addresses provided by Internet Service Providers (ISPs). In ZEDEDA, the network is all about how the EVE-OS configuration manages to get the IP Address to the edge node. It could be through the DHCP network, static network, proxy configuration, etc.
 
  • DHCP–The Dynamic Host Configuration Protocol (DHCP) is a networking protocol where a server dynamically assigns an IP address and other parameters for network configuration to devices on a network to enable communication with other devices on the same or other IP networks.
  • Static–A static IP address always remains the same. If a web server, FTP server, or any other internet resource must have an address that cannot change, you can get a static IP address from your ISP.
  • Proxy–It’s an intermediary server separating end users from the websites they browse. Proxy servers provide varying functionality, security, and privacy depending on your use case, needs, or company policy.
 
A quick overview of How to Add a Network to ZedControl.
 
Let's get familiar with the navigation of the Network screen before getting into the operational details.
 

1.1. List View

After you log in to ZedControl:
  • Step 1 > Click on the 'Library' (Library_icon.png) icon from the left navigation. You will automatically land on the Networks tab.
  • Step 2 > Click on the expand (Expand_Panel_icon.png) icon to view the summary panel.
 
ENET_2_Screen_1.png
 
Summary Panel shows the total number of Networks based on 'Network Classification Distribution,' 'Network Proxy Distribution,' and 'Network Kind Distribution' widgets in donut and horizontal bar charts. You can hover around these donuts to get the number in each distribution.
 
Note: The Networks list view shows (Default_indicator.png) indicator on the default Network.
 

1.2. Detail View

  • Step 1 > Click on one of the Networks in the list view to show the detailed view of the same.
 
ENET_2_Screen_2.png
 
  • Step 2 > A temporary tab () is created, navigating you to the detailed view of the selected Network.
 
ENET_2_Screen_3.png
 
The detail view has tertiary navigation with the Basic info tab.
 

2. Operations Using ZedUI

The following are the Network operations:
 

2.1. Create

You can perform create operations in the Networks list view only. After you log in to ZedControl, create a Network using the following steps:
  • Step 1 > Click on the Add (Add_icon.png) icon
 
ENET_2_Screen_4.png
 
  • Step 2 > Populate the input field values for the Identity section, as instructed in the table.
  • Step 3 > You can click on the 'Default Enterprise Network' checkbox if you want this Network to default.
Note: You get a notification saying 'You are about to override the existing default network <network name>' if there is a default network already present.
 
ENET_2_Screen_5.png
 

Identity section

Define the basic identification details of the Network.
 
Input Field Value
Name(*) This is unique across the enterprise and cannot be changed.
Title(*) This is user-defined and can be changed.
Project(*) This is a logical construct that allows you to manage a group of edge nodes as one logical entity. You can create a new project to onboard an edge node. Click here to know more about managing a project.
Description A detailed explanation of what the Network is used for. Not mandatory.
Default Enterprise Network
To make the Network default, you can check this checkbox.
 
  • Step 4 > Populate the input field values for the 'Details' section, as instructed in the table.
  • Step 5 > Select the network's kind by clicking 'Kind,' as instructed in the table.
  • Step 6 > Select the type of DHCP service by clicking 'DHCP,' as instructed in the table.
 
ENET_2_Screen_6.png
 

Details section

Define the details of the Network.
 
Input Field Value
Kind(*)
Select one of the Networks from the following dropdown list:
  • IPv4–32-bit binary number, separated by periods.
  • IPv6–128-bit binary number, separated by colons.
Once you choose the Network, the DHCP field appears
DHCP(*)
Select one of the Networks from the following dropdown list:
  • Manual
  • PassThrough
  • Client
When you select 'Manual' from the dropdown, the DHCP fields appear as follows.
Subnet Enter the subnet.
Gateway Enter the Gateway IP Address.
Domain Enter the Domain name.
NTP Server Enter the NTP Server IP Address.
DNS Enter the DNS IP Address.
IP Address Range Enter the range of the IP Addresses you might need.
 
  • Step 7 > You can click on the 'Add Wireless Config' checkbox to add either a Wi-Fi or Cellular configuration for the Network which you are creating. Details are as instructed in the table.
 
ENET_2_Screen_7.png
Table for configuration using the 'Add Wireless Config' option when you choose 'Wifi.'
 
Input Field Value
SSID(*) A sequence of characters that uniquely names a wireless local area network (WLAN).
Key Management Scheme(*)
Allow for a separate authentication process to enable the distribution of keys. There are two main phases to this process:
  • Master key establishment
  • Key exchange
Username Provide username.
Password(*) Provide password.
Priority Ranging from 0 to 7. The default value is 0, indicating no priority is set. A greater value indicates a higher priority.

You can choose the 'Cellular' option and the 'Send GPS Data' checkbox to send the GPS coordinates.

ENET_2_Screen_7a.png
Table for configuration using the 'Wireless Config' option when you choose 'Cellular.'
 
Input Field Value
APN(*) A mobile phone setting that the phone's carrier uses to connect to the gateway between the carrier's network and the internet.
 
  • Step 8 > You can click on the 'Add Proxy' checkbox to add a proxy for the Network you are creating.
  • Step 8a > You can choose the 'Type' of the proxy from the dropdown list, as shown.
 
ENET_2_Screen_8.png
 
  • Step 9 > Click on the 'Manual' option. Details are as instructed in the table.
 
ENET_2_Screen_8a.png
 
Table for configuration using the 'Add Proxy' option when you choose 'Manual.'
 
Input Field Value
HTTP and Port
Add HTTP hostname and non-zero port number.
HTTPS and Port
Add HTTPS hostname and non-zero port number.
SOCKS and Port Add SOCKS hostname and non-zero port number.
FTP and Port Add FTP hostname and non-zero port number.
Proxy Exceptions The list to access the URL, Host, or IP directly and not forward the proxy configured request.
 
You can choose the following 'Add Proxy' dropdown options as well:
  • Auto Proxy Discovery–A web proxy server is identified by the system and used to send requests on behalf of the client.
  • PAC File–Proxy Auto-Config (PAC) file is located automatically by the Web Proxy Auto-Discovery (WPAD) protocol.
  • Transparent–In this option, the user can set up a network with a proxy by only putting in one or a collection of certificates.
  • URL–The user provides the URL of the network proxy.
 
Table for configuration using the 'Add Proxy' option when you choose 'URL.'
 
Input Field Value
Network Proxy URL This means entering the proxy server to read data or make changes to the settings.
 
Proxy Certificates–This is used to describe a certificate derived from, and signed by, a normal X. 509 Public Key End Entity Certificate or by another Proxy Certificate to provide restricted proxying and delegation within a PKI based authentication system.
  • Step 10 > Click on the 'Add' button.
 
ENET_2_Screen_8b.png
 
  • Step 11 > When you click on the 'Add' button, a toast message appears as shown below:
Network: Test-Network has been added.
 
ENET_2_Screen_9.png
 
  • Step 12 > You can see that the new Network is added in the Network list view, as shown.
 
The Network is created successfully!
 

2.2. Read

You can perform the read operation in the Network's detail view only. After you log in to ZedControl, click on the 'Library' menu from the left navigation and select 'Networks' to go to the list of already available Networks. Click on any of the Networks in the list view to show the detailed view of the same.
 
ENET_2_Screen_10.png
 
The read view shows the 'Basic Info' section.
 

Basic Info

a) Identity

For information on the field values and their descriptions, refer to the tables under the create operation.
 

b) Details

For information on the field values and their descriptions, refer to the tables under the create operation.
 

2.3. Update (Edit)

You can perform the update/edit operation in the Network's detail view only. After you log in to ZedControl, click on the 'Library' menu from the left navigation and select 'Networks' to go to the list of already available Networks. Click on any of the Networks in the list view to show the detailed view of the same.
 
The update/edit view shows only the 'Basic Info' section.
 

Basic Info

Update/edit a Network using the following steps:
  • Step 1 > Click on the Edit () icon.
 
The 'Basic Info' section allows you to update/edit most of the fields. For information on the editable field values and their descriptions, refer to the tables under the create operation.
 
ENET_2_Screen_11.png
 
  • Step 2 > Update the editable fields of 'Identity' section. For information on the editable field values and their descriptions, refer to the tables under the create operation.
  • Step 3 > Update the editable fields of 'Details' section. For information on the editable field values and their descriptions, refer to the tables under the create operation.
  • Step 4 > Click on 'Submit' button.
 
ENET_2_Screen_12.png
 
  • Step 5 > When you click on the 'Submit' button, a toast message announcing the successful submission of the Network appears below:
Network: defaultIP4-net has been updated
 
ENET_2_Screen_13.png
 
The Network is updated successfully!
 

2.4. Delete

You can perform the delete operation in both the Networks list view and detail view. After you log in to ZedControl, if you no longer require the Network, you could delete it using the following steps:
Note: You can perform the delete operation on a single Network or multiple Networks on either the list view or detail view screen. We will follow the multiple Networks workflow, which you can carry out from the list view.
 
  • Step 1 > Click on the checkboxes of the Networks list on which the required delete needs to be performed.
  • Step 2 > Click on the More (More_icon.png) icon on the top right corner.
  • Step 3 > From the dropdown, select 'Delete'.
 
ENET_2_Screen_14.png
 
  • Step 4 > Click the 'Confirm' button on the modal dialogue, which appears as below:
Deleting these 3 Network(s) will permanently remove the data about these network(s) from management platform. One of the Network selected is default.
Note: There is no way to reclaim the data, after the delete operation is performed.
 
 
  • Step 5 > When you click on the 'Confirm' button, a toast message announcing the Network's delete request's successful submission appears.
3 Networks were successfully deleted.
 
 
The selected Networks are deleted successfully!
 

3. Operations Using zCLI

To login to ZedControl through zCLI, see here.
 

3.1. Create

You can create a Network using the following command:
zcli> zcli network create <name> --project=<project> --kind=[Portv4|Portv6] --dhcp=[client|server|static|passthrough] [--wifi-config=<file-path> | --cellular-config=<APN>] [--static-dns=<hostname:ip>...] [--subnet=<subnet-id>] [--gateway=<gateway>] [--domain=<domain>] [--nameserver=<dns>...] [--dhcp-range=<range>] [--title=title] [--description=<description>] [--proxy-network=on|off | --proxy-pacfile=<pacfilepath> | --proxy-static=<filepath> | --proxy-url=<pacfileurl>] [--proxy-certificate=<proxy-certificate>...]
 

3.2. Read (Show)

You can use the following command to see the created Network details:
zcli> zcli network show [[[<name> | --uuid=<uuid>] [--detail]] | [[--project=<project>] [--name-pattern=<name-pattern>]]]
 
For example, the show command for a Network displays the following output:
zcli> zcli network show
Network Project Description Kind Type
----------------------- ------------ ------------ -------------- ---------------
defaultIPv4-net NETWORK_KIND_V4 NETWORK_WIRELESS_TYPE_UNSPECIFIED
static_network default-project NETWORK_KIND_V4 NETWORK_WIRELESS_TYPE_UNSPECIFIED
wifi_network default-project NETWORK_KIND_V4 NETWORK_WIRELESS_TYPE_WIFI
switchnet default-project NETWORK_KIND_V6 NETWORK_WIRELESS_TYPE_UNSPECIFIED
static1 default-project NETWORK_KIND_V4 NETWORK_WIRELESS_TYPE_UNSPECIFIED
defaultNetwork default-project NETWORK_KIND_V4 NETWORK_WIRELESS_TYPE_UNSPECIFIED
zcli>
 

3.3. Update (Edit)

You can update a Network using the following command:
zcli> zcli network update <name> [--title=title] [--description=<description>] [--wifi-config=<file-path> | --cellular-config=<APN>] [--disable-proxy=[true|false] | --proxy-network=[on|off] | --proxy-pacfile=<pacfilepath> | --proxy-static=<filepath> | --proxy-url=<pacfileurl>] [--proxy-certificate=<proxy-certificate>...]
 

3.4. Delete

You can delete a Network using the following command:
zcli> zcli network delete <name> [-f]
 
Note: -f is to forcefully make the delete request to the ZedControl, without prompting the user.
 
The Network operations are successfully executed!
Was this article helpful?
1 out of 1 found this helpful

Articles in this section