gnoi_system

package
v0.0.0-...-ad9c0bf Latest Latest
Warning

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

 Go to latest Published: Apr 22, 2019 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package gnoi_system is a generated protocol buffer package.

It is generated from these files: 

system/system.proto

It has these top-level messages: 

SwitchControlProcessorRequest
SwitchControlProcessorResponse
RebootRequest
RebootResponse
CancelRebootRequest
CancelRebootResponse
RebootStatusRequest
RebootStatusResponse
TimeRequest
TimeResponse
PingRequest
PingResponse
TracerouteRequest
TracerouteResponse
Package
SetPackageRequest
SetPackageResponse

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",
	6: "RESET",
	7: "POWERUP",
}
View Source 
var RebootMethod_value = map[string]int32{
	"UNKNOWN":   0,
	"COLD":      1,
	"POWERDOWN": 2,
	"HALT":      3,
	"WARM":      4,
	"NSF":       5,
	"RESET":     6,
	"POWERUP":   7,
}
View Source 
var TracerouteRequest_L4Protocol_name = map[int32]string{
	0: "ICMP",
	1: "TCP",
	2: "UDP",
}
View Source 
var TracerouteRequest_L4Protocol_value = map[string]int32{
	"ICMP": 0,
	"TCP":  1,
	"UDP":  2,
}
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",
}
View Source 
var 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,
}

Functions

func RegisterSystemServer 

func RegisterSystemServer(s *grpc.Server, srv SystemServer)

Types

type CancelRebootRequest 

type CancelRebootRequest struct {
	Message       string             `protobuf:"bytes,1,opt,name=message" json:"message,omitempty"`
	Subcomponents []*gnoi_types.Path `protobuf:"bytes,2,rep,name=subcomponents" json:"subcomponents,omitempty"`
}

A CancelRebootRequest requests the cancelation of any outstanding reboot request.

func (*CancelRebootRequest) Descriptor 

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

func (*CancelRebootRequest) GetMessage 

func (m *CancelRebootRequest) GetMessage() string

func (*CancelRebootRequest) GetSubcomponents 

func (m *CancelRebootRequest) GetSubcomponents() []*gnoi_types.Path

func (*CancelRebootRequest) ProtoMessage 

func (*CancelRebootRequest) ProtoMessage()

func (*CancelRebootRequest) Reset 

func (m *CancelRebootRequest) Reset()

func (*CancelRebootRequest) String 

func (m *CancelRebootRequest) String() string

type CancelRebootResponse 

type CancelRebootResponse struct {
}

func (*CancelRebootResponse) Descriptor 

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

func (*CancelRebootResponse) ProtoMessage 

func (*CancelRebootResponse) ProtoMessage()

func (*CancelRebootResponse) Reset 

func (m *CancelRebootResponse) Reset()

func (*CancelRebootResponse) String 

func (m *CancelRebootResponse) String() string

type Package 

type Package struct {
	// Destination path and filename of the package.
	Filename string `protobuf:"bytes,1,opt,name=filename" json:"filename,omitempty"`
	// Version of the package. (vendor internal name)
	Version string `protobuf:"bytes,4,opt,name=version" 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" json:"activate,omitempty"`
	// Details for the device to download the package from a remote location.
	RemoteDownload *gnoi_common.RemoteDownload `protobuf:"bytes,6,opt,name=remote_download,json=remoteDownload" json:"remote_download,omitempty"`
}

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

func (*Package) Descriptor 

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

func (*Package) GetActivate 

func (m *Package) GetActivate() bool

func (*Package) GetFilename 

func (m *Package) GetFilename() string

func (*Package) GetRemoteDownload 

func (m *Package) GetRemoteDownload() *gnoi_common.RemoteDownload

func (*Package) GetVersion 

func (m *Package) GetVersion() string

func (*Package) ProtoMessage 

func (*Package) ProtoMessage()

func (*Package) Reset 

func (m *Package) Reset()

func (*Package) String 

func (m *Package) String() string

type PingRequest 

