Documentation
¶
Index ¶
- func ToProtoFullStatus(fullStatus peer.FullStatus) *proto.FullStatus
- type IceCandidateType
- type ManagementStateOutput
- type NsServerGroupStateOutput
- type OutputOverview
- type PeerStateDetailOutput
- type PeersStateOutput
- type RelayStateOutput
- type RelayStateOutputDetail
- type SSHServerStateOutput
- type SSHSessionOutput
- type SignalStateOutput
- type SystemEventOutput
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ToProtoFullStatus ¶ added in v0.64.0
func ToProtoFullStatus(fullStatus peer.FullStatus) *proto.FullStatus
Types ¶
type IceCandidateType ¶ added in v0.37.0
type ManagementStateOutput ¶ added in v0.37.0
type NsServerGroupStateOutput ¶ added in v0.37.0
type OutputOverview ¶ added in v0.37.0
type OutputOverview struct {
Peers PeersStateOutput `json:"peers" yaml:"peers"`
CliVersion string `json:"cliVersion" yaml:"cliVersion"`
DaemonVersion string `json:"daemonVersion" yaml:"daemonVersion"`
ManagementState ManagementStateOutput `json:"management" yaml:"management"`
SignalState SignalStateOutput `json:"signal" yaml:"signal"`
Relays RelayStateOutput `json:"relays" yaml:"relays"`
IP string `json:"netbirdIp" yaml:"netbirdIp"`
PubKey string `json:"publicKey" yaml:"publicKey"`
KernelInterface bool `json:"usesKernelInterface" yaml:"usesKernelInterface"`
FQDN string `json:"fqdn" yaml:"fqdn"`
RosenpassEnabled bool `json:"quantumResistance" yaml:"quantumResistance"`
RosenpassPermissive bool `json:"quantumResistancePermissive" yaml:"quantumResistancePermissive"`
Networks []string `json:"networks" yaml:"networks"`
NumberOfForwardingRules int `json:"forwardingRules" yaml:"forwardingRules"`
NSServerGroups []NsServerGroupStateOutput `json:"dnsServers" yaml:"dnsServers"`
Events []SystemEventOutput `json:"events" yaml:"events"`
LazyConnectionEnabled bool `json:"lazyConnectionEnabled" yaml:"lazyConnectionEnabled"`
ProfileName string `json:"profileName" yaml:"profileName"`
SSHServerState SSHServerStateOutput `json:"sshServer" yaml:"sshServer"`
}
func ConvertToStatusOutputOverview ¶ added in v0.37.0
func (*OutputOverview) FullDetailSummary ¶ added in v0.63.0
func (o *OutputOverview) FullDetailSummary() string
FullDetailSummary returns a full detailed summary with peer details and events.
func (*OutputOverview) GeneralSummary ¶ added in v0.63.0
func (o *OutputOverview) GeneralSummary(showURL bool, showRelays bool, showNameServers bool, showSSHSessions bool) string
GeneralSummary returns a general summary of the status overview.
func (*OutputOverview) JSON ¶ added in v0.63.0
func (o *OutputOverview) JSON() (string, error)
JSON returns the status overview as a JSON string.
func (*OutputOverview) YAML ¶ added in v0.63.0
func (o *OutputOverview) YAML() (string, error)
YAML returns the status overview as a YAML string.
type PeerStateDetailOutput ¶ added in v0.37.0
type PeerStateDetailOutput struct {
FQDN string `json:"fqdn" yaml:"fqdn"`
IP string `json:"netbirdIp" yaml:"netbirdIp"`
PubKey string `json:"publicKey" yaml:"publicKey"`
Status string `json:"status" yaml:"status"`
LastStatusUpdate time.Time `json:"lastStatusUpdate" yaml:"lastStatusUpdate"`
ConnType string `json:"connectionType" yaml:"connectionType"`
IceCandidateType IceCandidateType `json:"iceCandidateType" yaml:"iceCandidateType"`
IceCandidateEndpoint IceCandidateType `json:"iceCandidateEndpoint" yaml:"iceCandidateEndpoint"`
RelayAddress string `json:"relayAddress" yaml:"relayAddress"`
LastWireguardHandshake time.Time `json:"lastWireguardHandshake" yaml:"lastWireguardHandshake"`
TransferReceived int64 `json:"transferReceived" yaml:"transferReceived"`
TransferSent int64 `json:"transferSent" yaml:"transferSent"`
Latency time.Duration `json:"latency" yaml:"latency"`
RosenpassEnabled bool `json:"quantumResistance" yaml:"quantumResistance"`
Networks []string `json:"networks" yaml:"networks"`
}
type PeersStateOutput ¶ added in v0.37.0
type PeersStateOutput struct {
Total int `json:"total" yaml:"total"`
Connected int `json:"connected" yaml:"connected"`
Details []PeerStateDetailOutput `json:"details" yaml:"details"`
}
type RelayStateOutput ¶ added in v0.37.0
type RelayStateOutput struct {
Total int `json:"total" yaml:"total"`
Available int `json:"available" yaml:"available"`
Details []RelayStateOutputDetail `json:"details" yaml:"details"`
}
type RelayStateOutputDetail ¶ added in v0.37.0
type SSHServerStateOutput ¶ added in v0.60.0
type SSHServerStateOutput struct {
Enabled bool `json:"enabled" yaml:"enabled"`
Sessions []SSHSessionOutput `json:"sessions" yaml:"sessions"`
}
type SSHSessionOutput ¶ added in v0.60.0
type SSHSessionOutput struct {
Username string `json:"username" yaml:"username"`
RemoteAddress string `json:"remoteAddress" yaml:"remoteAddress"`
Command string `json:"command" yaml:"command"`
JWTUsername string `json:"jwtUsername,omitempty" yaml:"jwtUsername,omitempty"`
PortForwards []string `json:"portForwards,omitempty" yaml:"portForwards,omitempty"`
}
type SignalStateOutput ¶ added in v0.37.0
type SystemEventOutput ¶ added in v0.37.0
type SystemEventOutput struct {
ID string `json:"id" yaml:"id"`
Severity string `json:"severity" yaml:"severity"`
Category string `json:"category" yaml:"category"`
Message string `json:"message" yaml:"message"`
UserMessage string `json:"userMessage" yaml:"userMessage"`
Timestamp time.Time `json:"timestamp" yaml:"timestamp"`
Metadata map[string]string `json:"metadata" yaml:"metadata"`
}
Click to show internal directories.
Click to hide internal directories.