Skip to content
Documentation
Open the panel

Command lineCommands

The company VPN of a node

A Linux node connects to a company network over a VPN so its agents reach the servers there, such as a company GitLab. The platform keeps the settings and the passwords, and the node sets up the tunnel itself. The panel does the same on the page of the node.

The node connects to the VPN server by one of three methods. Before you start, ask the VPN provider for the data in the table.

`--method`What to ask the provider forOptions
l2tp-ipsecThe address of the server, the shared key (PSK) and a separate account for the node: a login and a password.--server, --username, --psk-file, --password-file
wireguardA .conf file for the node with one server, that is one [Peer] section.--config
openvpnAn .ovpn file with the certificates and keys inside, and a separate account for the node when the server asks for a login.--config, and with an account --username and --password-file

Do not give the node the account of a person. A VPN server usually holds one connection per account, so the node and a person on a shared account disconnect each other.

1

Step 1: Connect a node to a VPN

--subnet gives a company network and can be repeated. The command reads the passwords from a file or from stdin, and asks in the terminal without them. A later set changes only the settings it names.

$ kcloud nodes vpn set acme-01 --method wireguard --config office.conf --subnet 10.20.0.0/16

Output

Saved the VPN connection of acme-01.

status: waiting for the node
method: wireguard
server: vpn.acme.example:51820
file: office.conf
networks: 10.20.0.0/16
saved: 2026-03-14T09:30:00.000Z

The node sets up the connection with the new settings in a moment.

Only the company networks of the settings go through the tunnel, and the rest of the traffic of the node and its link to the platform go as before. Agents reach only the addresses on the access list of the node, so add the company server there with kcloud nodes network add, as the page A Git server on a company network describes.

2

Step 2: Check the state of the connection

The status line shows the state, and address the address of the node in the company network. --json prints the settings and the state without the passwords.

$ kcloud nodes vpn acme-01

Output

status: connected since 2026-03-14T09:30:00.000Z
method: wireguard
server: vpn.acme.example:51820
file: office.conf
networks: 10.20.0.0/16
address: 10.20.250.14
saved: 2026-03-14T09:30:00.000Z
`status`What it meansWhat to do
waiting for the node (outdated)The node runs a release that does not know the VPN.Update the node.
waiting for the nodeThe node has not taken the new settings yet.Wait a moment.
connecting since <when>The node sets up the tunnel.Wait a moment.
connected since <when>The tunnel works.Nothing, or add the server to the access list of the node.
failed: <reason>, since <when>The VPN server refused the node or does not answer.Do what the last line of the command advises.
unknown (node offline)The node is offline, and last known gives its last report.Check that the node runs and has a network.
vpn: not available (<reason>)This is a Windows node or the node of the platform.Use a Linux node.
`<reason>` of `failed`What it meansWhat to do
the server refused the login or the passwordThe VPN account of the node expired, or someone changed its password.Ask the provider for a new password and set it: kcloud nodes vpn set <node> --password-file <path>.
the server refused the shared keyThe provider changed the shared key of the server.Set the new shared key: kcloud nodes vpn set <node> --psk-file <path>.
the VPN server does not answerThe address of the server is wrong, or a firewall keeps the node out.The node tries again every minute. Check the address with the provider.
the VPN server does not answer or does not know the key of the fileWireGuard got no answer from the server: the address is wrong, or the provider has not registered the key of the file.Check the address and ask the provider to confirm that the key of the file is registered with them.
the server refused the configuration fileThe file is old or was issued for another client.Ask for a new file and set it: kcloud nodes vpn set <node> --config <path>.
the machine of the node does not support the methodThe machine lacks a kernel module or a device the method needs.Install the kernel modules of the machine, such as linux-modules-extra on Ubuntu, and restart the node.
the connection failedAnother error; the detail line gives what the server answered.The node tries again every minute. When the error stays, show the answer of the server to the provider.
3

Step 3: Remove the connection

The node disconnects at once, and the platform deletes the passwords and the file. The access list of the node stays as it is.

$ kcloud nodes vpn remove acme-01 --yes

Output

Removed the VPN connection of acme-01.

vpn: none
acme-01 has no VPN connection; kcloud nodes vpn set acme-01 --method l2tp-ipsec|wireguard|openvpn connects it to a company network.

Matches the panel at cloud.kikimora.dev.