type PingRequest struct {
	Destination   string                `protobuf:"bytes,1,opt,name=destination" json:"destination,omitempty"`
	Source        string                `protobuf:"bytes,2,opt,name=source" json:"source,omitempty"`
	Count         int32                 `protobuf:"varint,3,opt,name=count" json:"count,omitempty"`
	Interval      int64                 `protobuf:"varint,4,opt,name=interval" json:"interval,omitempty"`
	Wait          int64                 `protobuf:"varint,5,opt,name=wait" json:"wait,omitempty"`
	Size          int32                 `protobuf:"varint,6,opt,name=size" json:"size,omitempty"`
	DoNotFragment bool                  `protobuf:"varint,7,opt,name=do_not_fragment,json=doNotFragment" json:"do_not_fragment,omitempty"`
	DoNotResolve  bool                  `protobuf:"varint,8,opt,name=do_not_resolve,json=doNotResolve" json:"do_not_resolve,omitempty"`
	L3Protocol    gnoi_types.L3Protocol `protobuf:"varint,9,opt,name=l3protocol,enum=gnoi.types.L3Protocol" json:"l3protocol,omitempty"`
}

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 

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

func (*PingRequest) GetCount 

func (m *PingRequest) GetCount() int32

func (*PingRequest) GetDestination 

func (m *PingRequest) GetDestination() string

func (*PingRequest) GetDoNotFragment 

func (m *PingRequest) GetDoNotFragment() bool

func (*PingRequest) GetDoNotResolve 

func (m *PingRequest) GetDoNotResolve() bool

func (*PingRequest) GetInterval 

func (m *PingRequest) GetInterval() int64

func (*PingRequest) GetL3Protocol 

func (m *PingRequest) GetL3Protocol() gnoi_types.L3Protocol

func (*PingRequest) GetSize 

func (m *PingRequest) GetSize() int32

func (*PingRequest) GetSource 

func (m *PingRequest) GetSource() string

func (*PingRequest) GetWait 

func (m *PingRequest) GetWait() int64

func (*PingRequest) ProtoMessage 

func (*PingRequest) ProtoMessage()

func (*PingRequest) Reset 

func (m *PingRequest) Reset()

func (*PingRequest) String 

func (m *PingRequest) String() string

type PingResponse 

type PingResponse struct {
	Source   string `protobuf:"bytes,1,opt,name=source" json:"source,omitempty"`
	Time     int64  `protobuf:"varint,2,opt,name=time" json:"time,omitempty"`
	Sent     int32  `protobuf:"varint,3,opt,name=sent" json:"sent,omitempty"`
	Received int32  `protobuf:"varint,4,opt,name=received" json:"received,omitempty"`
	MinTime  int64  `protobuf:"varint,5,opt,name=min_time,json=minTime" json:"min_time,omitempty"`
	AvgTime  int64  `protobuf:"varint,6,opt,name=avg_time,json=avgTime" json:"avg_time,omitempty"`
	MaxTime  int64  `protobuf:"varint,7,opt,name=max_time,json=maxTime" json:"max_time,omitempty"`
	StdDev   int64  `protobuf:"varint,8,opt,name=std_dev,json=stdDev" json:"std_dev,omitempty"`
	Bytes    int32  `protobuf:"varint,11,opt,name=bytes" json:"bytes,omitempty"`
	Sequence int32  `protobuf:"varint,12,opt,name=sequence" json:"sequence,omitempty"`
	Ttl      int32  `protobuf:"varint,13,opt,name=ttl" json:"ttl,omitempty"`
}

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 

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

func (*PingResponse) GetAvgTime 

func (m *PingResponse) GetAvgTime() int64

func (*PingResponse) GetBytes 

func (m *PingResponse) GetBytes() int32

func (*PingResponse) GetMaxTime 

func (m *PingResponse) GetMaxTime() int64

func (*PingResponse) GetMinTime 

func (m *PingResponse) GetMinTime() int64

func (*PingResponse) GetReceived 

func (m *PingResponse) GetReceived() int32

func (*PingResponse) GetSent 

func (m *PingResponse) GetSent() int32

func (*PingResponse) GetSequence 

func (m *PingResponse) GetSequence() int32

func (*PingResponse) GetSource 

func (m *PingResponse) GetSource() string

func (*PingResponse) GetStdDev 

