Files
nebula/testdata/ssh_commands.golden
Matt RichardsonandClaude Fable 5.1 0f767ce529 Add a local control socket and nebula ctl (#1975)
Add support for accessing the previously ssh-only debug commands via
`nebula ctl <command>.`

- unix socket (named pipe on windows) for communication
- sockets scoped to the user + an optional group
- in cmd/nebula and cmd/nebula-service, but not nebula.Main

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
2026-10-21 11:16:00 -04:00

141 lines
3.2 KiB
Plaintext

change-remote
short: Changes the remote address used in the tunnel for the provided vpn addr
help:
flags:
-address string
The new remote address, ip:port
-json
outputs as json
-pretty
pretty prints json, assumes -json
close-tunnel
short: Closes a tunnel for the provided vpn addr
help:
flags:
-local-only
Disables notifying the remote that the tunnel is shutting down
-json
outputs as json
-pretty
pretty prints json, assumes -json
create-tunnel
short: Creates a tunnel for the provided vpn address
help: The lighthouses will be queried for real addresses but you can provide one as well.
flags:
-address string
Optionally provide a real remote address, ip:port
-json
outputs as json
-pretty
pretty prints json, assumes -json
device-info
short: Prints information about the network device.
help:
flags:
-json
outputs as json
-pretty
pretty prints json, assumes -json
help
short: prints available commands or help <command> for specific usage info
help:
flags:
-json
outputs as json
-pretty
pretty prints json, assumes -json
list-hostmap
short: List all known previously connected hosts
help:
flags:
-by-index
gets all hosts in the hostmap from the index table
-json
outputs as json
-pretty
pretty prints json, assumes -json
list-lighthouse-addrmap
short: List all lighthouse map entries
help:
flags:
-json
outputs as json
-pretty
pretty prints json, assumes -json
list-pending-hostmap
short: List all handshaking hosts
help:
flags:
-by-index
gets all hosts in the hostmap from the index table
-json
outputs as json
-pretty
pretty prints json, assumes -json
log-format
short: Gets or sets the current log format
help:
flags:
-json
outputs as json
-pretty
pretty prints json, assumes -json
log-level
short: Gets or sets the current log level
help:
flags:
-json
outputs as json
-pretty
pretty prints json, assumes -json
print-cert
short: Prints the current certificate being used or the certificate for the provided vpn addr
help:
flags:
-raw
prints the PEM encoded certificate; with -json, an object holding it
-json
outputs as json
-pretty
pretty prints json, assumes -json
print-relays
short: Prints json details about all relay info
help:
flags:
-json
outputs as json
-pretty
pretty prints json, assumes -json
print-tunnel
short: Prints json details about a tunnel for the provided vpn addr
help:
flags:
-json
outputs as json
-pretty
pretty prints json, assumes -json
query-lighthouse
short: Query the lighthouses for the provided vpn address
help: This command is asynchronous. Only currently known udp addresses will be printed.
flags:
-json
outputs as json
-pretty
pretty prints json, assumes -json
reload
short: Reloads configuration from disk, same as sending HUP to the process
help:
flags:
-json
outputs as json
-pretty
pretty prints json, assumes -json
version
short: Prints the currently running version of nebula
help:
flags:
-json
outputs as json
-pretty
pretty prints json, assumes -json