mirror of
https://github.com/gravitl/netmaker.git
synced 2024-09-22 00:06:04 +08:00
36 lines
3.5 KiB
Plaintext
36 lines
3.5 KiB
Plaintext
NAME:
|
|
netclient join - Join a Netmaker network.
|
|
|
|
USAGE:
|
|
netclient join [command options] [arguments...]
|
|
|
|
OPTIONS:
|
|
--network value, -n value Network to perform specified action against. (default: "all") [$NETCLIENT_NETWORK]
|
|
--password value, -p value Password for authenticating with netmaker. (default: "badpassword") [$NETCLIENT_PASSWORD]
|
|
--endpoint value, -e value Reachable (usually public) address for WireGuard (not the private WG address). [$NETCLIENT_ENDPOINT]
|
|
--macaddress value, -m value Mac Address for this machine. Used as a unique identifier within Netmaker network. [$NETCLIENT_MACADDRESS]
|
|
--publickey value, --pubkey value Public Key for WireGuard Interface. [$NETCLIENT_PUBLICKEY]
|
|
--privatekey value, --privkey value Private Key for WireGuard Interface. [$NETCLIENT_PRIVATEKEY]
|
|
--port value Port for WireGuard Interface. [$NETCLIENT_PORT]
|
|
--keepalive value Default PersistentKeepAlive for Peers in WireGuard Interface. (default: 0) [$NETCLIENT_KEEPALIVE]
|
|
--operatingsystem value, --os value Identifiable name for machine within Netmaker network. [$NETCLIENT_OS]
|
|
--name value Identifiable name for machine within Netmaker network. [$NETCLIENT_NAME]
|
|
--localaddress value Local address for machine. Can be used in place of Endpoint for machines on the same LAN. [$NETCLIENT_LOCALADDRESS]
|
|
--address value, -a value WireGuard address for machine within Netmaker network. [$NETCLIENT_ADDRESS]
|
|
--addressIPv6 value, --a6 value WireGuard address for machine within Netmaker network. [$NETCLIENT_ADDRESSIPV6]
|
|
--interface value, -i value WireGuard local network interface name. [$NETCLIENT_INTERFACE]
|
|
--apiserver value Address + GRPC Port (e.g. 1.2.3.4:50051) of Netmaker server. [$NETCLIENT_API_SERVER]
|
|
--grpcserver value Address + API Port (e.g. 1.2.3.4:8081) of Netmaker server. [$NETCLIENT_GRPC_SERVER]
|
|
--key value, -k value Access Key for signing up machine with Netmaker server during initial 'add'. [$NETCLIENT_ACCESSKEY]
|
|
--token value, -t value Access Token for signing up machine with Netmaker server during initial 'add'. [$NETCLIENT_ACCESSTOKEN]
|
|
--localrange value Local Range if network is local, for instance 192.168.1.0/24. [$NETCLIENT_LOCALRANGE]
|
|
--dns value Sets private dns if 'on'. Ignores if 'off'. Will retrieve from network if unset. [$NETCLIENT_DNS]
|
|
--islocal value Sets endpoint to local address if 'yes'. Ignores if 'no'. Will retrieve from network if unset. [$NETCLIENT_IS_LOCAL]
|
|
--isdualstack value Sets ipv6 address if 'yes'. Ignores if 'no'. Will retrieve from network if unset. [$NETCLIENT_IS_DUALSTACK]
|
|
--ipforwarding value Sets ip forwarding on if 'on'. Ignores if 'off'. On by default. (default: "on") [$NETCLIENT_IPFORWARDING]
|
|
--postup value Sets PostUp command for WireGuard. [$NETCLIENT_POSTUP]
|
|
--postdown value Sets PostDown command for WireGuard. [$NETCLIENT_POSTDOWN]
|
|
--daemon value Installs daemon if 'on'. Ignores if 'off'. On by default. (default: "on") [$NETCLIENT_DAEMON]
|
|
--roaming value Checks for IP changes if 'on'. Ignores if 'off'. On by default. (default: "on") [$NETCLIENT_ROAMING]
|
|
--help, -h show help (default: false)
|