func (m *PingResponse) GetStdDev() int64

func (*PingResponse) GetTime 

func (m *PingResponse) GetTime() int64

func (*PingResponse) GetTtl 

func (m *PingResponse) GetTtl() int32

func (*PingResponse) ProtoMessage 

func (*PingResponse) ProtoMessage()

func (*PingResponse) Reset 

func (m *PingResponse) Reset()

func (*PingResponse) String 

func (m *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. Methods the target does not support should result in failure.

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

const (
	RebootMethod_UNKNOWN   RebootMethod = 0
	RebootMethod_COLD      RebootMethod = 1
	RebootMethod_POWERDOWN RebootMethod = 2
	RebootMethod_HALT      RebootMethod = 3
	RebootMethod_WARM      RebootMethod = 4
	RebootMethod_NSF       RebootMethod = 5
	RebootMethod_RESET     RebootMethod = 6
	RebootMethod_POWERUP   RebootMethod = 7
)

func (RebootMethod) EnumDescriptor 

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

func (RebootMethod) String 

func (x RebootMethod) String() string

type RebootRequest 

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

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

func (*RebootRequest) Descriptor 

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

func (*RebootRequest) GetDelay 

func (m *RebootRequest) GetDelay() uint64

func (*RebootRequest) GetForce 

func (m *RebootRequest) GetForce() bool

func (*RebootRequest) GetMessage 

func (m *RebootRequest) GetMessage() string

func (*RebootRequest) GetMethod 

func (m *RebootRequest) GetMethod() RebootMethod

func (*RebootRequest) GetSubcomponents 

func (m *RebootRequest) GetSubcomponents() []*gnoi_types.Path

func (*RebootRequest) ProtoMessage 

func (*RebootRequest) ProtoMessage()

func (*RebootRequest) Reset 

func (m *RebootRequest) Reset()

func (*RebootRequest) String 

func (m *RebootRequest) String() string

type RebootResponse 

type RebootResponse struct {
}

func (*RebootResponse) Descriptor 

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

func (*RebootResponse) ProtoMessage 

func (*RebootResponse) ProtoMessage()

func (*RebootResponse) Reset 

func (m *RebootResponse) Reset()

func (*RebootResponse) String 

func (m *RebootResponse) String() string

type RebootStatusRequest 

type RebootStatusRequest struct {
	Subcomponents []*gnoi_types.Path `protobuf:"bytes,1,rep,name=subcomponents" json:"subcomponents,omitempty"`
}

func (*RebootStatusRequest) Descriptor 

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

func (*RebootStatusRequest) GetSubcomponents 

func (m *RebootStatusRequest) GetSubcomponents() []*gnoi_types.Path

func (*RebootStatusRequest) ProtoMessage 

func (*RebootStatusRequest) ProtoMessage()

func (*RebootStatusRequest) Reset 

func (m *RebootStatusRequest) Reset()

func (*RebootStatusRequest) String 

func (m *RebootStatusRequest) String() string

type RebootStatusResponse 

type RebootStatusResponse struct {
	Active bool   `protobuf:"varint,1,opt,name=active" json:"active,omitempty"`
	Wait   uint64 `protobuf:"varint,2,opt,name=wait" json:"wait,omitempty"`
	When   uint64 `protobuf:"varint,3,opt,name=when" json:"when,omitempty"`
	Reason string `protobuf:"bytes,4,opt,name=reason" json:"reason,omitempty"`
	Count  uint32 `protobuf:"varint,5,opt,name=count" json:"count,omitempty"`
}

func (*RebootStatusResponse) Descriptor 

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

func (*RebootStatusResponse) GetActive 

func (m *RebootStatusResponse) GetActive() bool

func (*RebootStatusResponse) GetCount 

func (m *RebootStatusResponse) GetCount() uint32

func (*RebootStatusResponse) GetReason 

func (m *RebootStatusResponse) GetReason() string

func (*RebootStatusResponse) GetWait 

func (m *RebootStatusResponse) GetWait() uint64

func (*RebootStatusResponse) GetWhen 

func (m *RebootStatusResponse) GetWhen() uint64

func (*RebootStatusResponse) ProtoMessage 

func (*RebootStatusResponse) ProtoMessage()

func (*RebootStatusResponse) Reset 

func (m *RebootStatusResponse) Reset()

func (*RebootStatusResponse) String 

func (m *RebootStatusResponse) String() string

type SetPackageRequest 

type SetPackageRequest struct {
	// Types that are valid to be assigned to Request:
	//      *SetPackageRequest_Package
	//      *SetPackageRequest_Contents
	//      *SetPackageRequest_Hash
	Request isSetPackageRequest_Request `protobuf_oneof:"request"`
}

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 

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

func (*SetPackageRequest) GetContents 

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

func (*SetPackageRequest) GetHash 

func (m *SetPackageRequest) GetHash() *gnoi_types.HashType

func (*SetPackageRequest) GetPackage 

func (m *SetPackageRequest) GetPackage() *Package

func (*SetPackageRequest) GetRequest 

func (m *SetPackageRequest) GetRequest() isSetPackageRequest_Request

func (*SetPackageRequest) ProtoMessage 

func (*SetPackageRequest) ProtoMessage()

func (*SetPackageRequest) Reset 

func (m *SetPackageRequest) Reset()

func (*SetPackageRequest) String 

func (m *SetPackageRequest) String() string

func (*SetPackageRequest) XXX_OneofFuncs 

func (*SetPackageRequest) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

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 *gnoi_types.HashType `protobuf:"bytes,3,opt,name=hash,oneof"`
}

