system

package
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 31, 2023 License: Apache-2.0 Imports: 10 Imported by: 15

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	RebootMethod_name = map[int32]string{
		0: "UNKNOWN",
		1: "COLD",
		2: "POWERDOWN",
		3: "HALT",
		4: "WARM",
		5: "NSF",
		7: "POWERUP",
	}
	RebootMethod_value = map[string]int32{
		"UNKNOWN":   0,
		"COLD":      1,
		"POWERDOWN": 2,
		"HALT":      3,
		"WARM":      4,
		"NSF":       5,
		"POWERUP":   7,
	}
)

Enum value maps for RebootMethod.

View Source 
var (
	RebootStatus_Status_name = map[int32]string{
		0: "STATUS_UNKNOWN",
		1: "STATUS_SUCCESS",
		2: "STATUS_RETRIABLE_FAILURE",
		3: "STATUS_FAILURE",
	}
	RebootStatus_Status_value = map[string]int32{
		"STATUS_UNKNOWN":           0,
		"STATUS_SUCCESS":           1,
		"STATUS_RETRIABLE_FAILURE": 2,
		"STATUS_FAILURE":           3,
	}
)

Enum value maps for RebootStatus_Status.

View Source 
var (
	TracerouteRequest_L4Protocol_name = map[int32]string{
		0: "ICMP",
		1: "TCP",
		2: "UDP",
	}
	TracerouteRequest_L4Protocol_value = map[string]int32{
		"ICMP": 0,
		"TCP":  1,
		"UDP":  2,
	}
)

Enum value maps for TracerouteRequest_L4Protocol.

View Source 
var (
	TracerouteResponse_State_name = map[int32]string{
		0:  "DEFAULT",
		1:  "NONE",
		2:  "UNKNOWN",
		3:  "ICMP",
		4:  "HOST_UNREACHABLE",
		5:  "NETWORK_UNREACHABLE",
		6:  "PROTOCOL_UNREACHABLE",
		7:  "SOURCE_ROUTE_FAILED",
		8:  "FRAGMENTATION_NEEDED",
		9:  "PROHIBITED",
		10: "PRECEDENCE_VIOLATION",
		11: "PRECEDENCE_CUTOFF",
	}
	TracerouteResponse_State_value = map[string]int32{
		"DEFAULT":              0,
		"NONE":                 1,
		"UNKNOWN":              2,
		"ICMP":                 3,
		"HOST_UNREACHABLE":     4,
		"NETWORK_UNREACHABLE":  5,
		"PROTOCOL_UNREACHABLE": 6,
		"SOURCE_ROUTE_FAILED":  7,
		"FRAGMENTATION_NEEDED": 8,
		"PROHIBITED":           9,
		"PRECEDENCE_VIOLATION": 10,
		"PRECEDENCE_CUTOFF":    11,
	}
)

Enum value maps for TracerouteResponse_State.

View Source 
var (
	KillProcessRequest_Signal_name = map[int32]string{
		0: "SIGNAL_UNSPECIFIED",
		1: "SIGNAL_TERM",
		2: "SIGNAL_KILL",
		3: "SIGNAL_HUP",
		4: "SIGNAL_ABRT",
	}
	KillProcessRequest_Signal_value = map[string]int32{
		"SIGNAL_UNSPECIFIED": 0,
		"SIGNAL_TERM":        1,
		"SIGNAL_KILL":        2,
		"SIGNAL_HUP":         3,
		"SIGNAL_ABRT":        4,
	}
)

Enum value maps for KillProcessRequest_Signal.

View Source 
var File_system_system_proto protoreflect.FileDescriptor
View Source 
var System_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "gnoi.system.System",
	HandlerType: (*SystemServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Time",
			Handler:    _System_Time_Handler,
		},
		{
			MethodName: "SwitchControlProcessor",
			Handler:    _System_SwitchControlProcessor_Handler,
		},
		{
			MethodName: "Reboot",
			Handler:    _System_Reboot_Handler,
		},
		{
			MethodName: "RebootStatus",
			Handler:    _System_RebootStatus_Handler,
		},
		{
			MethodName: "CancelReboot",
			Handler:    _System_CancelReboot_Handler,
		},
		{
			MethodName: "KillProcess",
			Handler:    _System_KillProcess_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "Ping",
			Handler:       _System_Ping_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "Traceroute",
			Handler:       _System_Traceroute_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "SetPackage",
			Handler:       _System_SetPackage_Handler,
			ClientStreams: true,
		},
	},
	Metadata: "system/system.proto",
}

System_ServiceDesc is the grpc.ServiceDesc for System service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterSystemServer 

func RegisterSystemServer(s grpc.ServiceRegistrar, srv SystemServer)

Types

type CancelRebootRequest 

type CancelRebootRequest struct {
	Message       string        `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`             // informational reason for the cancel
	Subcomponents []*types.Path `protobuf:"bytes,2,rep,name=subcomponents,proto3" json:"subcomponents,omitempty"` // optional sub-components.
	// contains filtered or unexported fields
}

A CancelRebootRequest requests the cancelation of any outstanding reboot request.

func (*CancelRebootRequest) Descriptor deprecated 

func (*CancelRebootRequest) Descriptor() ([]byte, []int)

Deprecated: Use CancelRebootRequest.ProtoReflect.Descriptor instead.

func (*CancelRebootRequest) GetMessage 

func (x *CancelRebootRequest) GetMessage() string

func (*CancelRebootRequest) GetSubcomponents 

func (x *CancelRebootRequest) GetSubcomponents() []*types.Path

func (*CancelRebootRequest) ProtoMessage 

func (*CancelRebootRequest) ProtoMessage()

func (*CancelRebootRequest) ProtoReflect 

func (x *CancelRebootRequest) ProtoReflect() protoreflect.Message

func (*CancelRebootRequest) Reset 

func (x *CancelRebootRequest) Reset()

func (*CancelRebootRequest) String 

func (x *CancelRebootRequest) String() string

type CancelRebootResponse 

type CancelRebootResponse struct {
	// contains filtered or unexported fields
}

func (*CancelRebootResponse) Descriptor deprecated 

func (*CancelRebootResponse) Descriptor() ([]byte, []int)

Deprecated: Use CancelRebootResponse.ProtoReflect.Descriptor instead.

func (*CancelRebootResponse) ProtoMessage 

func (*CancelRebootResponse) ProtoMessage()

func (*CancelRebootResponse) ProtoReflect 

func (x *CancelRebootResponse) ProtoReflect() protoreflect.Message

func (*CancelRebootResponse) Reset 

func (x *CancelRebootResponse) Reset()

func (*CancelRebootResponse) String 

func (x *CancelRebootResponse) String() string

type KillProcessRequest 

