package gnmi_ext

Get desktop application:
View/edit binary Protocol Buffers messages

Commit confirmed extension allows automated revert of the configuration after certain duration if an explicit confirmation is not issued. It allows explicit cancellation of the commit during the rollback window. There cannot be more than one commit active at a given time. The document about gNMI commit confirmed can be found at https://github.com/openconfig/reference/blob/master/rpc/gnmi/gnmi-commit-confirmed.md

Used in: Extension

• string id = 1

  ID is provided by the client during the commit request. During confirm and cancel actions the provided ID should match the ID provided during commit. If ID is not passed in any actions server shall return error. Required.

• oneof action

  • CommitRequest commit = 2

    commit action creates a new commit. If a commit is on-going, server returns error.

  • CommitConfirm confirm = 3

    confirm action will confirm an on-going commit, the ID provided during confirm should match the on-going commit ID.

  • CommitCancel cancel = 4

    cancel action will cancel an on-going commit, the ID provided during cancel should match the on-going commit ID.

  • CommitSetRollbackDuration set_rollback_duration = 5

    set rollback duration action sets the rollback duration of an on-going commit to a new value. The ID provided with the Commit message should match the on-going commit ID.

CommitCancel is used to cancel an on-going commit. It hold additional parameter required for cancel action.

Used in: Commit

(message has no fields)

CommitConfirm is used to confirm an on-going commit. It hold additional parameter required for confirm action.

Used in: Commit

(message has no fields)

CommitRequest is used to create a new confirmed commit. It hold additional parameter required for commit action.

Used in: Commit

• optional google.protobuf.Duration rollback_duration = 1

  Maximum duration to wait for a confirmaton before reverting the commit.

CommitSetRollbackDuration is used to set the existing rollback duration value of an on-going commit to a new desired value.

Used in: Commit

• optional google.protobuf.Duration rollback_duration = 1

  Maximum duration to wait for a confirmaton before reverting the commit.

ConfigSubscription extension allows clients to subscribe to configuration schema nodes only.

Used in: Extension

• oneof action

  • ConfigSubscriptionStart start = 1

    ConfigSubscriptionStart is sent by the client in the SubscribeRequest

  • ConfigSubscriptionSyncDone sync_done = 2

    ConfigSubscriptionSyncDone is sent by the server in the SubscribeResponse

ConfigSubscriptionStart is used to indicate to a target that for a given set of paths in the SubscribeRequest, the client wishes to receive updates for the configuration schema nodes only.

Used in: ConfigSubscription

(message has no fields)

ConfigSubscriptionSyncDone is sent by the server in the SubscribeResponse after all the updates for the configuration schema nodes have been sent.

Used in: ConfigSubscription

• string commit_confirm_id = 1

  ID of a commit confirm operation as assigned by the client see Commit Confirm extension for more details.

• string server_commit_id = 2

  ID of a commit as might be assigned by the server when registering a commit operation.

• bool done = 3

  If true indicates that the server is done processing the updates related to the commit_confirm_id and/or server_commit_id.

Depth allows clients to specify the depth of the subtree to be returned in the response. The depth is specified as the number of levels below the specified path. The depth is applied to all paths in the Get or Subscribe request. The document about gNMI depth can be found at https://github.com/openconfig/reference/tree/master/rpc/gnmi/gnmi-depth.md

Used in: Extension

• uint32 level = 1

  The level of the subtree to be returned in the response. Value of 0 means no depth limit and behaves the same as if the extension was not specified. Value of 1 means only the specified path and its direct children will be returned.

The Extension message contains a single gNMI extension.

Used in: gnmi.CapabilityRequest, gnmi.CapabilityResponse, gnmi.GetRequest, gnmi.GetResponse, gnmi.SetRequest, gnmi.SetResponse, gnmi.SubscribeRequest, gnmi.SubscribeResponse

• oneof ext

  • RegisteredExtension registered_ext = 1

    A registered extension.

  • MasterArbitration master_arbitration = 2

    Well known extensions.

    Master arbitration extension.

  • History history = 3

    History extension.

  • Commit commit = 4

    Commit confirmed extension.

  • Depth depth = 5

    Depth extension.

  • ConfigSubscription config_subscription = 6

    Config Subscription extension.

RegisteredExtension is an enumeration acting as a registry for extensions defined by external sources.

Used in: RegisteredExtension

• EID_UNSET = 0

  New extensions are to be defined within this enumeration - their definition MUST link to a reference describing their implementation.

• EID_EXPERIMENTAL = 999

  An experimental extension that may be used during prototyping of a new extension.

The History extension allows clients to request historical data. Its spec can be found at https://github.com/openconfig/reference/blob/master/rpc/gnmi/gnmi-history.md

Used in: Extension

• oneof request

  • int64 snapshot_time = 1

    Nanoseconds since the epoch

  • TimeRange range = 2

MasterArbitration is used to select the master among multiple gNMI clients with the same Roles. The client with the largest election_id is honored as the master. The document about gNMI master arbitration can be found at https://github.com/openconfig/reference/blob/master/rpc/gnmi/gnmi-master-arbitration.md

Used in: Extension

• optional Role role = 1

• optional Uint128 election_id = 2

The RegisteredExtension message defines an extension which is defined outside of this file.

Used in: Extension

• ExtensionID id = 1

  The unique ID assigned to this extension.

• bytes msg = 2

  The binary-marshalled protobuf extension payload.

There can be one master for each role. The role is identified by its id.

Used in: MasterArbitration

• string id = 1

  More fields can be added if needed, for example, to specify what paths the role can read/write.

Used in: History

• int64 start = 1

  Nanoseconds since the epoch

• int64 end = 2

  Nanoseconds since the epoch

Representation of unsigned 128-bit integer.

Used in: MasterArbitration

• uint64 high = 1

• uint64 low = 2