b8641f30bd
* See [Augment auto-cli for hiding/modifying cli syntax #156](https://github.com/clicon/clixon/issues/156) and [hiding auto-generated CLI entries #153](https://github.com/clicon/clixon/issues/153) * Extensions can be used in augmentations * Extension `autocli-op` has been added to add "hidden" commands in the autocli * Documentation: https://clixon-docs.readthedocs.io/en/latest/misc.html#extensions
126 lines
4 KiB
YANG
126 lines
4 KiB
YANG
module clixon-lib {
|
|
yang-version 1.1;
|
|
namespace "http://clicon.org/lib";
|
|
prefix cl;
|
|
|
|
organization
|
|
"Clicon / Clixon";
|
|
|
|
contact
|
|
"Olof Hagsand <olof@hagsand.se>";
|
|
|
|
description
|
|
"Clixon Netconf extensions for communication between clients and backend.
|
|
|
|
***** BEGIN LICENSE BLOCK *****
|
|
Copyright (C) 2009-2019 Olof Hagsand
|
|
Copyright (C) 2020 Olof Hagsand and Rubicon Communications, LLC(Netgate)
|
|
|
|
This file is part of CLIXON
|
|
|
|
Licensed under the Apache License, Version 2.0 (the \"License\");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an \"AS IS\" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
|
|
Alternatively, the contents of this file may be used under the terms of
|
|
the GNU General Public License Version 3 or later (the \"GPL\"),
|
|
in which case the provisions of the GPL are applicable instead
|
|
of those above. If you wish to allow use of your version of this file only
|
|
under the terms of the GPL, and not to allow others to
|
|
use your version of this file under the terms of Apache License version 2,
|
|
indicate your decision by deleting the provisions above and replace them with
|
|
the notice and other provisions required by the GPL. If you do not delete
|
|
the provisions above, a recipient may use your version of this file under
|
|
the terms of any one of the Apache License version 2 or the GPL.
|
|
|
|
***** END LICENSE BLOCK *****";
|
|
|
|
revision 2020-12-08 {
|
|
description
|
|
"Added: autocli-op extension.
|
|
Released in clixon 4.9";
|
|
}
|
|
revision 2020-04-23 {
|
|
description
|
|
"Added: stats RPC for clixon XML and memory statistics.
|
|
Added: restart-plugin RPC for restarting individual plugins without restarting backend.";
|
|
}
|
|
revision 2019-08-13 {
|
|
description
|
|
"No changes (reverted change)";
|
|
}
|
|
revision 2019-06-05 {
|
|
description
|
|
"ping rpc added for liveness";
|
|
}
|
|
revision 2019-01-02 {
|
|
description
|
|
"Released in Clixon 3.9";
|
|
}
|
|
extension autocli-op {
|
|
description
|
|
"Takes an argument an operation defing how to modify the clispec at
|
|
this point in the YANG tree for the automated generated CLI.
|
|
Note that this extension is only used in clixon_cli.
|
|
Operations is expected to be extended, but the following operations are defined:
|
|
- hide This command is active but not shown by ? or TAB";
|
|
argument cliop;
|
|
}
|
|
rpc debug {
|
|
description "Set debug level of backend.";
|
|
input {
|
|
leaf level {
|
|
type uint32;
|
|
}
|
|
}
|
|
}
|
|
rpc ping {
|
|
description "Check aliveness of backend daemon.";
|
|
}
|
|
rpc stats {
|
|
description "Clixon XML statistics.";
|
|
output {
|
|
container global{
|
|
description "Clixon global statistics";
|
|
leaf xmlnr{
|
|
description "Number of XML objects: number of residing xml/json objects
|
|
in the internal 'cxobj' representation.";
|
|
type uint64;
|
|
}
|
|
}
|
|
list datastore{
|
|
description "Datastore statistics";
|
|
key "name";
|
|
leaf name{
|
|
description "name of datastore (eg running).";
|
|
type string;
|
|
}
|
|
leaf nr{
|
|
description "Number of XML objects. That is number of residing xml/json objects
|
|
in the internal 'cxobj' representation.";
|
|
type uint64;
|
|
}
|
|
leaf size{
|
|
description "Size in bytes of internal datastore cache of datastore tree.";
|
|
type uint64;
|
|
}
|
|
}
|
|
|
|
}
|
|
}
|
|
rpc restart-plugin {
|
|
description "Restart specific backend plugins.";
|
|
input {
|
|
leaf-list plugin {
|
|
description "Name of plugin to restart";
|
|
type string;
|
|
}
|
|
}
|
|
}
|
|
}
|