This is a vendor-agnostic PHP implementation of NETCONF. I developed this so I could extend a Junos (Juniper) specific NETCONF API off of it, and decided to share it publicly.
- RFC6241 - Network Configuration Protocol (NETCONF) - https://tools.ietf.org/html/rfc6241
- RFC6242 - Using the NETCONF Protocol over Secure Shell (SSH) - https://tools.ietf.org/html/rfc6242
- PHP >= 5.4
- phpseclib (https://github.com/phpseclib/phpseclib)
- Attributes for sendRaw need to be sanitized correctly (https://tools.ietf.org/html/rfc6241)
- Elements with attribute naming for subtree filters need to be implemented ("6.4.8. Elements with Attribute Naming")
- Parse capabilities based on IANA list: https://www.iana.org/assignments/netconf-capability-urns/netconf-capability-urns.xhtml
$netConf = new NetConf(
"192.168.0.100",
new NetConfAuthPassword(
[
"username" => "lamoni",
"password" => "phpsux"
]
)
);
echo $netConf->sendRPC(
"<get-config>".
"<source>".
"<running/>".
"</source>".
"</get-config>"
);
$netConf->editConfig(
"<configuration>
<interfaces>
<interface>
<name>fe-0/0/0</name>
<description>Testing netconf</description>
</interface>
</interfaces>
</configuration>",
'candidate',
['custom-param' => 'custom-value']
);
if ($netConf->commit()->isRPCReplyOK()) {
echo "Successfully committed, dude!";
}
else {
echo "Something's wrong, man.";
}
$getUsersNames = $netConf->getConfig(
[
"configuration/system/login/user" => [
[
"name"=>"user"
]
]
]
);
- Namespaces?
- Heavier use of Exceptions?
- test-option: The element MAY be specified only if the device advertises the :validate:1.1 capability (Section 8.6).
- Should I be implicitly locking/unlocking the config for editConfig() () and commit() () calls?
- Should I remove the long list of arguments for argument-heavy methods and replace them with a single array?
- Pros
- it looks nicer
- allows for extension in the future without requiring heavy refactoring
- Cons
- Methods will require some extract() type code at the top, along with validation of keys passed through (abstract class that?)
- IDEs argument suggestion won't work(?)
- Pros
- XPath capability in filter?