package ziti.ctrl.pb

Get desktop application:
View/edit binary Protocol Buffers messages

• repeated string circuitIds = 1

• map<string, int64> idleTimes = 2

• string ingressId = 1

• string service = 2

• map<uint32, bytes> peerData = 3

ContentTypes should be in the range 1000 - 1999, to ensure they don't overlap with cmd_pb messages

• Zero = 0

• CircuitRequestType = 1000

• DialType = 1002

  defined in ctrl_msg/messages.go now CircuitSuccessType = 1001;

• LinkConnectedType = 1003

• FaultType = 1004

• RouteType = 1005

• UnrouteType = 1006

• MetricsType = 1007

• TogglePipeTracesRequestType = 1008

• TraceEventType = 1010

• CreateTerminatorRequestType = 1011

• RemoveTerminatorRequestType = 1012

• InspectRequestType = 1013

• InspectResponseType = 1014

• ValidateTerminatorsRequestType = 1017

  defined in ctrl_msg/messages.go now CircuitFailedType = 1016;

• UpdateTerminatorRequestType = 1018

• SettingsType = 1020

  VerifyLinkType = 1019; Unusable since links are now generated by routers

• CircuitConfirmationType = 1034

• RouterLinksType = 1035

• VerifyRouterType = 1036

• UpdateCtrlAddressesType = 1037

• RemoveTerminatorsRequestType = 1038

• QuiesceRouterRequestType = 1039

• DequiesceRouterRequestType = 1040

• ValidateTerminatorsV2RequestType = 1041

• ValidateTerminatorsV2ResponseType = 1042

• DecommissionRouterRequestType = 1043

• PeerStateChangeRequestType = 1050

• UpdateClusterLeaderRequestType = 1051

Used in: Route

• map<string, string> fields = 1

• uint32 channelMask = 2

• NoneHeader = 0

• ListenersHeader = 10

• RouterMetadataHeader = 11

• CapabilitiesHeader = 12

• string serviceId = 2

• string binding = 3

• string address = 4

• map<uint32, bytes> peerData = 5

• uint32 cost = 6

• TerminatorPrecedence precedence = 7

• string instanceId = 8

• bytes instanceSecret = 9

Used in: Route.Forward

• Start = 0

• End = 1

• Link = 2

• string linkId = 1

• string address = 2

• string routerId = 3

• string linkProtocol = 4

• string routerVersion = 5

• FaultSubject subject = 1

• string id = 2

• uint32 iteration = 3

Used in: Fault

• IngressFault = 0

• EgressFault = 1

• LinkFault = 2

• ForwardFault = 3

• UnknownOwnerForwardFault = 4

• LinkDuplicate = 5

• repeated string requestedValues = 1

• bool success = 1

• repeated string errors = 2

• repeated InspectResponse.InspectValue values = 3

Used in: InspectResponse

• string name = 1

• string value = 2

Used in: LinkConnected

• string id = 1

• string localAddr = 2

• string remoteAddr = 3

• string id = 1

• repeated LinkConn conns = 2

Used in: Listeners, PeerStateChange

• string address = 1

• string protocol = 2

• repeated string costTags = 3

• repeated string groups = 4

• string localBinding = 5

• repeated Listener listeners = 1

Used in: PeerStateChange

• Healthy = 0

• Unhealthy = 1

• Removed = 2

Used in: PeerStateChanges

• string id = 1

• string version = 2

• PeerState state = 3

• repeated Listener listeners = 4

• repeated PeerStateChange changes = 1

• string terminatorId = 1

• repeated string terminatorIds = 1

• string circuitId = 1

• uint32 attempt = 2

• optional Route.Egress egress = 3

• repeated Route.Forward forwards = 4

• optional Context context = 5

• uint64 timeout = 6

• map<string, string> tags = 7

Used in: Route

• string binding = 1

• string address = 2

• string destination = 3

• map<uint32, bytes> peerData = 4

Used in: Route

• string srcAddress = 1

• string dstAddress = 2

• DestType dstType = 3

Used in: RouterMetadata

• CapabilityZero = 0

• LinkManagement = 1

• repeated RouterLinks.RouterLink links = 1

Used in: RouterLinks

• string id = 1

• string destRouterId = 2

• string linkProtocol = 3

• repeated string linkCostTags = 4

• string dialAddress = 5

• uint32 iteration = 6

• repeated RouterCapability capabilities = 1

Used in: ValidateTerminatorsV2Response

• bool valid = 1

• TerminatorInvalidReason reason = 2

• string detail = 3

  inspect info if valid

• uint64 marker = 4

SettingTypes are used with the Settings message send arbitrary settings to routers. SettingTypes default to int32 which can be used seamlessly for keys in the Settings.data field

• UnusedSetting = 0

  unused, consume to avoid zero value accidents

• NewCtrlAddress = 1

  Sent to routers to notify them of a controller IP/hostname move

Settings are sent to to routers to configure arbitrary runtime settings.

• map<int32, bytes> data = 1

Used in: ValidateTerminatorsRequest, ValidateTerminatorsV2Request

• string id = 1

• string binding = 2

• string address = 3

• uint64 marker = 4

Used in: RouterTerminatorState

• UnknownBinding = 0

• UnknownTerminator = 1

• BadState = 2

Used in: CreateTerminatorRequest, UpdateTerminatorRequest

• Default = 0

• Required = 1

• Failed = 2

• string circuitId = 1

• bool now = 2

• uint64 index = 1

• repeated string addresses = 1

• uint64 index = 2

• bool isLeader = 3

• string terminatorId = 1

• bool updatePrecedence = 2

• bool updateCost = 3

• TerminatorPrecedence precedence = 4

• uint32 cost = 5

• repeated Terminator terminators = 1

• repeated Terminator terminators = 1

• bool fixInvalid = 2

• map<string, RouterTerminatorState> states = 1

• string routerId = 1

• repeated string fingerprints = 2