type SetPackageRequest_Package 

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

type SetPackageResponse 

type SetPackageResponse struct {
}

func (*SetPackageResponse) Descriptor 

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

func (*SetPackageResponse) ProtoMessage 

func (*SetPackageResponse) ProtoMessage()

func (*SetPackageResponse) Reset 

func (m *SetPackageResponse) Reset()

func (*SetPackageResponse) String 

func (m *SetPackageResponse) String() string

type SwitchControlProcessorRequest 

type SwitchControlProcessorRequest struct {
	ControlProcessor *gnoi_types.Path `protobuf:"bytes,1,opt,name=control_processor,json=controlProcessor" json:"control_processor,omitempty"`
}

func (*SwitchControlProcessorRequest) Descriptor 

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

func (*SwitchControlProcessorRequest) GetControlProcessor 

func (m *SwitchControlProcessorRequest) GetControlProcessor() *gnoi_types.Path

func (*SwitchControlProcessorRequest) ProtoMessage 

func (*SwitchControlProcessorRequest) ProtoMessage()

func (*SwitchControlProcessorRequest) Reset 

func (m *SwitchControlProcessorRequest) Reset()

func (*SwitchControlProcessorRequest) String 

func (m *SwitchControlProcessorRequest) String() string

type SwitchControlProcessorResponse 

type SwitchControlProcessorResponse struct {
	ControlProcessor *gnoi_types.Path `protobuf:"bytes,1,opt,name=control_processor,json=controlProcessor" json:"control_processor,omitempty"`
	Version          string           `protobuf:"bytes,2,opt,name=version" json:"version,omitempty"`
	Uptime           int64            `protobuf:"varint,3,opt,name=uptime" json:"uptime,omitempty"`
}

func (*SwitchControlProcessorResponse) Descriptor 

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

func (*SwitchControlProcessorResponse) GetControlProcessor 

func (m *SwitchControlProcessorResponse) GetControlProcessor() *gnoi_types.Path

func (*SwitchControlProcessorResponse) GetUptime 

func (m *SwitchControlProcessorResponse) GetUptime() int64

func (*SwitchControlProcessorResponse) GetVersion 

func (m *SwitchControlProcessorResponse) GetVersion() string

func (*SwitchControlProcessorResponse) ProtoMessage 

func (*SwitchControlProcessorResponse) ProtoMessage()

func (*SwitchControlProcessorResponse) Reset 

func (m *SwitchControlProcessorResponse) Reset()

func (*SwitchControlProcessorResponse) String 

func (m *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.  If a packet count is not explicitly provided,
	// 5 is used.
	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)
}

func NewSystemClient 

func NewSystemClient(cc *grpc.ClientConn) 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.  If a packet count is not explicitly provided,
	// 5 is used.
	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)
}

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 {
}

