yumaworks-getbulk

Organization:

YumaWorks, Inc.

Module:

yumaworks-getbulk

Version:

2021-08-07

File:

yumaworks-getbulk.yang

Abstract:

Get bulk retrieval The <get-bulk> RPC operation provides controlled iteration procedure over instances of a YANG list object. ...

Contact:

Support <support at yumaworks.com>

Check for an additional details:

YANG Catalog

Description:

Get bulk retrieval

The <get-bulk> RPC operation provides controlled iteration
procedure over instances of a YANG list object.

Copyright (c) 2016 - 2021, YumaWorks, Inc. All rights reserved.

Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the BSD 3-Clause License
http://opensource.org/licenses/BSD-3-Clause.

+---x get-bulk
+---w input
| +---w datastore? enumeration
| +---w list-target string
| +---w count? uint32
| +---w depth? union
| +---w with-defaults? with-defaults-mode
| +---w last-keys
| +---w list-test yang:xpath1.0
| +---w fixed-keys
+--ro output
+--ro bulk
+--ro data
+--ro last-keys

Example Module

container top {
list A {
key 'k1 k2';
leaf k1 { type int32; }
leaf k2 { type string; }
list B {
key k3;
leaf k3 { type int32; }
leaf c1 { type int32; }
}
}
}

Basic Operation

Iterate over B within A entry '42, foo'

First request:

<get-bulk>
<list-target>/top/A=42,foo/B</list-target>
<count>3</count>
</get-bulk>

First reply: 3 instances of B are returned

<bulk>
<last-keys>
<k3>3</k3>
</last-keys>
<data>
<B>
<k3>1</k3>
<c1>100</c1>
</B>
<B>
<k3>2</k3>
<c1>87</c1>
</B>
<B>
<k3>3</k3>
<c1>16</c1>
</B>
</data>
</bulk>

Second request:

<get-bulk>
<list-target>/top/A=42,foo/B</list-target>
<count>3</count>
<last-keys>
<k3>3</k3>
</last-keys>
</get-bulk>