{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"7458b8e5-5609-43f8-9ad6-d1d21e9a21fe"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}}}},{"type":"heading","attrs":{"level":1},"content":[{"text":"Introduction","type":"text"}]},{"type":"paragraph","content":[{"text":"Please refer to ","type":"text"},{"text":"Configd Client Library","type":"text","marks":[{"type":"link","attrs":{"href":"https://danosproject.atlassian.net/wiki/spaces/DAN/pages/684621974/Configd+Client+Library"}}]},{"text":" for the general concepts behind the API. This document will cover only C++ specifics.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Mechanics","type":"text"}]},{"type":"paragraph","content":[{"text":"Before we can use the configd API we need to establish a connection to the daemon, instantiating the CfgClient object will do this. The destructor for the client object will close the connection.","type":"text"}]},{"type":"table","attrs":{"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[680.0]},"content":[{"type":"codeBlock","content":[{"text":"#include \nint main() {\n\tCfgClient client;\n}","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Once connected we can do a variety of actions on the system, one can configure the device, request the operational state of the device, or perform feature specific RPCs. When configuring the device via the Configd APIs one follows much the same procedure as with the CLI. One creates a configuration session, makes changes, commits those changes, then tears down the session. One may view the RUNNING datastore without a session being created. Sessions persist process exit and must be explicitly removed with SessionTeardown. The minimal configuration application looks like the following.","type":"text"}]},{"type":"table","attrs":{"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[680.0]},"content":[{"type":"codeBlock","content":[{"text":"#include \n#include \n#include \n#include \n#include \nint main() {\n\tCfgClient client;\n\tstringstream ss;\n\tss << getpid();\n\tclient.SessionSetup(ss.str());\n\t// do something to the configuration\n\tclient.SessionTeardown();\n}","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"From here, one may perform actions similar to what one does on the CLI. Since the interface here is meant for programatic interaction, one may also introspect on the data-model and the current state of the candidate tree to determine available actions, this is similar to using \"tab-completion\" to inspect the CLI.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Examples","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Configuration","type":"text"}]},{"type":"paragraph","content":[{"text":"The following example uses the C++ configd API to set all dataplane interfaces to listen for DHCP addresses if no other address is assigned to that interface. While this is a silly thing to do, it demonstrates the basic mechanics of the this API.","type":"text"}]},{"type":"table","attrs":{"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[680.0]},"content":[{"type":"codeBlock","content":[{"text":"#include \n#include \n#include \n#include \n#include \n#include \n#include \n\nusing namespace std;\n\nvoid setup_interface_address(CfgClient& client, string intf_name) {\n\tcout << intf_name << \":\";\n\tvector path { \"interfaces\", \"dataplane\", intf_name, \"address\" };\n\tauto addrs = client.NodeGet(CfgClient::AUTO, path);\n\tcopy(addrs.begin(), addrs.end(), ostream_iterator(cout, \", \"));\n\tcout << endl;\n\tif (addrs.size() == 0) {\n\t\tpath.push_back(\"dhcp\");\n\t\tclient.Set(path);\n\t}\n}\n\nint main() {\n\tCfgClient client;\n\tstringstream ss;\n\tss << getpid();\n\tclient.SessionSetup(ss.str());\n\ttry {\n\t\tfor (auto interface : client.NodeGet(CfgClient::AUTO,\n\t\t\t{ \"interfaces\", \"dataplane\" })) {\n\t\t\tsetup_interface_address(client, interface);\n\t\t}\n\t\tclient.Commit(\"setup interface addresses\");\n\t} catch (CfgClientException e) {\n\t\tcerr << e.what();\n\t}\n\tclient.SessionTeardown();\n\treturn 0;\n}","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Below is a sample run of the above application.","type":"text"}]},{"type":"table","attrs":{"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[680.0]},"content":[{"type":"codeBlock","content":[{"text":"$ g++ -std=c++11 -lvyatta-config -o configdapi configdapi.cpp\n$ ./configdapi\ndp0s3:10.156.58.201/23,\ndp0s10:\ndp0s11:","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"RPC","type":"text"}]},{"type":"paragraph","content":[{"text":"One can also call an RPC via this interface.","type":"text"}]},{"type":"table","attrs":{"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[680.0]},"content":[{"type":"codeBlock","content":[{"text":"#include \n#include \n#include \n#include \n\nusing namespace std;\n\nint main() {\n CfgClient client;\n Json::Value input;\n Json::Value output;\n Json::Reader reader;\n\n input[\"host\"] = \"1.1.1.1\";\n auto outputs = client.CallRPC(\"vyatta-op-v1\", \"ping\", input.toStyledString());\n reader.parse(outputs, output);\n\n cout << \"rx-packet-count \" << output[\"rx-packet-count\"] << endl;\n}","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Below is an example run of the RPC application.","type":"text"}]},{"type":"table","attrs":{"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[680.0]},"content":[{"type":"codeBlock","content":[{"text":"$ g++ -std=c++11 -lvyatta-config $(pkg-config --cflags --libs jsoncpp) -o configdapi configdapi.cpp\n$ ./configdapi\nrx-packet-count 3","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Operational State Data","type":"text"}]},{"type":"paragraph","content":[{"text":"Finally one may query for operational data information.","type":"text"}]},{"type":"table","attrs":{"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[680.0]},"content":[{"type":"codeBlock","content":[{"text":"#include \n#include \n#include \n#include \n\nusing namespace std;\n\nint main() {\n CfgClient client;\n Json::Value tree;\n Json::Reader reader;\n\n auto trees = client.TreeGetFullEncoding(\n CfgClient::AUTO,\n {\"system\", \"state\", \"platform\"},\n \"rfc7951\"\n );\n reader.parse(trees, tree);\n cout << \"OS Release:\" << tree[\"vyatta-system-v1:platform\"][\"os-release\"] << endl;\n}","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Below is an example execution of this program.","type":"text"}]},{"type":"table","attrs":{"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[680.0]},"content":[{"type":"codeBlock","content":[{"text":"$ g++ -std=c++11 -lvyatta-config $(pkg-config --cflags --libs jsoncpp) -o configdapi configdapi.cpp\n$ ./configdapi\nOS Release:\"Vyatta:Master\"","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Man Page","type":"text"}]},{"type":"paragraph","content":[{"text":"The following documentation was generated automatically using Doxygen.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"CfgClient","type":"text"}]},{"type":"table","attrs":{"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[680.0]},"content":[{"type":"codeBlock","content":[{"text":"CfgClient(3)\t\t Vyatta Configuration System\t\t CfgClient(3)\n\n\n\nNAME\n CfgClient\n\nSYNOPSIS\n #include \n\n Public Types\n enum Database { AUTO, RUNNING, CANDIDATE, EFFECTIVE }\n enum NodeStatus { UNCHANGED, CHANGED, ADDED, DELETED }\n enum NodeType { LEAF, MULTI, CONTAINER, TAG }\n\n Public Member Functions\n CfgClient () throw (CfgClientFatalException)\n ~CfgClient ()\n void SessionAttach (const std::string &sessid) throw\n\t (CfgClientException)\n void SessionSetup (const std::string &sessid) throw\n\t (CfgClientException)\n void SessionTeardown ()\tthrow (CfgClientException)\n bool SessionChanged () throw (CfgClientException)\n bool SessionSaved () throw (CfgClientException)\n void SessionMarkSaved () throw (CfgClientException)\n void SessionMarkUnsaved () throw (CfgClientException)\n bool SessionLocked () throw (CfgClientException)\n void SessionLock () throw (CfgClientException)\n void SessionUnlock () throw (CfgClientException)\n bool SessionExists () throw (CfgClientException)\n std::string Set (const std::vector< std::string > &path) throw\n\t (CfgClientException)\n std::string Delete (const std::vector< std::string > &path) throw\n\t (CfgClientException)\n std::string ValidatePath (const std::vector< std::string > &path)\n\t throw (CfgClientException)\n std::string Commit (const std::string &comment)\tthrow\n\t (CfgClientException)\n std::string Discard () throw (CfgClientException)\n std::string Validate ()\tthrow (CfgClientException)\n std::string Save () throw (CfgClientException)\n bool Load (const std::string &file) throw (CfgClientException)\n bool Merge (const std::string &file) throw (CfgClientException)\n std::map< std::string, std::string > TemplateGet (const std::vector<\n\t std::string > &path) throw (CfgClientException)\n std::vector< std::string > TemplateGetChildren (const std::vector<\n\t std::string > &path) throw (CfgClientException)\n std::vector< std::string > TemplateGetAllowed (const std::vector<\n\t std::string > &path) throw (CfgClientException)\n bool TemplateValidatePath (const std::vector< std::string > &path)\n\t throw (CfgClientException)\n bool TemplateValidateValues (const std::vector< std::string > &path)\n\t throw (CfgClientException)\n std::map< std::string, std::vector< std::string > > GetFeatures (void)\n\t throw (CfgClientException)\n std::map< std::string, std::string > GetHelp (const std::vector<\n\t std::string > &path, bool FromSchema) throw (CfgClientException)\n bool NodeExists (Database db, const std::vector< std::string > &path)\n\t throw (CfgClientException)\n bool NodeIsDefault (Database db, const std::vector< std::string >\n\t &path) throw (CfgClientException)\n std::vector< std::string > NodeGet (Database db, const std::vector<\n\t std::string > &path) throw (CfgClientException)\n NodeStatus NodeGetStatus (Database db, const std::vector< std::string >\n\t &path) throw (CfgClientException)\n NodeType NodeGetType (const std::vector< std::string > &path) throw\n\t (CfgClientException)\n std::string TreeGetEncoding (Database db, const std::vector<\n\t std::string > &path, const std::string &encoding) throw\n\t (CfgClientException)\n std::string TreeGetFullEncoding (Database db, const std::vector<\n\t std::string > &path, const std::string &encoding) throw\n\t (CfgClientException)\n std::string TreeGet (Database db, const std::vector< std::string >\n\t &path) throw (CfgClientException)\n std::string TreeGetXML (Database db, const std::vector< std::string >\n\t &path) throw (CfgClientException)\n std::string TreeGetInternal (Database db, const std::vector<\n\t std::string > &path) throw (CfgClientException)\n std::string TreeGetFull (Database db, const std::vector< std::string >\n\t &path) throw (CfgClientException)\n std::string TreeGetFullXML (Database db, const std::vector< std::string\n\t > &path) throw (CfgClientException)\n std::string TreeGetFullInternal (Database db, const std::vector<\n\t std::string > &path) throw (CfgClientException)\n std::string CallRPC (const std::string ns, const std::string name,\n\t const std::string input) throw (CfgClientException)\n std::string CallRPCXML (const std::string ns, const std::string name,\n\t const std::string input) throw (CfgClientException)\n std::string EditConfigXML (const std::string target, const std::string\n\t default_operation, const std::string test_option, const std::string\n\t error_option, const std::string config) throw (CfgClientException)\n\nMember Enumeration Documentation\n enum CfgClient::Database\n Database defines what database to use for the query.\n\n Enumerator\n\n AUTO AUTO will select CANDIDATE when the client is attached to a\n\t session, RUNNING otherwise.\n\n RUNNING\n\t RUNNING is the current running configuration.\n\n CANDIDATE\n\t CANDIDATE is the current session's temporary database. RUNNING\n\t if there is no session. In other words this tries to do the\n\t right thing.\n\n EFFECTIVE\n\t EFFECTIVE is DEPRECATED, do not use unless you know why you are\n\t using it.\n\n Deprecated\n\t This is treated as CANDIDATE but left for compatibility with older\n\t uses.\n\n\n\n enum CfgClient::NodeStatus\n NodeStatus() represents the current change status of the node. When\n querying the RUNNING tree this will always be UNCHANGED. When querying\n the CANDIDATE tree this will be the change state when compared to the\n RUNNING tree.\n\n Enumerator\n\n UNCHANGED\n\t UNCHANGED the values are the same in RUNNING and CANDIDATE\n\n CHANGED\n\t CHANGED the values are different in RUNNING and CANDIDATE\n\n ADDED ADDED the value is new in the CANDIDATE tree\n\n DELETED\n\t DELETED the value has been removed from the CANDIDATE tree.\n\n enum CfgClient::NodeType\n NodeType is DEPRECATED\n\n Deprecated\n\t The documenation here is for understanding old users of this\n\t method. NodeType represents the older Vyatta specific names for\n\t node types. These map roughly to the YANG types as follows. Lists\n\t in the Vyatta system are represented by the key being part of the\n\t path. These 'list entries' are also represented as containers.\n\n\n Note: There is not currently a direct replacement for this API instead\n we encourage the use of the TreeGet with JSON_ENCODING so that the\n structure of the data returned reflects the schema information.\n\n Enumerator\n\n LEAF YANG leaf\n\n MULTI YANG leaf-list\n\n CONTAINER\n\t YANG container\n\n TAG YANG list\n\nConstructor & Destructor Documentation\n CfgClient::CfgClient ()CfgClientFatalException\n CfgClient() creates a new connection to configd. This will create a\n connection to configd and will inherit a configuration session from the\n environment if one exists. The CfgClientFatalException will be thrown\n if a connection cannot be established.\n\n CfgClient::~CfgClient ()\n ~CfgClient() disconnects from configd. This doesn't teardown\n configuration sessions automatically since this object may be used in a\n non-configuration or in a shared configuration context. Use\n SessionTeardown() to destroy sessions.\n\nMember Function Documentation\n void CfgClient::SessionAttach (const std::string &\n sessid)CfgClientException\n SessionAttach() attaches to the provided session id. If the session\n does not exist then an exception is raised.\n\n void CfgClient::SessionSetup (const std::string & sessid)CfgClientException\n SessionSetup() creates a new configuration session and makes that\n session the context for this instance object. Commonly the pid of the\n process is used as the session id, but this may be any arbitrary\n string.\n\n void CfgClient::SessionTeardown ()CfgClientException\n SessionTeardown() destroys a configuration session. Care should be\n taken that you really want to teardown the session, in some contexts it\n may not be appropriate for this client to destroy a session. All\n sessions should be destroyed as soon as they are no longer needed as\n configd maintains the state indefinitiely unless told to destroy it.\n\n bool CfgClient::SessionChanged ()CfgClientException\n SessionChanged() reports whether the current session has any\n configuration changes.\n\n bool CfgClient::SessionSaved ()CfgClientException\n SessionSaved() reports whether the current configuration session has\n been saved to the running configuration.\n\n void CfgClient::SessionMarkSaved ()CfgClientException\n SessionMarkSaved() allows one to effect the saved state of the session.\n\n Deprecated\n\t SessionMarkSaved is DEPRECATED.\n\n\n\n void CfgClient::SessionMarkUnsaved ()CfgClientException\n SessionMarkUnsaved() allows one to effect the saved state of the\n session.\n\n Deprecated\n\t SessionMarkUnsaved is DEPRECATED.\n\n\n\n bool CfgClient::SessionLocked ()CfgClientException\n SessionLocked() reports whether or not the current session is locked.\n Locks can be taken to prevent multiple writers to a shared session.\n Locks also prevent changes during commit. A session's lock is released\n if the client that took the lock disconnects.\n\n void CfgClient::SessionLock ()CfgClientException\n SessionLock() will attempt to lock the current session. If the session\n is currently locked then the exception will be raised.\n\n void CfgClient::SessionUnlock ()CfgClientException\n SessionUnlock() will attempt to unlock the current session. If the\n session is currently not locked by this process, then the exception\n will be raised.\n\n bool CfgClient::SessionExists ()CfgClientException\n SessionExists() reports whether the current session still exists. This\n allows for testing if a shared session has been torn down by another\n instance.\n\n std::string CfgClient::Set (const std::vector< std::string > &\n path)CfgClientException\n Set() creates a new path in the configuration datastore. The client\n needs to be attached to a configuration session for this call to work.\n If any error occurs that error is thrown as an exception. Creating a\n path that already exists is considered an error.\n\n Parameters\n\t path The path to the configuration represented as a vector\n\n Returns\n\t Any informational messages that occurred during set\n\n\n\n std::string CfgClient::Delete (const std::vector< std::string > &\n path)CfgClientException\n Delete() removes a path in the configuration datastore. The client\n needs to be attached to a configuration session for this call to work.\n If any error occurs that error is thrown as an exception. Deleting a\n path that does not exist is considered an error.\n\n Parameters\n\t path The path to the configuration represented as a vector\n\n Returns\n\t Any informational messages that occurred during delete\n\n\n\n std::string CfgClient::ValidatePath (const std::vector< std::string > &\n path)CfgClientException\n ValidatePath() checks that the path can be set\n\n Parameters\n\t path The path to the configuration represented as a vector\n\n Returns\n\t Any informational messages that occurred during the validation\n\t Invalid paths will throw an exception.\n\n\n\n std::string CfgClient::Commit (const std::string &\n comment)CfgClientException\n Commit() validates and applies the candidate configuration. The\n candidate configuration is applied to the running system resulting in\n the running configuration being updated if the transaction is\n successful.\n\n Parameters\n\t comment A comment that describes the changes during this commit. An\n\t empty string is allowed for no description.\n\n Returns\n\t Any informational messages reported during the commit.\n\n\n\n std::string CfgClient::Discard ()CfgClientException\n Discard() throws away all pending (uncommitted) changes for this\n session.\n\n std::string CfgClient::Validate ()CfgClientException\n Validate() checks that the candidate configuration meets all the\n constraints modeled in the schema.\n\n std::string CfgClient::Save ()CfgClientException\n Save() Saves the current running configuration to the 'saved'\n configuration.\n\n bool CfgClient::Load (const std::string & file)CfgClientException\n Load() Replaces the configuration with the config in the supplied file\n in the candidate database.\n\n bool CfgClient::Merge (const std::string & file)CfgClientException\n Merge() Merges the configuration with the config in the supplied file\n in the candidate database.\n\n std::map CfgClient::TemplateGet (const\n std::vector< std::string > & path)CfgClientException\n TemplateGet() is DEPRECATED.\n\n Deprecated\n\t The documenation here is for understanding old users of this\n\t method. This returns a map consisting of a template of the\n\t configuration data that is compatible with older internal Vyatta\n\t software. The names of the fields of this map are using old\n\t terminology and the types represented are not valid according to\n\t the YANG spec.\n\n Parameters\n\t path The path to the configuration represented as a vector\n\n Returns\n\t A map representing the values in the template. No more\n\t documentation will be provided for this, if you don't know what\n\t these values mean you shouldn't be using them.\n\n\n\n std::vector CfgClient::TemplateGetChildren (const std::vector<\n std::string > & path)CfgClientException\n TemplateGetChildren() access the children of the schema node at a given\n path Template is an old name kept for historical reasons; this accesses\n the YANG schema tree.\n\n Parameters\n\t path The path in the schema tree.\n\n Returns\n\t The children at the requested path.\n\n\n\n std::vector CfgClient::TemplateGetAllowed (const std::vector<\n std::string > & path)CfgClientException\n TemplateGetAllowed() runs the configd:allowed extension to get the help\n values for a value node in the schema tree. Template is an old name\n kept for historical reasons; this accesses the YANG schema tree.\n\n Parameters\n\t path The path in the schema tree.\n\n Returns\n\t The allowed values for the requested path.\n\n\n\n bool CfgClient::TemplateValidatePath (const std::vector< std::string > &\n path)CfgClientException\n TemplateValidatePath() determine if the path is valid according to the\n schema. Template is an old name kept for historical reasons; this\n accesses the YANG schema tree.\n\n Parameters\n\t path The path in the schema tree.\n\n Returns\n\t Whether the path is valid according to the schema.\n\n\n\n bool CfgClient::TemplateValidateValues (const std::vector< std::string > &\n path)CfgClientException\n TemplateValidatePathValues() determines if the path is valid according\n to the schema and validates all values according to the schema syntax.\n For historical reasons this is not the same as TemplateValidatePath,\n which does not evaluate syntax. Chances are this is the method one\n wants to use. Template is an old name kept for historical reasons; this\n accesses the YANG schema tree.\n\n Parameters\n\t path The path in the schema tree.\n\n Returns\n\t Whether the path is valid according to the schema.\n\n\n\n std::map > CfgClient::GetFeatures\n (void)CfgClientException\n GetFeatures() Get map of schema ids and the corresponding enabled\n features.\n\n Returns\n\t A map of schema features.\n\n\n\n std::map CfgClient::GetHelp (const std::vector<\n std::string > & path, bool FromSchema)CfgClientException\n GetHelp() returns a map containing the children and their help strings\n\n Parameters\n\t path The path of the parent for which one wants help as a vector\n\t FromSchema informs configd to generate help from the schema\n\t definition as well as from the data tree. If false help is from\n\t data existing in the tree only.\n\n\n\n bool CfgClient::NodeExists (Database db, const std::vector< std::string > &\n path)CfgClientException\n NodeExists() reports whether the path exists in the requested database.\n\n Parameters\n\t db The database one wishes to query.\n\t path The path to the configuration represented as a vector.\n\n Returns\n\t Whether the path exists in the requested database\n\n\n\n bool CfgClient::NodeIsDefault (Database db, const std::vector< std::string\n > & path)CfgClientException\n NodeIsDefault() reports whether the path is a default in the requested\n database.\n\n Parameters\n\t db The database one wishes to query.\n\t path The path to the configuration represented as a vector.\n\n Returns\n\t Whether the path is a default in the requested database\n\n\n\n std::vector CfgClient::NodeGet (Database db, const\n std::vector< std::string > & path)CfgClientException\n NodeGet() queries the database for the values at a given path.\n\n Parameters\n\t db The database one wishes to query.\n\t path The path to the configuration represented as a vector.\n\n Returns\n\t The children values of the given path.\n\n\n\n NodeStatus CfgClient::NodeGetStatus (Database db, const std::vector<\n std::string > & path)CfgClientException\n NodeGetStatus() reports the status of a node in the tree.\n\n Parameters\n\t db The database one wishes to query.\n\t path The path to the configuration represented as a vector.\n\n Returns\n\t The status of the node see NodeStatus for descriptions.\n\n\n\n NodeType CfgClient::NodeGetType (const std::vector< std::string > &\n path)CfgClientException\n NodeGetType() is DEPRECATED\n\n Deprecated\n\t The documenation here is for understanding old users of this\n\t method.\n\n Parameters\n\t path The path to the configuration represented as a vector.\n\n Returns\n\t NodeType represents the older Vyatta specific names for node types.\n\t See NodeType for information.\n\n\n\n std::string CfgClient::TreeGetEncoding (Database db, const std::vector<\n std::string > & path, const std::string & encoding)CfgClientException\n The below APIs support the following strings as encodings:\n\n\n\n\n Parameters\n\t db The database to get the tree From.\n\t path The configuration path at which to root the sub-tree.\n\t encoding The desired encoding.\n\n Returns\n\t A string in the desired encoding representing the tree at the given\n\t location.\n\n\n\n std::string CfgClient::TreeGetFullEncoding (Database db, const std::vector<\n std::string > & path, const std::string & encoding)CfgClientException\n TreeGetFullEncoding() provides access to sub-trees of the operational\n datastore. The operational datastore consists of the configuration\n database and any modeled operational state data. These trees are\n encoded in the desired encoding and returned as a string.\n\n Parameters\n\t db The database to get the tree From.\n\t path The configuration path at which to root the sub-tree.\n\t encoding The desired encoding.\n\n Returns\n\t A string in the desired encoding representing the tree at the given\n\t location.\n\n\n\n std::string CfgClient::TreeGet (Database db, const std::vector< std::string\n > & path)CfgClientException\n TreeGet() provides access to sub-trees of the configuration database.\n This call is equivalent to TreeGetEncoding with JSON_ENCODING.\n\n Parameters\n\t db The database to get the tree From.\n\t path The configuration path at which to root the sub-tree.\n\n Returns\n\t A string in the desired encoding representing the tree at the given\n\t location.\n\n\n\n std::string CfgClient::TreeGetXML (Database db, const std::vector<\n std::string > & path)CfgClientException\n TreeGetXML() provides access to sub-trees of the configuration\n database. This call is equivalent to TreeGetEncoding with XML_ENCODING.\n\n Parameters\n\t db The database to get the tree From.\n\t path The configuration path at which to root the sub-tree.\n\n Returns\n\t A string in the desired encoding representing the tree at the given\n\t location.\n\n\n\n std::string CfgClient::TreeGetInternal (Database db, const std::vector<\n std::string > & path)CfgClientException\n TreeGetInternal() provides access to sub-trees of the configuration\n database. This call is equivalent to TreeGetEncoding with\n INTERNAL_ENCODING.\n\n Parameters\n\t db The database to get the tree From.\n\t path The configuration path at which to root the sub-tree.\n\n Returns\n\t A string in the desired encoding representing the tree at the given\n\t location.\n\n\n\n std::string CfgClient::TreeGetFull (Database db, const std::vector<\n std::string > & path)CfgClientException\n TreeGetFull() provides access to sub-trees of the operational\n datastore. The operational datastore consists of the configuration\n database and any modeled operational state data. This call is\n equivalent to TreeGetFullEncoding with JSON_ENCODING.\n\n Parameters\n\t db The database to get the tree From.\n\t path The configuration path at which to root the sub-tree.\n\n Returns\n\t A string in the desired encoding representing the tree at the given\n\t location.\n\n\n\n std::string CfgClient::TreeGetFullXML (Database db, const std::vector<\n std::string > & path)CfgClientException\n TreeGetFullXML() provides access to sub-trees of the operational\n datastore. The operational datastore consists of the configuration\n database and any modeled operational state data. This call is\n equivalent to TreeGetFullEncoding with XML_ENCODING.\n\n Parameters\n\t db The database to get the tree From.\n\t path The configuration path at which to root the sub-tree.\n\n Returns\n\t A string in the desired encoding representing the tree at the given\n\t location.\n\n\n\n std::string CfgClient::TreeGetFullInternal (Database db, const std::vector<\n std::string > & path)CfgClientException\n TreeGetFullInternal() provides access to sub-trees of the operational\n datastore. The operational datastore consists of the configuration\n database and any modeled operational state data. This call is\n equivalent to TreeGetFullEncoding with INTERNAL_ENCODING.\n\n Parameters\n\t db The database to get the tree From.\n\t path The configuration path at which to root the sub-tree.\n\n Returns\n\t A string in the desired encoding representing the tree at the given\n\t location.\n\n\n\n std::string CfgClient::CallRPC (const std::string ns, const std::string\n name, const std::string input)CfgClientException\n CallRPC() Will call RPCs defined in yang data-models.\n\n Parameters\n\t ns The XML namespace for the model in which the RPC is defined.\n\t name The name of the RPC to call\n\t input The input definition of the schema defined in JSON_ENCODING.\n\n Returns\n\t The output schema defined in the RPC in JSON_ENCODING.\n\n\n\n std::string CfgClient::CallRPCXML (const std::string ns, const std::string\n name, const std::string input)CfgClientException\n CallRPCXML() Will call RPCs defined in yang data-models.\n\n Parameters\n\t ns The XML namespace for the model in which the RPC is defined.\n\t name The name of the RPC to call\n\t input The input definition of the schema defined in XML_ENCODING.\n\n Returns\n\t The output schema defined in the RPC in XML_ENCODING.\n\n\n\n std::string CfgClient::EditConfigXML (const std::string target, const\n std::string default_operation, const std::string test_option, const\n std::string error_option, const std::string config)CfgClientException\n EditConfigXML will perform a RFC-6241 edit-config operation, see\n RFC-6241 for more information.\n\n Parameters\n\t target The target datastore, can be 'candidate', 'running'.\n\t default_operation The operation to perform on any node that doesn't\n\t specify the operation, may be 'merge', 'replace', or 'none'.\n\t test_option The testing option, may be 'test-then-set', 'set', or\n\t 'test-only'.\n\t error_option The operation to perform when an error is encountered,\n\t may be 'stop-on-error', 'continue-on-error', or 'rollback-on-\n\t error'.\n\t config The XML data for an edit-config operation rooted at\n\t ''.\n\n\n\n\nAuthor\n Generated automatically by Doxygen for Vyatta Configuration System from\n the source code.\n\n\n\nVersion Version 0.104\t\tTue Jun 2 2020\t\t\t CfgClient(3)\n\n","type":"text"}]}]}]}]}],"version":1}

Browser not supported