ssh_commands.golden 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160
  1. change-remote
  2. short: Changes the remote address used in the tunnel for the provided vpn addr
  3. help:
  4. flags:
  5. -address string
  6. The new remote address, ip:port
  7. -json
  8. outputs as json
  9. -pretty
  10. pretty prints json, assumes -json
  11. close-tunnel
  12. short: Closes a tunnel for the provided vpn addr
  13. help:
  14. flags:
  15. -local-only
  16. Disables notifying the remote that the tunnel is shutting down
  17. -json
  18. outputs as json
  19. -pretty
  20. pretty prints json, assumes -json
  21. create-tunnel
  22. short: Creates a tunnel for the provided vpn address
  23. help: The lighthouses will be queried for real addresses but you can provide one as well.
  24. flags:
  25. -address string
  26. Optionally provide a real remote address, ip:port
  27. -json
  28. outputs as json
  29. -pretty
  30. pretty prints json, assumes -json
  31. device-info
  32. short: Prints information about the network device.
  33. help:
  34. flags:
  35. -json
  36. outputs as json
  37. -pretty
  38. pretty prints json, assumes -json
  39. help
  40. short: prints available commands or help <command> for specific usage info
  41. help:
  42. flags:
  43. -json
  44. outputs as json
  45. -pretty
  46. pretty prints json, assumes -json
  47. identity
  48. short: Prints the certificate identity of the host owning the provided vpn addr
  49. help: Identity is what the certificate says: name, vpn addrs, networks, groups, fingerprint, issuer and validity. The address may carry a port, so a connection's remote address can be passed through as is. For this node's own identity use whoami.
  50. flags:
  51. -address string
  52. The vpn addr to look up, optionally with a port
  53. -json
  54. outputs as json
  55. -pretty
  56. pretty prints json, assumes -json
  57. list-hostmap
  58. short: List all known previously connected hosts
  59. help:
  60. flags:
  61. -by-index
  62. gets all hosts in the hostmap from the index table
  63. -json
  64. outputs as json
  65. -pretty
  66. pretty prints json, assumes -json
  67. list-lighthouse-addrmap
  68. short: List all lighthouse map entries
  69. help:
  70. flags:
  71. -json
  72. outputs as json
  73. -pretty
  74. pretty prints json, assumes -json
  75. list-pending-hostmap
  76. short: List all handshaking hosts
  77. help:
  78. flags:
  79. -by-index
  80. gets all hosts in the hostmap from the index table
  81. -json
  82. outputs as json
  83. -pretty
  84. pretty prints json, assumes -json
  85. log-format
  86. short: Gets or sets the current log format
  87. help:
  88. flags:
  89. -json
  90. outputs as json
  91. -pretty
  92. pretty prints json, assumes -json
  93. log-level
  94. short: Gets or sets the current log level
  95. help:
  96. flags:
  97. -json
  98. outputs as json
  99. -pretty
  100. pretty prints json, assumes -json
  101. print-cert
  102. short: Prints the current certificate being used or the certificate for the provided vpn addr
  103. help: The vpn addr is an operand or -address, which may carry a port so a connection's remote address can be passed through as is. For a peer it is the certificate nebula verified when the tunnel came up; with no address it is this node's own, the v2 certificate when both versions are loaded. -raw prints the PEM.
  104. flags:
  105. -address string
  106. The vpn addr to look up, optionally with a port
  107. -raw
  108. prints the PEM encoded certificate; with -json, an object holding it
  109. -json
  110. outputs as json
  111. -pretty
  112. pretty prints json, assumes -json
  113. print-relays
  114. short: Prints json details about all relay info
  115. help:
  116. flags:
  117. -json
  118. outputs as json
  119. -pretty
  120. pretty prints json, assumes -json
  121. print-tunnel
  122. short: Prints json details about a tunnel for the provided vpn addr
  123. help:
  124. flags:
  125. -json
  126. outputs as json
  127. -pretty
  128. pretty prints json, assumes -json
  129. query-lighthouse
  130. short: Query the lighthouses for the provided vpn address
  131. help: This command is asynchronous. Only currently known udp addresses will be printed.
  132. flags:
  133. -json
  134. outputs as json
  135. -pretty
  136. pretty prints json, assumes -json
  137. reload
  138. short: Reloads configuration from disk, same as sending HUP to the process
  139. help:
  140. flags:
  141. -json
  142. outputs as json
  143. -pretty
  144. pretty prints json, assumes -json
  145. version
  146. short: Prints the currently running version of nebula
  147. help:
  148. flags:
  149. -json
  150. outputs as json
  151. -pretty
  152. pretty prints json, assumes -json
  153. whoami
  154. short: Prints the certificate identity of this node
  155. help: The fields identity prints, read from this node's own certificate.
  156. flags:
  157. -json
  158. outputs as json
  159. -pretty
  160. pretty prints json, assumes -json