A TimeRequest requests the current time accodring to the target.

func (*TimeRequest) Descriptor 

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

func (*TimeRequest) ProtoMessage 

func (*TimeRequest) ProtoMessage()

func (*TimeRequest) Reset 

func (m *TimeRequest) Reset()

func (*TimeRequest) String 

func (m *TimeRequest) String() string

type TimeResponse 

type TimeResponse struct {
	Time uint64 `protobuf:"varint,1,opt,name=time" json:"time,omitempty"`
}

func (*TimeResponse) Descriptor 

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

func (*TimeResponse) GetTime 

func (m *TimeResponse) GetTime() uint64

func (*TimeResponse) ProtoMessage 

func (*TimeResponse) ProtoMessage()

func (*TimeResponse) Reset 

func (m *TimeResponse) Reset()

func (*TimeResponse) String 

func (m *TimeResponse) String() string

type TracerouteRequest 

type TracerouteRequest struct {
	Source        string                       `protobuf:"bytes,1,opt,name=source" json:"source,omitempty"`
	Destination   string                       `protobuf:"bytes,2,opt,name=destination" json:"destination,omitempty"`
	InitialTtl    uint32                       `protobuf:"varint,3,opt,name=initial_ttl,json=initialTtl" json:"initial_ttl,omitempty"`
	MaxTtl        int32                        `protobuf:"varint,4,opt,name=max_ttl,json=maxTtl" json:"max_ttl,omitempty"`
	Wait          int64                        `protobuf:"varint,5,opt,name=wait" json:"wait,omitempty"`
	DoNotFragment bool                         `protobuf:"varint,6,opt,name=do_not_fragment,json=doNotFragment" json:"do_not_fragment,omitempty"`
	DoNotResolve  bool                         `protobuf:"varint,7,opt,name=do_not_resolve,json=doNotResolve" json:"do_not_resolve,omitempty"`
	L3Protocol    gnoi_types.L3Protocol        `protobuf:"varint,8,opt,name=l3protocol,enum=gnoi.types.L3Protocol" json:"l3protocol,omitempty"`
	L4Protocol    TracerouteRequest_L4Protocol `protobuf:"varint,9,opt,name=l4protocol,enum=gnoi.system.TracerouteRequest_L4Protocol" json:"l4protocol,omitempty"`
}

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 

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

func (*TracerouteRequest) GetDestination 

func (m *TracerouteRequest) GetDestination() string

func (*TracerouteRequest) GetDoNotFragment 

func (m *TracerouteRequest) GetDoNotFragment() bool

func (*TracerouteRequest) GetDoNotResolve 

func (m *TracerouteRequest) GetDoNotResolve() bool

func (*TracerouteRequest) GetInitialTtl 

func (m *TracerouteRequest) GetInitialTtl() uint32

func (*TracerouteRequest) GetL3Protocol 

func (m *TracerouteRequest) GetL3Protocol() gnoi_types.L3Protocol

func (*TracerouteRequest) GetL4Protocol 

func (m *TracerouteRequest) GetL4Protocol() TracerouteRequest_L4Protocol

func (*TracerouteRequest) GetMaxTtl 

func (m *TracerouteRequest) GetMaxTtl() int32

func (*TracerouteRequest) GetSource 

func (m *TracerouteRequest) GetSource() string

func (*TracerouteRequest) GetWait 

func (m *TracerouteRequest) GetWait() int64

func (*TracerouteRequest) ProtoMessage 

func (*TracerouteRequest) ProtoMessage()

func (*TracerouteRequest) Reset 

func (m *TracerouteRequest) Reset()

func (*TracerouteRequest) String 

func (m *TracerouteRequest) String() string

type TracerouteRequest_L4Protocol 

type TracerouteRequest_L4Protocol int32
const (
	TracerouteRequest_ICMP TracerouteRequest_L4Protocol = 0
	TracerouteRequest_TCP  TracerouteRequest_L4Protocol = 1
	TracerouteRequest_UDP  TracerouteRequest_L4Protocol = 2
)

func (TracerouteRequest_L4Protocol) EnumDescriptor 

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