type KillProcessRequest struct {

	// Process ID of the process to be killed.
	Pid uint32 `protobuf:"varint,1,opt,name=pid,proto3" json:"pid,omitempty"`
	// Name of the process to be killed.
	Name   string                    `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	Signal KillProcessRequest_Signal `protobuf:"varint,3,opt,name=signal,proto3,enum=gnoi.system.KillProcessRequest_Signal" json:"signal,omitempty"`
	// Whether the process should be restarted after termination.
	// This value is ignored when the termination signal is SIGHUP.
	Restart bool `protobuf:"varint,4,opt,name=restart,proto3" json:"restart,omitempty"`
	// contains filtered or unexported fields
}

KillProcessRequest describes the process kill operation. Either a pid or process name must be specified, and a termination signal must be specified.

func (*KillProcessRequest) Descriptor deprecated 

func (*KillProcessRequest) Descriptor() ([]byte, []int)

Deprecated: Use KillProcessRequest.ProtoReflect.Descriptor instead.

func (*KillProcessRequest) GetName 

func (x *KillProcessRequest) GetName() string

func (*KillProcessRequest) GetPid 

func (x *KillProcessRequest) GetPid() uint32

func (*KillProcessRequest) GetRestart 

func (x *KillProcessRequest) GetRestart() bool

func (*KillProcessRequest) GetSignal 

func (x *KillProcessRequest) GetSignal() KillProcessRequest_Signal

func (*KillProcessRequest) ProtoMessage 

func (*KillProcessRequest) ProtoMessage()

func (*KillProcessRequest) ProtoReflect 

func (x *KillProcessRequest) ProtoReflect() protoreflect.Message

func (*KillProcessRequest) Reset 

func (x *KillProcessRequest) Reset()

func (*KillProcessRequest) String 

func (x *KillProcessRequest) String() string

type KillProcessRequest_Signal 

type KillProcessRequest_Signal int32

Termination signal sent to the process. 

const (
	KillProcessRequest_SIGNAL_UNSPECIFIED KillProcessRequest_Signal = 0 // Invalid default.
	KillProcessRequest_SIGNAL_TERM        KillProcessRequest_Signal = 1 // Terminate the process gracefully.
	KillProcessRequest_SIGNAL_KILL        KillProcessRequest_Signal = 2 // Terminate the process immediately.
	KillProcessRequest_SIGNAL_HUP         KillProcessRequest_Signal = 3 // Reload the process configuration.
	// Terminate the process immediately and dump a core file.
	KillProcessRequest_SIGNAL_ABRT KillProcessRequest_Signal = 4
)

func (KillProcessRequest_Signal) Descriptor 

func (KillProcessRequest_Signal) Descriptor() protoreflect.EnumDescriptor

func (KillProcessRequest_Signal) Enum 

func (x KillProcessRequest_Signal) Enum() *KillProcessRequest_Signal

func (KillProcessRequest_Signal) EnumDescriptor deprecated 

func (KillProcessRequest_Signal) EnumDescriptor() ([]byte, []int)

Deprecated: Use KillProcessRequest_Signal.Descriptor instead.

func (KillProcessRequest_Signal) Number 

func (x KillProcessRequest_Signal) Number() protoreflect.EnumNumber

func (KillProcessRequest_Signal) String 

func (x KillProcessRequest_Signal) String() string

func (KillProcessRequest_Signal) Type 

func (KillProcessRequest_Signal) Type() protoreflect.EnumType

type KillProcessResponse 

type KillProcessResponse struct {
	// contains filtered or unexported fields
}

KillProcessResponse describes the result of the process kill operation.

func (*KillProcessResponse) Descriptor deprecated 

func (*KillProcessResponse) Descriptor() ([]byte, []int)

Deprecated: Use KillProcessResponse.ProtoReflect.Descriptor instead.

func (*KillProcessResponse) ProtoMessage 

func (*KillProcessResponse) ProtoMessage()

func (*KillProcessResponse) ProtoReflect 

func (x *KillProcessResponse) ProtoReflect() protoreflect.Message

func (*KillProcessResponse) Reset 

func (x *KillProcessResponse) Reset()

func (*KillProcessResponse) String 

func (x *KillProcessResponse) String() string

type Package 

type Package struct {

	// Destination path and filename of the package.
	Filename string `protobuf:"bytes,1,opt,name=filename,proto3" json:"filename,omitempty"`
	// Version of the package. (vendor internal name)
	Version string `protobuf:"bytes,4,opt,name=version,proto3" json:"version,omitempty"`
	// Indicates that the package should be made active after receipt on
	// the device. For system image packages, the new image is expected to
	// be active after a reboot.
	Activate bool `protobuf:"varint,5,opt,name=activate,proto3" json:"activate,omitempty"`
	// Details for the device to download the package from a remote location.
	RemoteDownload *common.RemoteDownload `protobuf:"bytes,6,opt,name=remote_download,json=remoteDownload,proto3" json:"remote_download,omitempty"`
	// contains filtered or unexported fields
}

Package defines a single package file to be placed on the target.

func (*Package) Descriptor deprecated 

func (*Package) Descriptor() ([]byte, []int)

Deprecated: Use Package.ProtoReflect.Descriptor instead.

func (*Package) GetActivate 

func (x *Package) GetActivate() bool

func (*Package) GetFilename 

func (x *Package) GetFilename() string

func (*Package) GetRemoteDownload 

func (x *Package) GetRemoteDownload() *common.RemoteDownload

func (*Package) GetVersion 

func (x *Package) GetVersion() string

func (*Package) ProtoMessage 

func (*Package) ProtoMessage()

func (*Package) ProtoReflect 

func (x *Package) ProtoReflect() protoreflect.Message

func (*Package) Reset 

func (x *Package) Reset()

func (*Package) String 

func (x *Package) String() string

type PingRequest 

type PingRequest struct {
	Destination     string           `protobuf:"bytes,1,opt,name=destination,proto3" json:"destination,omitempty"`                                 // Destination address to ping. required.
	Source          string           `protobuf:"bytes,2,opt,name=source,proto3" json:"source,omitempty"`                                           // Source address to ping from.
	Count           int32            `protobuf:"varint,3,opt,name=count,proto3" json:"count,omitempty"`                                            // Number of packets.
	Interval        int64            `protobuf:"varint,4,opt,name=interval,proto3" json:"interval,omitempty"`                                      // Nanoseconds between requests.
	Wait            int64            `protobuf:"varint,5,opt,name=wait,proto3" json:"wait,omitempty"`                                              // Nanoseconds to wait for a response.
	Size            int32            `protobuf:"varint,6,opt,name=size,proto3" json:"size,omitempty"`                                              // Size of request packet. (excluding ICMP header)
	DoNotFragment   bool             `protobuf:"varint,7,opt,name=do_not_fragment,json=doNotFragment,proto3" json:"do_not_fragment,omitempty"`     // Set the do not fragment bit. (IPv4 destinations)
	DoNotResolve    bool             `protobuf:"varint,8,opt,name=do_not_resolve,json=doNotResolve,proto3" json:"do_not_resolve,omitempty"`        // Do not try resolve the address returned.
	L3Protocol      types.L3Protocol `protobuf:"varint,9,opt,name=l3protocol,proto3,enum=gnoi.types.L3Protocol" json:"l3protocol,omitempty"`       // Layer3 protocol requested for the ping.
	NetworkInstance string           `protobuf:"bytes,10,opt,name=network_instance,json=networkInstance,proto3" json:"network_instance,omitempty"` // Network instance to ping the destination in
	// contains filtered or unexported fields
}

A PingRequest describes the ping operation to perform. Only the destination fields is required. Any field not specified is set to a reasonable server specified value. Not all fields are supported by all vendors.

A count of 0 defaults to a vendor specified value, typically 5. A count of -1 means continue until the RPC times out or is canceled.

If the interval is -1 then a flood ping is issued.

If the size is 0, the vendor default size will be used (typically 56 bytes).

func (*PingRequest) Descriptor deprecated 

func (*PingRequest) Descriptor() ([]byte, []int)

Deprecated: Use PingRequest.ProtoReflect.Descriptor instead.

func (*PingRequest) GetCount 

func (x *PingRequest) GetCount() int32

func (*PingRequest) GetDestination 

func (x *PingRequest) GetDestination() string

func (*PingRequest) GetDoNotFragment 

func (x *PingRequest) GetDoNotFragment() bool

func (*PingRequest) GetDoNotResolve 

func (x *PingRequest) GetDoNotResolve() bool

func (*PingRequest) GetInterval 

func (x *PingRequest) GetInterval() int64

func (*PingRequest) GetL3Protocol 

func (x *PingRequest) GetL3Protocol() types.L3Protocol

func (*PingRequest) GetNetworkInstance added in v0.2.0 

func (x *PingRequest) GetNetworkInstance() string

func (*PingRequest) GetSize 

func (x *PingRequest) GetSize() int32

func (*PingRequest) GetSource 

func (x *PingRequest) GetSource() string

func (*PingRequest) GetWait 

func (x *PingRequest) GetWait() int64

func (*PingRequest) ProtoMessage 

func (*PingRequest) ProtoMessage()

func (*PingRequest) ProtoReflect 

func (x *PingRequest) ProtoReflect() protoreflect.Message

func (*PingRequest) Reset 

func (x *PingRequest) Reset()

func (*PingRequest) String 

func (x *PingRequest) String() string

type PingResponse 

type PingResponse struct {
	Source   string `protobuf:"bytes,1,opt,name=source,proto3" json:"source,omitempty"` // Source of received bytes.
	Time     int64  `protobuf:"varint,2,opt,name=time,proto3" json:"time,omitempty"`
	Sent     int32  `protobuf:"varint,3,opt,name=sent,proto3" json:"sent,omitempty"`                      // Total packets sent.
	Received int32  `protobuf:"varint,4,opt,name=received,proto3" json:"received,omitempty"`              // Total packets received.
	MinTime  int64  `protobuf:"varint,5,opt,name=min_time,json=minTime,proto3" json:"min_time,omitempty"` // Minimum round trip time in nanoseconds.
	AvgTime  int64  `protobuf:"varint,6,opt,name=avg_time,json=avgTime,proto3" json:"avg_time,omitempty"` // Average round trip time in nanoseconds.
	MaxTime  int64  `protobuf:"varint,7,opt,name=max_time,json=maxTime,proto3" json:"max_time,omitempty"` // Maximum round trip time in nanoseconds.
	StdDev   int64  `protobuf:"varint,8,opt,name=std_dev,json=stdDev,proto3" json:"std_dev,omitempty"`    // Standard deviation in round trip time.
	Bytes    int32  `protobuf:"varint,11,opt,name=bytes,proto3" json:"bytes,omitempty"`                   // Bytes received.
	Sequence int32  `protobuf:"varint,12,opt,name=sequence,proto3" json:"sequence,omitempty"`             // Sequence number of received packet.
	Ttl      int32  `protobuf:"varint,13,opt,name=ttl,proto3" json:"ttl,omitempty"`                       // Remaining time to live value.
	// contains filtered or unexported fields
}

A PingResponse represents either the reponse to a single ping packet (the bytes field is non-zero) or the summary statistics (sent is non-zero).

For a single ping packet, time is the round trip time, in nanoseconds. For summary statistics, it is the time spent by the ping operation. The time is not always present in summary statistics. The std_dev is not always present in summary statistics.

func (*PingResponse) Descriptor deprecated 

func (*PingResponse) Descriptor() ([]byte, []int)

Deprecated: Use PingResponse.ProtoReflect.Descriptor instead.

func (*PingResponse) GetAvgTime 

func (x *PingResponse) GetAvgTime() int64

func (*PingResponse) GetBytes 

func (x *PingResponse) GetBytes() int32

func (*PingResponse) GetMaxTime 

func (x *PingResponse) GetMaxTime() int64

func (*PingResponse) GetMinTime 

func (x *PingResponse) GetMinTime() int64

func (*PingResponse) GetReceived 

func (x *PingResponse) GetReceived() int32

func (*PingResponse) GetSent 

func (x *PingResponse) GetSent() int32

func (*PingResponse) GetSequence 

func (x *PingResponse) GetSequence() int32

func (*PingResponse) GetSource 

func (x *PingResponse) GetSource() string

func (*PingResponse) GetStdDev 

func (x *PingResponse) GetStdDev() int64

func (*PingResponse) GetTime 

func (x *PingResponse) GetTime() int64

func (*PingResponse) GetTtl 

func (x *PingResponse) GetTtl() int32

func (*PingResponse) ProtoMessage 

func (*PingResponse) ProtoMessage()

func (*PingResponse) ProtoReflect 

func (x *PingResponse) ProtoReflect() protoreflect.Message

func (*PingResponse) Reset 

func (x *PingResponse) Reset()

func (*PingResponse) String 

func (x *PingResponse) String() string

type RebootMethod 

type RebootMethod int32

A RebootMethod determines what should be done with a target when a Reboot is requested. Only the COLD method is required to be supported by all targets. A target should return 'INVALID_ARGUMENT` if UNKNOWN or any other unsupported method is called.

It is vendor defined if a WARM reboot is the same as an NSF reboot. 

const (
	RebootMethod_UNKNOWN   RebootMethod = 0 // Invalid default method.
	RebootMethod_COLD      RebootMethod = 1 // Shutdown and restart OS and all hardware.
	RebootMethod_POWERDOWN RebootMethod = 2 // Halt and power down, if possible.
	RebootMethod_HALT      RebootMethod = 3 // Halt, if possible.
	RebootMethod_WARM      RebootMethod = 4 // Reload configuration but not underlying hardware.
	RebootMethod_NSF       RebootMethod = 5 // Non-stop-forwarding reboot, if possible.
	RebootMethod_POWERUP   RebootMethod = 7 // Apply power, no-op if power is already on.
)

func (RebootMethod) Descriptor 

func (RebootMethod) Descriptor() protoreflect.EnumDescriptor

func (RebootMethod) Enum 

func (x RebootMethod) Enum() *RebootMethod

func (RebootMethod) EnumDescriptor deprecated 

func (RebootMethod) EnumDescriptor() ([]byte, []int)

Deprecated: Use RebootMethod.Descriptor instead.

func (RebootMethod) Number 

func (x RebootMethod) Number() protoreflect.EnumNumber

func (RebootMethod) String 

func (x RebootMethod) String() string

func (RebootMethod) Type 

func (RebootMethod) Type() protoreflect.EnumType

type RebootRequest 

type RebootRequest struct {
	Method RebootMethod `protobuf:"varint,1,opt,name=method,proto3,enum=gnoi.system.RebootMethod" json:"method,omitempty"`
	// Delay in nanoseconds before issuing reboot.
	Delay uint64 `protobuf:"varint,2,opt,name=delay,proto3" json:"delay,omitempty"`
	// Informational reason for the reboot.
	Message string `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"`
	// Optional sub-components to reboot.
	Subcomponents []*types.Path `protobuf:"bytes,4,rep,name=subcomponents,proto3" json:"subcomponents,omitempty"`
	// Force reboot if sanity checks fail. (ex. uncommited configuration)
	Force bool `protobuf:"varint,5,opt,name=force,proto3" json:"force,omitempty"`
	// contains filtered or unexported fields
}

A RebootRequest requests the specified target be rebooted using the specified method after the specified delay. Only the COLD method with a delay of 0 is guaranteed to be accepted for all target types.

func (*RebootRequest) Descriptor deprecated 

func (*RebootRequest) Descriptor() ([]byte, []int)

Deprecated: Use RebootRequest.ProtoReflect.Descriptor instead.

func (*RebootRequest) GetDelay 

func (x *RebootRequest) GetDelay() uint64

func (*RebootRequest) GetForce 

func (x *RebootRequest) GetForce() bool

func (*RebootRequest) GetMessage 

func (x *RebootRequest) GetMessage() string

func (*RebootRequest) GetMethod 

func (x *RebootRequest) GetMethod() RebootMethod

func (*RebootRequest) GetSubcomponents 

func (x *RebootRequest) GetSubcomponents() []*types.Path

func (*RebootRequest) ProtoMessage 

func (*RebootRequest) ProtoMessage()

func (*RebootRequest) ProtoReflect 

func (x *RebootRequest) ProtoReflect() protoreflect.Message

func (*RebootRequest) Reset 

func (x *RebootRequest) Reset()

func (*RebootRequest) String 

func (x *RebootRequest) String() string

type RebootResponse 

type RebootResponse struct {
	// contains filtered or unexported fields
}

func (*RebootResponse) Descriptor deprecated 

func (*RebootResponse) Descriptor() ([]byte, []int)

Deprecated: Use RebootResponse.ProtoReflect.Descriptor instead.

func (*RebootResponse) ProtoMessage 

func (*RebootResponse) ProtoMessage()

func (*RebootResponse) ProtoReflect 

func (x *RebootResponse) ProtoReflect() protoreflect.Message

func (*RebootResponse) Reset 

func (x *RebootResponse) Reset()

func (*RebootResponse) String 

func (x *RebootResponse) String() string

type RebootStatus added in v0.3.0 

type RebootStatus struct {
	Status  RebootStatus_Status `protobuf:"varint,1,opt,name=status,proto3,enum=gnoi.system.RebootStatus_Status" json:"status,omitempty"`
	Message string              `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

func (*RebootStatus) Descriptor deprecated added in v0.3.0 

func (*RebootStatus) Descriptor() ([]byte, []int)

Deprecated: Use RebootStatus.ProtoReflect.Descriptor instead.

func (*RebootStatus) GetMessage added in v0.3.0 

func (x *RebootStatus) GetMessage() string

func (*RebootStatus) GetStatus added in v0.3.0 

func (x *RebootStatus) GetStatus() RebootStatus_Status

func (*RebootStatus) ProtoMessage added in v0.3.0 

func (*RebootStatus) ProtoMessage()

func (*RebootStatus) ProtoReflect added in v0.3.0 

func (x *RebootStatus) ProtoReflect() protoreflect.Message

func (*RebootStatus) Reset added in v0.3.0 

func (x *RebootStatus) Reset()

func (*RebootStatus) String added in v0.3.0 

func (x *RebootStatus) String() string

type RebootStatusRequest 

type RebootStatusRequest struct {
	Subcomponents []*types.Path `protobuf:"bytes,1,rep,name=subcomponents,proto3" json:"subcomponents,omitempty"` // optional sub-component.
	// contains filtered or unexported fields
}

func (*RebootStatusRequest) Descriptor deprecated 

func (*RebootStatusRequest) Descriptor() ([]byte, []int)

Deprecated: Use RebootStatusRequest.ProtoReflect.Descriptor instead.

func (*RebootStatusRequest) GetSubcomponents 

func (x *RebootStatusRequest) GetSubcomponents() []*types.Path

func (*RebootStatusRequest) ProtoMessage 

func (*RebootStatusRequest) ProtoMessage()

func (*RebootStatusRequest) ProtoReflect 

func (x *RebootStatusRequest) ProtoReflect() protoreflect.Message

func (*RebootStatusRequest) Reset 

func (x *RebootStatusRequest) Reset()

func (*RebootStatusRequest) String 

func (x *RebootStatusRequest) String() string

type RebootStatusResponse 

type RebootStatusResponse struct {
	Active bool          `protobuf:"varint,1,opt,name=active,proto3" json:"active,omitempty"`                               // If reboot is active.
	Wait   uint64        `protobuf:"varint,2,opt,name=wait,proto3" json:"wait,omitempty"`                                   // Time left until reboot.
	When   uint64        `protobuf:"varint,3,opt,name=when,proto3" json:"when,omitempty"`                                   // Time to reboot in nanoseconds since the epoch.
	Reason string        `protobuf:"bytes,4,opt,name=reason,proto3" json:"reason,omitempty"`                                // Reason for reboot.
	Count  uint32        `protobuf:"varint,5,opt,name=count,proto3" json:"count,omitempty"`                                 // Number of reboots since active.
	Method RebootMethod  `protobuf:"varint,6,opt,name=method,proto3,enum=gnoi.system.RebootMethod" json:"method,omitempty"` // Type of reboot.
	Status *RebootStatus `protobuf:"bytes,7,opt,name=status,proto3" json:"status,omitempty"`                                // Applicable only when active = false.
	// contains filtered or unexported fields
}

func (*RebootStatusResponse) Descriptor deprecated 

func (*RebootStatusResponse) Descriptor() ([]byte, []int)

Deprecated: Use RebootStatusResponse.ProtoReflect.Descriptor instead.

func (*RebootStatusResponse) GetActive 

func (x *RebootStatusResponse) GetActive() bool

func (*RebootStatusResponse) GetCount 

func (x *RebootStatusResponse) GetCount() uint32

func (*RebootStatusResponse) GetMethod added in v0.3.0 

func (x *RebootStatusResponse) GetMethod() RebootMethod

func (*RebootStatusResponse) GetReason 

func (x *RebootStatusResponse) GetReason() string

func (*RebootStatusResponse) GetStatus added in v0.3.0 

func (x *RebootStatusResponse) GetStatus() *RebootStatus

func (*RebootStatusResponse) GetWait 

func (x *RebootStatusResponse) GetWait() uint64

func (*RebootStatusResponse) GetWhen 

func (x *RebootStatusResponse) GetWhen() uint64

func (*RebootStatusResponse) ProtoMessage 

func (*RebootStatusResponse) ProtoMessage()

func (*RebootStatusResponse) ProtoReflect 

func (x *RebootStatusResponse) ProtoReflect() protoreflect.Message

func (*RebootStatusResponse) Reset 

func (x *RebootStatusResponse) Reset()

func (*RebootStatusResponse) String 

func (x *RebootStatusResponse) String() string

type RebootStatus_Status added in v0.3.0 

type RebootStatus_Status int32
const (
	RebootStatus_STATUS_UNKNOWN           RebootStatus_Status = 0
	RebootStatus_STATUS_SUCCESS           RebootStatus_Status = 1
	RebootStatus_STATUS_RETRIABLE_FAILURE RebootStatus_Status = 2
	RebootStatus_STATUS_FAILURE           RebootStatus_Status = 3
)

func (RebootStatus_Status) Descriptor added in v0.3.0 

func (RebootStatus_Status) Descriptor() protoreflect.EnumDescriptor

func (RebootStatus_Status) Enum added in v0.3.0 

func (x RebootStatus_Status) Enum() *RebootStatus_Status

func (RebootStatus_Status) EnumDescriptor deprecated added in v0.3.0 

func (RebootStatus_Status) EnumDescriptor() ([]byte, []int)

Deprecated: Use RebootStatus_Status.Descriptor instead.

func (RebootStatus_Status) Number added in v0.3.0 

func (x RebootStatus_Status) Number() protoreflect.EnumNumber

func (RebootStatus_Status) String added in v0.3.0 

func (x RebootStatus_Status) String() string

func (RebootStatus_Status) Type added in v0.3.0 

func (RebootStatus_Status) Type() protoreflect.EnumType

type SetPackageRequest 

type SetPackageRequest struct {

	// Types that are assignable to Request:
	//	*SetPackageRequest_Package
	//	*SetPackageRequest_Contents
	//	*SetPackageRequest_Hash
	Request isSetPackageRequest_Request `protobuf_oneof:"request"`
	// contains filtered or unexported fields
}

SetPackageRequest will place the package onto the target and optionally mark it as the next bootable image. The initial message must be a package message containing the filename and information about the file. Following the initial message the contents are then streamed in maximum 64k chunks. The final message must be a hash message contains the hash of the file contents.

func (*SetPackageRequest) Descriptor deprecated 

func (*SetPackageRequest) Descriptor() ([]byte, []int)

Deprecated: Use SetPackageRequest.ProtoReflect.Descriptor instead.

func (*SetPackageRequest) GetContents 

func (x *SetPackageRequest) GetContents() []byte

func (*SetPackageRequest) GetHash 

func (x *SetPackageRequest) GetHash() *types.HashType

func (*SetPackageRequest) GetPackage 

func (x *SetPackageRequest) GetPackage() *Package

func (*SetPackageRequest) GetRequest 

func (m *SetPackageRequest) GetRequest() isSetPackageRequest_Request

func (*SetPackageRequest) ProtoMessage 

func (*SetPackageRequest) ProtoMessage()

func (*SetPackageRequest) ProtoReflect 

func (x *SetPackageRequest) ProtoReflect() protoreflect.Message

func (*SetPackageRequest) Reset 

func (x *SetPackageRequest) Reset()

func (*SetPackageRequest) String 

func (x *SetPackageRequest) String() string

type SetPackageRequest_Contents 

type SetPackageRequest_Contents struct {
	Contents []byte `protobuf:"bytes,2,opt,name=contents,proto3,oneof"`
}

type SetPackageRequest_Hash 

type SetPackageRequest_Hash struct {
	Hash *types.HashType `protobuf:"bytes,3,opt,name=hash,proto3,oneof"` // Verification hash of data.
}

type SetPackageRequest_Package 

type SetPackageRequest_Package struct {
	Package *Package `protobuf:"bytes,1,opt,name=package,proto3,oneof"`
}

type SetPackageResponse 

type SetPackageResponse struct {
	// contains filtered or unexported fields
}

func (*SetPackageResponse) Descriptor deprecated 

func (*SetPackageResponse) Descriptor() ([]byte, []int)

Deprecated: Use SetPackageResponse.ProtoReflect.Descriptor instead.

func (*SetPackageResponse) ProtoMessage 

func (*SetPackageResponse) ProtoMessage()

func (*SetPackageResponse) ProtoReflect 

func (x *SetPackageResponse) ProtoReflect() protoreflect.Message

func (*SetPackageResponse) Reset 

func (x *SetPackageResponse) Reset()

func (*SetPackageResponse) String 

func (x *SetPackageResponse) String() string

type SwitchControlProcessorRequest 

type SwitchControlProcessorRequest struct {
	ControlProcessor *types.Path `protobuf:"bytes,1,opt,name=control_processor,json=controlProcessor,proto3" json:"control_processor,omitempty"`
	// contains filtered or unexported fields
}

func (*SwitchControlProcessorRequest) Descriptor deprecated 

func (*SwitchControlProcessorRequest) Descriptor() ([]byte, []int)

Deprecated: Use SwitchControlProcessorRequest.ProtoReflect.Descriptor instead.

func (*SwitchControlProcessorRequest) GetControlProcessor 

func (x *SwitchControlProcessorRequest) GetControlProcessor() *types.Path

func (*SwitchControlProcessorRequest) ProtoMessage 

func (*SwitchControlProcessorRequest) ProtoMessage()

func (*SwitchControlProcessorRequest) ProtoReflect 

func (x *SwitchControlProcessorRequest) ProtoReflect() protoreflect.Message

func (*SwitchControlProcessorRequest) Reset 

func (x *SwitchControlProcessorRequest) Reset()

func (*SwitchControlProcessorRequest) String 

func (x *SwitchControlProcessorRequest) String() string

type SwitchControlProcessorResponse 

type SwitchControlProcessorResponse struct {
	ControlProcessor *types.Path `protobuf:"bytes,1,opt,name=control_processor,json=controlProcessor,proto3" json:"control_processor,omitempty"`
	Version          string      `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"` // Current software version.
	Uptime           int64       `protobuf:"varint,3,opt,name=uptime,proto3" json:"uptime,omitempty"`  // Uptime in nanoseconds since epoch.
	// contains filtered or unexported fields
}

func (*SwitchControlProcessorResponse) Descriptor deprecated 

func (*SwitchControlProcessorResponse) Descriptor() ([]byte, []int)

Deprecated: Use SwitchControlProcessorResponse.ProtoReflect.Descriptor instead.

func (*SwitchControlProcessorResponse) GetControlProcessor 

func (x *SwitchControlProcessorResponse) GetControlProcessor() *types.Path

func (*SwitchControlProcessorResponse) GetUptime 

func (x *SwitchControlProcessorResponse) GetUptime() int64

func (*SwitchControlProcessorResponse) GetVersion 

func (x *SwitchControlProcessorResponse) GetVersion() string

func (*SwitchControlProcessorResponse) ProtoMessage 

func (*SwitchControlProcessorResponse) ProtoMessage()

func (*SwitchControlProcessorResponse) ProtoReflect 

func (x *SwitchControlProcessorResponse) ProtoReflect() protoreflect.Message

func (*SwitchControlProcessorResponse) Reset 

func (x *SwitchControlProcessorResponse) Reset()

func (*SwitchControlProcessorResponse) String 

func (x *SwitchControlProcessorResponse) String() string

type SystemClient 

type SystemClient interface {
	// Ping executes the ping command on the target and streams back
	// the results.  Some targets may not stream any results until all
	// results are in.  The stream should provide single ping packet responses
	// and must provide summary statistics.
	Ping(ctx context.Context, in *PingRequest, opts ...grpc.CallOption) (System_PingClient, error)
	// Traceroute executes the traceroute command on the target and streams back
	// the results.  Some targets may not stream any results until all
	// results are in.  If a hop count is not explicitly provided,
	// 30 is used.
	Traceroute(ctx context.Context, in *TracerouteRequest, opts ...grpc.CallOption) (System_TracerouteClient, error)
	// Time returns the current time on the target.  Time is typically used to
	// test if a target is actually responding.
	Time(ctx context.Context, in *TimeRequest, opts ...grpc.CallOption) (*TimeResponse, error)
	// SetPackage places a software package (possibly including bootable images)
	// on the target. The file is sent in sequential messages, each message
	// up to 64KB of data. A final message must be sent that includes the hash
	// of the data sent. An error is returned if the location does not exist or
	// there is an error writing the data. If no checksum is received, the target
	// must assume the operation is incomplete and remove the partially
	// transmitted file. The target should initially write the file to a temporary
	// location so a failure does not destroy the original file.
	SetPackage(ctx context.Context, opts ...grpc.CallOption) (System_SetPackageClient, error)
	// SwitchControlProcessor will switch from the current route processor to the
	// provided route processor. If the current route processor is the same as the
	// one provided it is a NOOP. If the target does not exist an error is
	// returned.
	SwitchControlProcessor(ctx context.Context, in *SwitchControlProcessorRequest, opts ...grpc.CallOption) (*SwitchControlProcessorResponse, error)
	// Reboot causes the target to reboot, possibly at some point in the future.
	// If the method of reboot is not supported then the Reboot RPC will fail.
	// If the reboot is immediate the command will block until the subcomponents
	// have restarted.
	// If a reboot on the active control processor is pending the service must
	// reject all other reboot requests.
	// If a reboot request for active control processor is initiated with other
	// pending reboot requests it must be rejected.
	Reboot(ctx context.Context, in *RebootRequest, opts ...grpc.CallOption) (*RebootResponse, error)
	// RebootStatus returns the status of reboot for the target.
	RebootStatus(ctx context.Context, in *RebootStatusRequest, opts ...grpc.CallOption) (*RebootStatusResponse, error)
	// CancelReboot cancels any pending reboot request.
	CancelReboot(ctx context.Context, in *CancelRebootRequest, opts ...grpc.CallOption) (*CancelRebootResponse, error)
	// KillProcess kills an OS process and optionally restarts it.
	KillProcess(ctx context.Context, in *KillProcessRequest, opts ...grpc.CallOption) (*KillProcessResponse, error)
}

SystemClient is the client API for System service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewSystemClient 

func NewSystemClient(cc grpc.ClientConnInterface) SystemClient

type SystemServer 

type SystemServer interface {
	// Ping executes the ping command on the target and streams back
	// the results.  Some targets may not stream any results until all
	// results are in.  The stream should provide single ping packet responses
	// and must provide summary statistics.
	Ping(*PingRequest, System_PingServer) error
	// Traceroute executes the traceroute command on the target and streams back
	// the results.  Some targets may not stream any results until all
	// results are in.  If a hop count is not explicitly provided,
	// 30 is used.
	Traceroute(*TracerouteRequest, System_TracerouteServer) error
	// Time returns the current time on the target.  Time is typically used to
	// test if a target is actually responding.
	Time(context.Context, *TimeRequest) (*TimeResponse, error)
	// SetPackage places a software package (possibly including bootable images)
	// on the target. The file is sent in sequential messages, each message
	// up to 64KB of data. A final message must be sent that includes the hash
	// of the data sent. An error is returned if the location does not exist or
	// there is an error writing the data. If no checksum is received, the target
	// must assume the operation is incomplete and remove the partially
	// transmitted file. The target should initially write the file to a temporary
	// location so a failure does not destroy the original file.
	SetPackage(System_SetPackageServer) error
	// SwitchControlProcessor will switch from the current route processor to the
	// provided route processor. If the current route processor is the same as the
	// one provided it is a NOOP. If the target does not exist an error is
	// returned.
	SwitchControlProcessor(context.Context, *SwitchControlProcessorRequest) (*SwitchControlProcessorResponse, error)
	// Reboot causes the target to reboot, possibly at some point in the future.
	// If the method of reboot is not supported then the Reboot RPC will fail.
	// If the reboot is immediate the command will block until the subcomponents
	// have restarted.
	// If a reboot on the active control processor is pending the service must
	// reject all other reboot requests.
	// If a reboot request for active control processor is initiated with other
	// pending reboot requests it must be rejected.
	Reboot(context.Context, *RebootRequest) (*RebootResponse, error)
	// RebootStatus returns the status of reboot for the target.
	RebootStatus(context.Context, *RebootStatusRequest) (*RebootStatusResponse, error)
	// CancelReboot cancels any pending reboot request.
	CancelReboot(context.Context, *CancelRebootRequest) (*CancelRebootResponse, error)
	// KillProcess kills an OS process and optionally restarts it.
	KillProcess(context.Context, *KillProcessRequest) (*KillProcessResponse, error)
	// contains filtered or unexported methods
}

SystemServer is the server API for System service. All implementations must embed UnimplementedSystemServer for forward compatibility

type System_PingClient 

type System_PingClient interface {
	Recv() (*PingResponse, error)
	grpc.ClientStream
}

type System_PingServer 

type System_PingServer interface {
	Send(*PingResponse) error
	grpc.ServerStream
}

type System_SetPackageClient 

type System_SetPackageClient interface {
	Send(*SetPackageRequest) error
	CloseAndRecv() (*SetPackageResponse, error)
	grpc.ClientStream
}

type System_SetPackageServer 

type System_SetPackageServer interface {
	SendAndClose(*SetPackageResponse) error
	Recv() (*SetPackageRequest, error)
	grpc.ServerStream
}

type System_TracerouteClient 

type System_TracerouteClient interface {
	Recv() (*TracerouteResponse, error)
	grpc.ClientStream
}

type System_TracerouteServer 

type System_TracerouteServer interface {
	Send(*TracerouteResponse) error
	grpc.ServerStream
}

type TimeRequest 

type TimeRequest struct {
	// contains filtered or unexported fields
}

A TimeRequest requests the current time accodring to the target.

func (*TimeRequest) Descriptor deprecated 

func (*TimeRequest) Descriptor() ([]byte, []int)

Deprecated: Use TimeRequest.ProtoReflect.Descriptor instead.

func (*TimeRequest) ProtoMessage 

func (*TimeRequest) ProtoMessage()

func (*TimeRequest) ProtoReflect 

func (x *TimeRequest) ProtoReflect() protoreflect.Message

func (*TimeRequest) Reset 

func (x *TimeRequest) Reset()

func (*TimeRequest) String 

func (x *TimeRequest) String() string

type TimeResponse 

type TimeResponse struct {
	Time uint64 `protobuf:"varint,1,opt,name=time,proto3" json:"time,omitempty"` // Current time in nanoseconds since epoch.
	// contains filtered or unexported fields
}

func (*TimeResponse) Descriptor deprecated 

func (*TimeResponse) Descriptor() ([]byte, []int)

Deprecated: Use TimeResponse.ProtoReflect.Descriptor instead.

func (*TimeResponse) GetTime 

func (x *TimeResponse) GetTime() uint64

func (*TimeResponse) ProtoMessage 

func (*TimeResponse) ProtoMessage()

func (*TimeResponse) ProtoReflect 

func (x *TimeResponse) ProtoReflect() protoreflect.Message

func (*TimeResponse) Reset 

func (x *TimeResponse) Reset()

func (*TimeResponse) String 

func (x *TimeResponse) String() string

type TracerouteRequest 

type TracerouteRequest struct {
	Source          string                       `protobuf:"bytes,1,opt,name=source,proto3" json:"source,omitempty"`                                       // Source address to ping from.
	Destination     string                       `protobuf:"bytes,2,opt,name=destination,proto3" json:"destination,omitempty"`                             // Destination address to ping.
	InitialTtl      uint32                       `protobuf:"varint,3,opt,name=initial_ttl,json=initialTtl,proto3" json:"initial_ttl,omitempty"`            // Initial TTL. (default=1)
	MaxTtl          int32                        `protobuf:"varint,4,opt,name=max_ttl,json=maxTtl,proto3" json:"max_ttl,omitempty"`                        // Maximum number of hops. (default=30)
	Wait            int64                        `protobuf:"varint,5,opt,name=wait,proto3" json:"wait,omitempty"`                                          // Nanoseconds to wait for a response.
	DoNotFragment   bool                         `protobuf:"varint,6,opt,name=do_not_fragment,json=doNotFragment,proto3" json:"do_not_fragment,omitempty"` // Set the do not fragment bit. (IPv4 destinations)
	DoNotResolve    bool                         `protobuf:"varint,7,opt,name=do_not_resolve,json=doNotResolve,proto3" json:"do_not_resolve,omitempty"`    // Do not try resolve the address returned.
	L3Protocol      types.L3Protocol             `protobuf:"varint,8,opt,name=l3protocol,proto3,enum=gnoi.types.L3Protocol" json:"l3protocol,omitempty"`   // Layer-3 protocol requested for the ping.
	L4Protocol      TracerouteRequest_L4Protocol `protobuf:"varint,9,opt,name=l4protocol,proto3,enum=gnoi.system.TracerouteRequest_L4Protocol" json:"l4protocol,omitempty"`
	DoNotLookupAsn  bool                         `protobuf:"varint,10,opt,name=do_not_lookup_asn,json=doNotLookupAsn,proto3" json:"do_not_lookup_asn,omitempty"` // Do not try to lookup ASN
	NetworkInstance string                       `protobuf:"bytes,11,opt,name=network_instance,json=networkInstance,proto3" json:"network_instance,omitempty"`   // Network instance to trace the destination in
	// contains filtered or unexported fields
}

A TracerouteRequest describes the traceroute operation to perform. Only the destination field is required. Any field not specified is set to a reasonable server specified value. Not all fields are supported by all vendors.

If the hop_count is -1 the traceroute will continue forever.

func (*TracerouteRequest) Descriptor deprecated 

func (*TracerouteRequest) Descriptor() ([]byte, []int)

Deprecated: Use TracerouteRequest.ProtoReflect.Descriptor instead.

func (*TracerouteRequest) GetDestination 

func (x *TracerouteRequest) GetDestination() string

func (*TracerouteRequest) GetDoNotFragment 

func (x *TracerouteRequest) GetDoNotFragment() bool

func (*TracerouteRequest) GetDoNotLookupAsn 

func (x *TracerouteRequest) GetDoNotLookupAsn() bool

func (*TracerouteRequest) GetDoNotResolve 

func (x *TracerouteRequest) GetDoNotResolve() bool

func (*TracerouteRequest) GetInitialTtl 

func (x *TracerouteRequest) GetInitialTtl() uint32

func (*TracerouteRequest) GetL3Protocol 

func (x *TracerouteRequest) GetL3Protocol() types.L3Protocol

func (*TracerouteRequest) GetL4Protocol 

func (x *TracerouteRequest) GetL4Protocol() TracerouteRequest_L4Protocol

func (*TracerouteRequest) GetMaxTtl 

func (x *TracerouteRequest) GetMaxTtl() int32

func (*TracerouteRequest) GetNetworkInstance added in v0.2.0 

func (x *TracerouteRequest) GetNetworkInstance() string

func (*TracerouteRequest) GetSource 

func (x *TracerouteRequest) GetSource() string

func (*TracerouteRequest) GetWait 

func (x *TracerouteRequest) GetWait() int64

func (*TracerouteRequest) ProtoMessage 

func (*TracerouteRequest) ProtoMessage()

func (*TracerouteRequest) ProtoReflect 

func (x *TracerouteRequest) ProtoReflect() protoreflect.Message

func (*TracerouteRequest) Reset 

func (x *TracerouteRequest) Reset()

func (*TracerouteRequest) String 

func (x *TracerouteRequest) String() string

type TracerouteRequest_L4Protocol 

type TracerouteRequest_L4Protocol int32
const (
	TracerouteRequest_ICMP TracerouteRequest_L4Protocol = 0 // Use ICMP ECHO for probes.
	TracerouteRequest_TCP  TracerouteRequest_L4Protocol = 1 // Use TCP SYN for probes.
	TracerouteRequest_UDP  TracerouteRequest_L4Protocol = 2 // Use UDP for probes.
)

func (TracerouteRequest_L4Protocol) Descriptor 

func (TracerouteRequest_L4Protocol) Descriptor() protoreflect.EnumDescriptor

func (TracerouteRequest_L4Protocol) Enum 

func (x TracerouteRequest_L4Protocol) Enum() *TracerouteRequest_L4Protocol

func (TracerouteRequest_L4Protocol) EnumDescriptor deprecated 

func (TracerouteRequest_L4Protocol) EnumDescriptor() ([]byte, []int)

Deprecated: Use TracerouteRequest_L4Protocol.Descriptor instead.

func (TracerouteRequest_L4Protocol) Number 

func (x TracerouteRequest_L4Protocol) Number() protoreflect.EnumNumber

func (TracerouteRequest_L4Protocol) String 

func (x TracerouteRequest_L4Protocol) String() string

func (TracerouteRequest_L4Protocol) Type 

func (TracerouteRequest_L4Protocol) Type() protoreflect.EnumType

type TracerouteResponse 

type TracerouteResponse struct {

	// The following fields are only filled in for the first message.
	// If any of these fields are specified, all fields following this
	// block are left unspecified.
	DestinationName    string `protobuf:"bytes,1,opt,name=destination_name,json=destinationName,proto3" json:"destination_name,omitempty"`
	DestinationAddress string `protobuf:"bytes,2,opt,name=destination_address,json=destinationAddress,proto3" json:"destination_address,omitempty"`
	Hops               int32  `protobuf:"varint,3,opt,name=hops,proto3" json:"hops,omitempty"`
	PacketSize         int32  `protobuf:"varint,4,opt,name=packet_size,json=packetSize,proto3" json:"packet_size,omitempty"`
	// The following fields provide the disposition of a single traceroute
	// packet.
	Hop      int32                    `protobuf:"varint,5,opt,name=hop,proto3" json:"hop,omitempty"`                                               // Hop number. required.
	Address  string                   `protobuf:"bytes,6,opt,name=address,proto3" json:"address,omitempty"`                                        // Address of responding hop. required.
	Name     string                   `protobuf:"bytes,7,opt,name=name,proto3" json:"name,omitempty"`                                              // Name of responding hop.
	Rtt      int64                    `protobuf:"varint,8,opt,name=rtt,proto3" json:"rtt,omitempty"`                                               // Round trip time in nanoseconds.
	State    TracerouteResponse_State `protobuf:"varint,9,opt,name=state,proto3,enum=gnoi.system.TracerouteResponse_State" json:"state,omitempty"` // State of this hop.
	IcmpCode int32                    `protobuf:"varint,10,opt,name=icmp_code,json=icmpCode,proto3" json:"icmp_code,omitempty"`                    // Code terminating hop.
	Mpls     map[string]string        ``                                                                                                           // MPLS key/value pairs.
	/* 150-byte string literal not displayed */
	AsPath []int32 `protobuf:"varint,12,rep,packed,name=as_path,json=asPath,proto3" json:"as_path,omitempty"` // AS path.
	// contains filtered or unexported fields
}

A TraceRouteResponse contains the result of a single traceoute packet.

There may be an optional initial response that provides information about the traceroute request itself and contains at least one of the fields in the the initial block of fields and none of the fields following that block. All subsequent responses should not contain any of these fields.

Typically multiple responses are received for each hop, as the packets are received.

The mpls field maps names to values. Example names include "Label", "CoS", "TTL", "S", and "MRU". [Perhaps we should list the canonical names that must be used when applicable].

func (*TracerouteResponse) Descriptor deprecated 

func (*TracerouteResponse) Descriptor() ([]byte, []int)

Deprecated: Use TracerouteResponse.ProtoReflect.Descriptor instead.

func (*TracerouteResponse) GetAddress 

func (x *TracerouteResponse) GetAddress() string

func (*TracerouteResponse) GetAsPath 

func (x *TracerouteResponse) GetAsPath() []int32

func (*TracerouteResponse) GetDestinationAddress 

func (x *TracerouteResponse) GetDestinationAddress() string

func (*TracerouteResponse) GetDestinationName 

func (x *TracerouteResponse) GetDestinationName() string

func (*TracerouteResponse) GetHop 

func (x *TracerouteResponse) GetHop() int32

func (*TracerouteResponse) GetHops 

func (x *TracerouteResponse) GetHops() int32

func (*TracerouteResponse) GetIcmpCode 

func (x *TracerouteResponse) GetIcmpCode() int32

func (*TracerouteResponse) GetMpls 

func (x *TracerouteResponse) GetMpls() map[string]string

func (*TracerouteResponse) GetName 

func (x *TracerouteResponse) GetName() string

func (*TracerouteResponse) GetPacketSize 

func (x *TracerouteResponse) GetPacketSize() int32

func (*TracerouteResponse) GetRtt 

func (x *TracerouteResponse) GetRtt() int64

func (*TracerouteResponse) GetState 

func (x *TracerouteResponse) GetState() TracerouteResponse_State

func (*TracerouteResponse) ProtoMessage 

func (*TracerouteResponse) ProtoMessage()

func (*TracerouteResponse) ProtoReflect 

func (x *TracerouteResponse) ProtoReflect() protoreflect.Message

func (*TracerouteResponse) Reset 

func (x *TracerouteResponse) Reset()

func (*TracerouteResponse) String 

func (x *TracerouteResponse) String() string

type TracerouteResponse_State 

type TracerouteResponse_State int32

State is the resulting state of a single traceoroute packet. 

const (
	TracerouteResponse_DEFAULT              TracerouteResponse_State = 0  // Normal hop response.
	TracerouteResponse_NONE                 TracerouteResponse_State = 1  // No response.
	TracerouteResponse_UNKNOWN              TracerouteResponse_State = 2  // Unknown response state.
	TracerouteResponse_ICMP                 TracerouteResponse_State = 3  // See icmp_code field.
	TracerouteResponse_HOST_UNREACHABLE     TracerouteResponse_State = 4  // Host unreachable.
	TracerouteResponse_NETWORK_UNREACHABLE  TracerouteResponse_State = 5  // Network unreachable.
	TracerouteResponse_PROTOCOL_UNREACHABLE TracerouteResponse_State = 6  // Protocol unreachable.
	TracerouteResponse_SOURCE_ROUTE_FAILED  TracerouteResponse_State = 7  // Source route failed.
	TracerouteResponse_FRAGMENTATION_NEEDED TracerouteResponse_State = 8  // Fragmentation needed.
	TracerouteResponse_PROHIBITED           TracerouteResponse_State = 9  // Communication administratively prohibited.
	TracerouteResponse_PRECEDENCE_VIOLATION TracerouteResponse_State = 10 // Host precedence violation.
	TracerouteResponse_PRECEDENCE_CUTOFF    TracerouteResponse_State = 11 // Precedence cutoff in  effect.
)

func (TracerouteResponse_State) Descriptor 

func (TracerouteResponse_State) Descriptor() protoreflect.EnumDescriptor

func (TracerouteResponse_State) Enum 

func (x TracerouteResponse_State) Enum() *TracerouteResponse_State

func (TracerouteResponse_State) EnumDescriptor deprecated 

func (TracerouteResponse_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use TracerouteResponse_State.Descriptor instead.

func (TracerouteResponse_State) Number 

func (x TracerouteResponse_State) Number() protoreflect.EnumNumber

func (TracerouteResponse_State) String 

func (x TracerouteResponse_State) String() string

func (TracerouteResponse_State) Type 

func (TracerouteResponse_State) Type() protoreflect.EnumType

type UnimplementedSystemServer 

type UnimplementedSystemServer struct {
}

UnimplementedSystemServer must be embedded to have forward compatible implementations.

func (UnimplementedSystemServer) CancelReboot 

func (UnimplementedSystemServer) CancelReboot(context.Context, *CancelRebootRequest) (*CancelRebootResponse, error)

func (UnimplementedSystemServer) KillProcess 

func (UnimplementedSystemServer) KillProcess(context.Context, *KillProcessRequest) (*KillProcessResponse, error)

func (UnimplementedSystemServer) Ping 

func (UnimplementedSystemServer) Ping(*PingRequest, System_PingServer) error

func (UnimplementedSystemServer) Reboot 

func (UnimplementedSystemServer) Reboot(context.Context, *RebootRequest) (*RebootResponse, error)

func (UnimplementedSystemServer) RebootStatus 

func (UnimplementedSystemServer) RebootStatus(context.Context, *RebootStatusRequest) (*RebootStatusResponse, error)

func (UnimplementedSystemServer) SetPackage 

func (UnimplementedSystemServer) SetPackage(System_SetPackageServer) error

func (UnimplementedSystemServer) SwitchControlProcessor 

func (UnimplementedSystemServer) SwitchControlProcessor(context.Context, *SwitchControlProcessorRequest) (*SwitchControlProcessorResponse, error)

func (UnimplementedSystemServer) Time 

func (UnimplementedSystemServer) Time(context.Context, *TimeRequest) (*TimeResponse, error)

func (UnimplementedSystemServer) Traceroute 

func (UnimplementedSystemServer) Traceroute(*TracerouteRequest, System_TracerouteServer) error

type UnsafeSystemServer 

type UnsafeSystemServer interface {
	// contains filtered or unexported methods
}

UnsafeSystemServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SystemServer will result in compilation errors.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.