Skip to main content

How to create an Edge router

When to use​

When networks need a router with traffic filtering and address translation: traffic flows between networks in a VDC (virtual data center), and some services are published externally at a different address. This procedure takes you from selecting networks and slots to checking that the ports are up.

This procedure does not apply if the router already exists and you only need to add a port; see port management. The firewall and NAT rule sets on a new Edge are empty; configure them using the separate procedure.

Prerequisites​

  • Cluster-level privileges (the Cluster master role) or VDC administrator rights. A shared Edge requires administrator rights in the VDC selected in the creation form;
  • The networks to which the ports will connect are available to the user; availability is checked against VDC assignments;
  • Free slots: an Edge can have no more than four ports, and the slot number cannot exceed 4;
  • vStack Center version 3.0.4.

The Edge privileges for a role are grouped on the role screen: in the sidebar tree, open Provider Data Center → Users & Roles, select the role, and go to the Edge group.

Steps​

  1. Open the VDC router list. In the sidebar tree, expand Virtual Data Centers, select the VDC, and go to its Edges section. The screen title is Edges, with an Actions button next to it.

  2. In the Actions menu, select Create an Edge to open the creation form with the same title.

  3. Check the VDC field. When you open the form from a VDC, this field is already filled in: the router will be shared by that VDC. The Vdc not selected value is available on the All Edges screen and creates a personal router; its owner determines access to it.

  4. Fill in the first port row:

    Form fieldRequiredWhat it specifies
    NameYesNetwork to which the port connects. The selected network's CIDR is shown below the field
    SlotYesSlot number, 1–4. Occupied slots are not offered in the list
    MBps limitNoPort bandwidth limit in Mbps. An empty field means no limit
    IPNoPort IPv4 address. If the field is empty, an address is allocated from the network pool
    IP guardNoIP guard toggle. Enabled by default

    Select a network for each port: a row without a network cannot be saved.

    The form has no IPv6 field. If the network has an IPv6 subnet, the port address is allocated from it automatically; up to eight IPv6 addresses per port can be assigned manually only through the API. The methods are listed at the end of this page.

  5. Add the remaining ports with Add network, one row per slot, up to four. The button disappears when no free slots remain.

  6. Click Create an Edge. The panel displays "Edge is creating...", then "Edge successfully created", and opens the new router's page. You do not need to start it separately: after creating the VM, vStack Center registers Edge and starts the machine.

    Operation progress is shown in the log panel; open it with the LOG button in the bottom panel.

Verify the result​

Open the router page and check three places.

  • Next to UUID, check State. For a newly created router, it shows a running machine.
  • The General properties section contains the Changed, Ports, Rules applied, State modified, and VDC pairs. Only the Cluster master role can see the VM field; it is absent for other roles. This is expected and does not indicate an error.
  • The Networks section contains a port table with the ID, Name, Slot, Port, MAC, IP, IP guard, and MBps limit columns. Each port has a network and a slot, and its address is either assigned manually or allocated from the network pool.

An empty IP column means that no IPv4 address is assigned to the port.

The Port column contains the port identifier. Firewall and NAT rules are bound to ports: in the rule form, select the port by network name in the Network field.

Troubleshooting​

The panel displays failures as notifications with text and a code, for example network_ports exceed 4 (error code: -15003).

FailureCauseResolution
-15003 network_ports exceed 4The form contains more than four ports, exceeding the Edge limitKeep no more than four port rows. Split networks that exceed the limit between two routers
-15004 slot exceeds 4The slot number is greater than 4Select a slot from the Slot field list: it contains only free values from 1–4
-15005 Need at least vDC Admin role to create EdgeInsufficient rights to create a routerObtain VDC administrator rights or create the router with the Cluster master role. Without these rights, Create an Edge does not appear in the Actions menu
-15006 Network N not available for this userThe network is not assigned to a VDC in which you have rightsSelect a network from the Name field list; it shows only available networks. If the required network is missing, request its assignment to the VDC
-15007 Slot without network_idA slot is selected in the port row, but no network is selectedFill in the Name field in every port row
-15008 Need vDC Admin role for shared EdgeA shared Edge requires the VDC administrator roleCreate a personal router (Vdc not selected) or obtain VDC administrator rights
-15009 Need vDC Admin at vdc_id=NThe selected VDC is one in which you do not have administrator rightsIn the VDC field, select a VDC where you have rights, or create a personal router with Vdc not selected
-15010Database error on the dispatcher sideRetry creation; if the failure recurs, check the cluster database state
-15011 vms-create relay failedThe VM creation request did not reach the cluster agentCheck that the cluster agents are reachable and retry creation. No partial record remains: Edge appears in the list only after the VM is successfully created

If the operation takes a long time to complete, see Asynchronous operation remains pending.

See also​

API methods​

The API operations covered on this page are edge-create, edge-get, and edge-list; see the API reference.