ba7f84afee
* NOTE: Due to an error in the previous implementation, all XPATH calls on the form `x[a=str]` where `str` is a string (not a number or XML symbol), must be changed to: `x[a='str'] or x[a="str"]`
* This includes all calls to `xpath_vec, xpath_first`, etc.
* All calls to cli_copy_config in CLI spec files must replace 2nd argument from `x[%s=%s]` to `x[%s='%s']`
* The old API is stillenabled. To define the new, define XPATH_USE_NEW in include/clixon_custom.h and recompile
70 lines
No EOL
3.7 KiB
Text
70 lines
No EOL
3.7 KiB
Text
# Common CLI syntax for both server and PMNode operatio mode
|
|
CLICON_MODE="example";
|
|
CLICON_PROMPT="%U@%H> ";
|
|
CLICON_PLUGIN="example_cli";
|
|
|
|
# Translate variable "value" by incrementing its characters
|
|
translate value (<value:string translate:incstr()>),cli_set("/translate/value");
|
|
|
|
# Note, when switching to PT, change datamodel to only @datamodel
|
|
set @datamodel:example, cli_set();
|
|
merge @datamodel:example, cli_merge();
|
|
create @datamodel:example, cli_create();
|
|
delete("Delete a configuration item") @datamodel:example, cli_del();
|
|
|
|
validate("Validate changes"), cli_validate();
|
|
commit("Commit the changes"), cli_commit();
|
|
quit("Quit"), cli_quit();
|
|
delete("Delete a configuration item") all("Delete whole candidate configuration"), delete_all("candidate");
|
|
|
|
startup("Store running as startup config"), db_copy("running", "startup");
|
|
no("Negate or remove") debug("Debugging parts of the system"), cli_debug_cli((int32)0);
|
|
debug("Debugging parts of the system"), cli_debug_cli((int32)1);{
|
|
level("Set debug level: 1..n") <level:int32>("Set debug level (0..n)"), cli_debug_backend();
|
|
}
|
|
copy("Copy and create a new object") {
|
|
interface("Copy interface"){
|
|
<name:string expand_dbvar("candidate","/interfaces/interface=%s/name")>("name of interface to copy from") to("Copy to interface") <toname:string>("Name of interface to copy to"), cli_copy_config("candidate","//interface[%s='%s']","name","name","toname");
|
|
}
|
|
}
|
|
discard("Discard edits (rollback 0)"), discard_changes();
|
|
compare("Compare running and candidate"), compare_dbs((int32)1);
|
|
compare("Compare running and candidate"), compare_dbs((int32)1);
|
|
|
|
show("Show a particular state of the system"){
|
|
xpath("Show configuration") <xpath:string>("XPATH expression"), show_conf_xpath("candidate");
|
|
version("Show version"), cli_show_version("candidate", "text", "/");
|
|
compare("Compare candidate and running databases"), compare_dbs((int32)0);{
|
|
xml("Show comparison in xml"), compare_dbs((int32)0);
|
|
text("Show comparison in text"), compare_dbs((int32)1);
|
|
}
|
|
configuration("Show configuration"), cli_show_config("candidate", "text", "/");{
|
|
xml("Show configuration as XML"), cli_show_config("candidate", "xml", "/");{
|
|
@datamodel:example, cli_show_auto("candidate", "text");
|
|
}
|
|
cli("Show configuration as CLI commands"), cli_show_config("candidate", "cli", "/");{
|
|
@datamodel:example, cli_show_auto("candidate", "cli");
|
|
}
|
|
netconf("Show configuration as netconf edit-config operation"), cli_show_config("candidate", "netconf", "/");{
|
|
@datamodel:example, cli_show_auto("candidate", "netconf");
|
|
}
|
|
text("Show configuration as text"), cli_show_config("candidate","text","/");{
|
|
@datamodel:example, cli_show_auto("candidate", "text");
|
|
}
|
|
json("Show configuration as JSON"), cli_show_config("candidate", "json", "/");{
|
|
@datamodel:example, cli_show_auto("candidate", "json");
|
|
}
|
|
}
|
|
}
|
|
|
|
save("Save candidate configuration to XML file") <filename:string>("Filename (local filename)"), save_config_file("candidate","filename");
|
|
load("Load configuration from XML file") <filename:string>("Filename (local filename)"),load_config_file("filename", "replace");{
|
|
replace("Replace candidate with file contents"), load_config_file("filename", "replace");
|
|
merge("Merge file with existent candidate"), load_config_file("filename", "merge");
|
|
}
|
|
example("This is a comment") <var:int32>("Just a random number"), mycallback("myarg");
|
|
rpc("ex:fib-route rpc") <instance:string>("routing instance"), fib_route_rpc("myarg");
|
|
notify("Get notifications from backend"), cli_notify("ROUTING", "1", "text");
|
|
no("Negate") notify("Get notifications from backend"), cli_notify("ROUTING", "0", "xml");
|
|
lock,cli_lock("candidate");
|
|
unlock,cli_unlock("candidate"); |