Re: [netmod] Action and RPC statements

Alexander Clemm <> Wed, 01 November 2017 18:31 UTC

Return-Path: <>
Received: from localhost (localhost []) by (Postfix) with ESMTP id 525BB13FA2C for <>; Wed, 1 Nov 2017 11:31:10 -0700 (PDT)
X-Virus-Scanned: amavisd-new at
X-Spam-Flag: NO
X-Spam-Score: -4.209
X-Spam-Status: No, score=-4.209 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, HTML_MESSAGE=0.001, RCVD_IN_DNSWL_MED=-2.3, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, SPF_PASS=-0.001, T_KAM_HTML_FONT_INVALID=0.01, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Received: from ([]) by localhost ( []) (amavisd-new, port 10024) with ESMTP id kiWpsrjKeL5D for <>; Wed, 1 Nov 2017 11:31:07 -0700 (PDT)
Received: from ( []) (using TLSv1 with cipher RC4-SHA (128/128 bits)) (No client certificate requested) by (Postfix) with ESMTPS id 2152B13943F for <>; Wed, 1 Nov 2017 11:31:05 -0700 (PDT)
Received: from (EHLO ([]) by (MOS 4.3.7-GA FastPath queued) with ESMTP id DRW04745; Wed, 01 Nov 2017 18:31:03 +0000 (GMT)
Received: from ( by ( with Microsoft SMTP Server (TLS) id 14.3.361.1; Wed, 1 Nov 2017 18:31:02 +0000
Received: from ([]) by ([]) with mapi id 14.03.0361.001; Wed, 1 Nov 2017 11:30:57 -0700
From: Alexander Clemm <>
To: Robert Wilton <>, Martin Bjorklund <>, "" <>, "" <>, Randy Presuhn <>, "Phil Shafer" <>
Thread-Topic: [netmod] Action and RPC statements
Thread-Index: AQHTTv5c6Thnq3+sH0epzy6XUWpHDqL+fHIA///AowCAAadVgP///J9w
Date: Wed, 1 Nov 2017 18:30:56 +0000
Message-ID: <>
References: <> <> <> <> <> <> <>
In-Reply-To: <>
Accept-Language: en-US
Content-Language: en-US
x-originating-ip: []
Content-Type: multipart/alternative; boundary="_000_644DA50AFA8C314EA9BDDAC83BD38A2E0EABB2BCsjceml521mbxchi_"
MIME-Version: 1.0
X-CFilter-Loop: Reflected
X-Mirapoint-Virus-RAPID-Raw: score=unknown(0), refid=str=0001.0A090204.59FA12E8.0044, ss=1, re=0.000, recu=0.000, reip=0.000, cl=1, cld=1, fgs=0, ip=, so=2013-06-18 04:22:30, dmn=2013-03-21 17:37:32
X-Mirapoint-Loop-Id: fa3987f3b39d45412b988ca8da762214
Archived-At: <>
Subject: Re: [netmod] Action and RPC statements
X-Mailman-Version: 2.1.22
Precedence: list
List-Id: NETMOD WG list <>
List-Unsubscribe: <>, <>
List-Archive: <>
List-Post: <>
List-Help: <>
List-Subscribe: <>, <>
X-List-Received-Date: Wed, 01 Nov 2017 18:31:10 -0000

Thanks, Rob
--- Alex

From: Robert Wilton []
Sent: Wednesday, November 01, 2017 4:43 AM
To: Alexander Clemm <>om>; Martin Bjorklund <>om>;;; Randy Presuhn <>du>; Phil Shafer <>
Subject: Re: [netmod] Action and RPC statements

Hi Alex,

On 31/10/2017 17:36, Alexander Clemm wrote:
Hi Rob,

A few comments, inline

--- Alex

From: netmod [] On Behalf Of Robert Wilton
Sent: Tuesday, October 31, 2017 7:14 AM
To: Martin Bjorklund <><>;<>;<>; Randy Presuhn <><>
Subject: Re: [netmod] Action and RPC statements


Here is another attempt for proposed text for Actions/RPC statements in NMDA.


6.2 Invocation of RPC Operations

This section updates section 7.14 of RFC 7950.

RPCs MAY be defined as affecting the contents of a specific datastore,
any configuration datastore (e.g., <edit-config>), or any datastore
(e.g., <get-data>).  The RPC definition specifies how the RPC input
data is interpreted by the server.

<ALEX> why “e.g., <get-data>”?  Does <get-data> affect the contents of the datastore – I thought it just gets data, hence this example is not ideal.

There is also no mention about the source of the “in” parameters.  It probably makes sense to mention that explicitly.

Perhaps something along the lines of “RPCs MAY be defined as _relating_ to the contents of a specific datastore….   Input data resolves to <operational>, as does output data, as do RPC side effects“.  Then below

“RPCs definitions that do not explicitly state an affected
datastore(s) _refer_to_  the general operational state of the server.”
Yes, that makes sense.

One other comment, it would be good to also indicate that when an RPC leads to modification of data nodes, what the “origin” of those modifications is.
That is an interesting question.

To describe this as a concrete example, if you have a single config true YANG list for dynamic/configuration subscriptions then a subscription can be created either via configuration or as an RPC operation.

I would probably classify this as "learned", and I think that we could extend the definition of the "learned" origin to cover this case.



RPCs definitions that do not explicitly state an affected
datastore(s) modify the general operational state of the server.
Hence, if any RPC input data relates to data node instances then
those would generally resolve to data node instances in the
<operational> data tree.

6.3 Invocation of Actions

This section updates section 7.15 of RFC 7950.

In YANG data models, the "action" statement may appear under "config
true" and "config false" schema nodes.  While instances of both
schema nodes may appear in <operational>, instances of "config true"
schema nodes may also appear in other datastores.

Actions are always invoked on a data node instance that exist in the
<operational> data tree.  The behavior defined by an action statement
is generally expected to affect the operational state of the server
rather than directly modifying the contents of any configuration

On a related note, I also want to confirm that it is right that RPC input data is always checked against operational:

Section 6.1. of the NMDA draft states:

   o  If the XPath expression is defined in a substatement to an "input"

      statement in an "rpc" or "action" statement, the accessible tree

      is the RPC or action operation instance and all operational state

      in the server.  The root node has top-level data nodes in all

      modules as children.  Additionally, for an RPC, the root node also

      has the node representing the RPC operation being defined as a

      child.  The node representing the operation being defined has the

      operation's input parameters as children.

Is <operational> always the right datastore to evaluate RPC input/output data relative to?  For most RPCs this seems to be the right choice by default but it also seems plausible that someone may wish to define an RPC that wants to validate its input parameters against the contents of another datastore.

An example could be an "is-applied" RPC that takes a path to a subtree in <running> or <intended> and checks whether the configuration for that subtree is fully represented in <operational>.


On 27/10/2017 09:33, Martin Bjorklund wrote:

Andy Bierman <><> wrote:

On Thu, Oct 26, 2017 at 11:22 AM, Randy Presuhn <<>> wrote:

Hi -

On 10/26/2017 10:44 AM, Robert Wilton wrote:

Hi ,

Separating out the issue regarding which datastore action and RPC apply

to, we propose the following NEW text to the datastores draft:

6.2 Invocation of Actions and RPC Operations

   This section updates section 7.15. of RFC 7950.

   In YANG data models, the "action" statement may appear under "config

   true" and "config false" schema nodes.  While instances of both

   schema nodes may appear in <operational>, instances of "config true"

   schema nodes may also appear in other datastores.

   An NMDA compliant server MUST execute all actions in the context of

   <operational>.  Likewise, an NMDA compliant server MUST invoke all RPC

   operations in the context of <operational>, unless the RPC is


   defined as affecting other datastores (e.g., <edit-config>).


A question - I understand the motivation for the "unless" for RPC

operations, but wonder why there is no similar "unless" for actions.

The <rpc> is not really in a datastore at all.

It may have input and output parameters with leafref and must/when


These are evaluated in the <operational> context.

The <rpc> may in fact be something like <edit-config>

which has parameters (like <config> to apply to

a specific datastore.

The action node is embedded within some data that has to be parsed

in a specific datastore before the action is processed.

This data is required to be in <operational>.

It also has XPath and leafref that needs to be resolved (same as <rpc>).

The side effects of the <rpc> or <action> can impact other datastores.

This would be defined in the description-stmt and this is not a problem.

This is exactly right.  We need to capture this in the text.



netmod mailing list<>