zcli network commands with syntax and examples for each operation. If you want to manage the virtual networks that application instances connect to, use the zcli network-instance command instead, which is documented on a separate page.
Before You Start
- ZCLI is installed and authenticated against your enterprise. See Get Started.
- You have the SysManager or SysAdmin role in your enterprise. See Manage Roles.
- For GUI-based network management, see Networks Overview, Create a Network, and Manage a Network.
Manage Networks
Create a network
Create a node network in a project. The--project and --dhcp flags are required. The network name must be unique across the enterprise and cannot be changed after creation. If you omit --title, ZCLI uses the name as the title.
--dhcp flag selects how the port obtains its IP configuration. Each mode accepts a different set of IP options.
The following flags are the ones you are most likely to need. For the full list, run
zcli network --help.
If you pass
--proxy-certificate without a proxy option or --transparent-proxy, ZCLI returns the error Proxy mode (network | static | pacfile | URL) must be specified.
The --wifi-config and --cellular-config options are mutually exclusive. Pass a file path to either one to create a WiFi or cellular network instead of an Ethernet network. The settings these files carry (SSID, key management, priority, and password for WiFi; APN, authentication, and connectivity probing for cellular) are described on Create a Network.
Example (DHCP client network):
View a network
Query a single network by name or UUID, or list the networks in your enterprise. Add--detail to a single-network query to show the full configuration. Use --name-pattern to match all networks whose name contains a substring, --project to list the networks in one project, and --summary to print counts by kind, proxy, and distribution instead of the full list.
--page-size flag changes how many records each API call returns while ZCLI builds the full list. It does not change the output; it only reduces the chance of a timeout on large enterprises.
Update a network
Change the title, description, wireless configuration, proxy settings, MTU, or NTP settings of an existing network. You cannot change the network name, kind, or DHCP mode after creation; to change those, create a new network. Pass--disable-proxy=true to remove the proxy configuration from a network. If you run the command with no options, ZCLI reports Nothing to update.
Delete a network
Delete a network you no longer need. Without the-f flag, ZCLI asks you to confirm the deletion.
-f flag deletes the network without a confirmation prompt.
Next Steps
Networks Overview
How node networks, ports, and addressing modes fit together.
Create a Network
Create Ethernet, WiFi, and cellular networks in the Edge Intelligence Platform Console.
Manage a Network
GUI-based network management.
Overview
All ZCLI command procedures, organized by resource type.