package agentapi

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc ForwardRndcCommand (ForwardRndcCommandReq, ForwardRndcCommandRsp)

  agent.proto:18

  Forward rndc command and return results.

  message ForwardRndcCommandReq

  agent.proto:142

  • string Address = 1

    Daemon access control

  • int64 Port = 2

  • optional RndcRequest rndcRequest = 3

  message ForwardRndcCommandRsp

  agent.proto:158

  • optional Status status = 1

    Status of call execution.

  • optional RndcResponse rndcResponse = 2

• rpc ForwardToKeaOverHTTP (ForwardToKeaOverHTTPReq, ForwardToKeaOverHTTPRsp)

  agent.proto:24

  Forward commands (one or more) to Kea Control Agent and return results.

  message ForwardToKeaOverHTTPReq

  agent.proto:111

  • string url = 1

    URL to Kea CA

  • repeated KeaRequest keaRequests = 2

    List of requests to CA.

  message ForwardToKeaOverHTTPRsp

  agent.proto:128

  • optional Status status = 1

    Status of call execution.

  • repeated KeaResponse keaResponses = 2

    List of responses from CA.

• rpc ForwardToNamedStats (ForwardToNamedStatsReq, ForwardToNamedStatsRsp)

  agent.proto:21

  Forward statistics request to named daemon and return responses.

  message ForwardToNamedStatsReq

  agent.proto:170

  • string url = 1

    URL to named statistics-channel

  • string statsAddress = 2

  • int64 statsPort = 3

  • ForwardToNamedStatsReq.RequestType requestType = 4

  • optional NamedStatsRequest namedStatsRequest = 5

  message ForwardToNamedStatsRsp

  agent.proto:198

  • optional Status status = 1

    Status of call execution.

  • optional NamedStatsResponse namedStatsResponse = 2

• rpc GetPowerDNSServerInfo (GetPowerDNSServerInfoReq, GetPowerDNSServerInfoRsp)

  agent.proto:27

  Get the general server information from the PowerDNS server.

  message GetPowerDNSServerInfoReq

  agent.proto:206

  Request to fetch the general server information from the PowerDNS server.

  • string webserverAddress = 1

  • int64 webserverPort = 2

  message GetPowerDNSServerInfoRsp

  agent.proto:212

  Response containing the general server information from the PowerDNS server.

  • string type = 1

  • string id = 2

  • string daemonType = 3

  • string version = 4

  • string url = 5

  • string configURL = 6

  • string zonesURL = 7

  • string autoprimariesURL = 8

  • int64 uptime = 9

• rpc GetState (GetStateReq, GetStateRsp)

  agent.proto:15

  Get state of machine where agent is running. It gathers information about operations system, its version, CPU and available memory and runtime information like memory usage.

  message GetStateReq

  agent.proto:61

  (message has no fields)

  message GetStateRsp

  agent.proto:65

  State of machine and its system

  • string agentVersion = 1

  • repeated App apps = 2

  • string hostname = 3

  • int64 cpus = 4

  • string cpusLoad = 5

  • int64 memory = 6

  • int64 usedMemory = 7

  • int64 uptime = 8

  • string error = 9

  • string os = 10

  • string platform = 11

  • string platformFamily = 12

  • string platformVersion = 13

  • string kernelVersion = 14

  • string kernelArch = 15

  • string virtualizationSystem = 16

  • string virtualizationRole = 17

  • string hostID = 18

  • bool agentUsesHTTPCredentials = 19

    Parameter is no longer used, but it is kept for backward compatibility. Always false. TODO: Remove it when the API will be changed.

• rpc Ping (PingReq, PingRsp)

  agent.proto:11

  Check connectivity with machine.

  message PingReq

  agent.proto:55

  (message has no fields)

  message PingRsp

  agent.proto:58

  (message has no fields)

