go-netconf

README

netconf

This library is a simple NETCONF client based on RFC6241 and RFC6241 (although not fully compliant yet). Today it only supports the SSH transport mechanism (and NETCONF 1.0 SSH framing)

Note: this is currently pre-alpha release. API and features may and probably will change. Suggestions and pull requests are welcome

Features

• Support for SSH transport using go.crypto/ssh. (Other transports are planned)
• Built in RPC support (in progress)
• Support for custom RPCs
• Independent of XML library. Free to choose encoding/xml or another third party library to parse the results.

Install

Requires Go 1.2 or later!

go get github.com/Juniper/go-netconf/netconf

Example

package main

import (
	"code.google.com/p/go.crypto/ssh"
	"fmt"
	"github.com/Juniper/go-netconf/netconf"
)

func main() {
	username := "myuser"
	password := "mypassword"

	s, err := netconf.DialSSH(flag.Arg(0),
		netconf.SSHConfigPassword(username, password))
	if err != nil {
		panic(err)
	}

	defer s.Close()

	fmt.Printf("Server Capabilities: '%+v'\n", s.ServerCapabilities)
	fmt.Printf("Session Id: %d\n\n", s.SessionID)

	//reply, err := s.Exec([]byte("<rpc><get-config><source><running/></source></get-config></rpc>"))
	reply, err := s.ExecRPC(netconf.RPCGetConfig("running"))
	if err != nil {
		panic(err)
	}
	fmt.Printf("Reply: %+v", reply)
}

Documentation

You can view full API documentation at GoDoc:

http://godoc.org/github.com/Juniper/go-netconf/netconf

License

(BSD 2)

Copyright © 2013, Juniper Networks

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

(1) Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

(2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation are those of the authors and should not be interpreted as representing official policies, either expressed or implied, of Juniper Networks.

Authors and Contributors

• Brandon Bennett, Juniper Networks