func (TracerouteRequest_L4Protocol) String 

func (x TracerouteRequest_L4Protocol) String() string

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" json:"destination_name,omitempty"`
	DestinationAddress string `protobuf:"bytes,2,opt,name=destination_address,json=destinationAddress" json:"destination_address,omitempty"`
	Hops               int32  `protobuf:"varint,3,opt,name=hops" json:"hops,omitempty"`
	PacketSize         int32  `protobuf:"varint,4,opt,name=packet_size,json=packetSize" json:"packet_size,omitempty"`
	// The following fields provide the disposition of a single traceroute
	// packet.
	Hop      int32                    `protobuf:"varint,5,opt,name=hop" json:"hop,omitempty"`
	Address  string                   `protobuf:"bytes,6,opt,name=address" json:"address,omitempty"`
	Name     string                   `protobuf:"bytes,7,opt,name=name" json:"name,omitempty"`
	Rtt      int64                    `protobuf:"varint,8,opt,name=rtt" json:"rtt,omitempty"`
	State    TracerouteResponse_State `protobuf:"varint,9,opt,name=state,enum=gnoi.system.TracerouteResponse_State" json:"state,omitempty"`
	IcmpCode int32                    `protobuf:"varint,10,opt,name=icmp_code,json=icmpCode" json:"icmp_code,omitempty"`
	Mpls     map[string]string        `` /* 129-byte string literal not displayed */
	AsPath   []int32                  `protobuf:"varint,12,rep,packed,name=as_path,json=asPath" json:"as_path,omitempty"`
}

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 

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

func (*TracerouteResponse) GetAddress 

func (m *TracerouteResponse) GetAddress() string

func (*TracerouteResponse) GetAsPath 

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

func (*TracerouteResponse) GetDestinationAddress 

func (m *TracerouteResponse) GetDestinationAddress() string

func (*TracerouteResponse) GetDestinationName 

func (m *TracerouteResponse) GetDestinationName() string

func (*TracerouteResponse) GetHop 

func (m *TracerouteResponse) GetHop() int32

func (*TracerouteResponse) GetHops 

func (m *TracerouteResponse) GetHops() int32

func (*TracerouteResponse) GetIcmpCode 

func (m *TracerouteResponse) GetIcmpCode() int32

func (*TracerouteResponse) GetMpls 

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

func (*TracerouteResponse) GetName 

func (m *TracerouteResponse) GetName() string

func (*TracerouteResponse) GetPacketSize 

func (m *TracerouteResponse) GetPacketSize() int32

func (*TracerouteResponse) GetRtt 

func (m *TracerouteResponse) GetRtt() int64

func (*TracerouteResponse) GetState 

func (m *TracerouteResponse) GetState() TracerouteResponse_State

func (*TracerouteResponse) ProtoMessage 

func (*TracerouteResponse) ProtoMessage()

func (*TracerouteResponse) Reset 

func (m *TracerouteResponse) Reset()

func (*TracerouteResponse) String 

func (m *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
	TracerouteResponse_NONE                 TracerouteResponse_State = 1
	TracerouteResponse_UNKNOWN              TracerouteResponse_State = 2
	TracerouteResponse_ICMP                 TracerouteResponse_State = 3
	TracerouteResponse_HOST_UNREACHABLE     TracerouteResponse_State = 4
	TracerouteResponse_NETWORK_UNREACHABLE  TracerouteResponse_State = 5
	TracerouteResponse_PROTOCOL_UNREACHABLE TracerouteResponse_State = 6
	TracerouteResponse_SOURCE_ROUTE_FAILED  TracerouteResponse_State = 7
	TracerouteResponse_FRAGMENTATION_NEEDED TracerouteResponse_State = 8
	TracerouteResponse_PROHIBITED           TracerouteResponse_State = 9
	TracerouteResponse_PRECEDENCE_VIOLATION TracerouteResponse_State = 10
	TracerouteResponse_PRECEDENCE_CUTOFF    TracerouteResponse_State = 11
)

func (TracerouteResponse_State) EnumDescriptor 

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

func (TracerouteResponse_State) String 

func (x TracerouteResponse_State) String() string

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.