• rpc ReceiveZoneRRs (ReceiveZoneRRsReq, stream ReceiveZoneRRsRsp)

  agent.proto:37

  Retrieves the zone from the agent by returning cached resource records or running zone transfer if the zone has not been cached yet.

  message ReceiveZoneRRsReq

  agent.proto:285

  This request is sent from the server to the agent to receive the zone contents over a gRPC stream.

  • string controlAddress = 1

    Control address of the DNS server from which the zones are to be returned.

  • int64 controlPort = 2

    Control port of the DNS server from which the zones are to be returned.

  • string zoneName = 3

    Name of the zone for which the resource records are to be returned.

  • string viewName = 4

    Name of the view where the zone belongs.

  message ReceiveZoneRRsRsp

  agent.proto:299

  A response received over the stream when requesting the zone contents.

  • repeated string rrs = 1

• rpc ReceiveZones (ReceiveZonesReq, stream Zone)

  agent.proto:33

  Receives stream of zones from the agent.

  message ReceiveZonesReq

  agent.proto:244

  This request is sent from the server to the agent to receive the zones held in the zone inventories over a gRPC stream.

  • string controlAddress = 1

    Control address of the DNS server from which the zones are to be returned.

  • int64 controlPort = 2

    Control port of the DNS server from which the zones are to be returned.

  • string viewName = 3

    Filter the zones by view name.

  • string lowerBound = 4

    Lower bound zone name (i.e., only the zones ordered after this zone are returned.)

  • int64 limit = 5

    Maximum number of zones to be returned.

  • int64 loadedAfter = 6

    Filter the zones by load time. Only return the zones loaded after specified time.

  message Zone

  agent.proto:264

  A single zone returned over the stream.

  • string name = 1

    Zone name.

  • string class = 2

    Zone class (typically IN).

  • int64 serial = 3

    Zone serial number.

  • string type = 4

    Zone type (e.g., master).

  • int64 loaded = 5

    A timestamp when the zone was loaded as unix time.

  • string view = 6

    A name of the view where the zone belongs.

  • int64 totalZoneCount = 7

    Total number of zones.

  • bool rpz = 8

    Indicates if the zone is RPZ.

• rpc TailTextFile (TailTextFileReq, TailTextFileRsp)

  agent.proto:30

  Get the tail of the specified file, typically a log file.

  message TailTextFileReq

  agent.proto:225

  Log file tailing request

  • string path = 1

    File to be tailed.

  • int64 offset = 2

    Seek info. The offset is counted from the end of file.

  message TailTextFileRsp

  agent.proto:234

  Log file tailing response

  • optional Status status = 1

    Call execution status.

  • repeated string lines = 2

    Array of lines.

Application access point

Used in: App

• string type = 1

  currently supported types are: "control" and "statistics"

• string address = 2

• int64 port = 3

• string key = 4

• bool useSecureProtocol = 5

Basic information about application.

Used in: GetStateRsp

• string type = 1

  currently supported types are: "kea" and "bind9"

• repeated AccessPoint accessPoints = 2

Used in: ForwardToNamedStatsReq

• DEFAULT = 0

• STATUS = 1

• SERVER = 2

• ZONES = 3

• NETWORK = 4

• MEMORY = 5

• TRAFFIC = 6

• SERVER_AND_TRAFFIC = 7

Request to Kea CA.

Used in: ForwardToKeaOverHTTPReq

• string request = 1

  Request to Kea CA, JSON encoded as string.

Response from Kea CA.

Used in: ForwardToKeaOverHTTPRsp

• bytes response = 1

  Response from CA.

• optional Status status = 2

  Status of request execution.

Request to named statistics-channel.

Used in: ForwardToNamedStatsReq

• string request = 1

Response from named statistics-channel

Used in: ForwardToNamedStatsRsp

• string response = 1

• optional Status status = 2

  Status of request execution.

Request to rndc.

Used in: ForwardRndcCommandReq

• string request = 1

  Request to rndc

Response from Rndc.

Used in: ForwardRndcCommandRsp

• string response = 1

  Response from rndc.

• optional Status status = 2

  Status of request execution.

Used in: ForwardRndcCommandRsp, ForwardToKeaOverHTTPRsp, ForwardToNamedStatsRsp, KeaResponse, NamedStatsResponse, RndcResponse, TailTextFileRsp

• Status.StatusCode code = 1

  A simple error code that can be easily handled by the client.

• string message = 2

  An error message in English.

Used in: Status

• OK = 0

• ERROR = 1