A SOAP Binding for NETCONF

1
A SOAP Binding for NETCONF

• Ted Goddard
• ted.goddard_at_windriver.com
• draft-goddard-netconfsoap-00.txt

2
NETCONF SOAP Fundamentals

• Manager initiates SOAP/HTTP connection to agent
• Multiple SOAP/HTTP connections with the same
  credentials and session identifier in SOAPAction
  constitute a session
• Multiple connections allow management of
  time-extended synchronous operations
• This is not effective for asynchronous
  notification
• A polling form of ltrpc-progressgt would be useful
• Use reliable syslog
• Use SOAP/HTTP from the agent to the manager
• NETCONF SOAP interface is defined in WSDL
• Base netconf/1.0/soap.wsdl defining message types
• Device-specific WSDL giving device address and
  port

3
NETCONF Machine Readable Document Relationships
http//www.ietf.org/netconf/1.0/base.xsd
IETF standard data model XSD
netconf/1.0/soap.wsdl
netconf/1.0/beep.dtd
http//www.example.com/datamodel.xsd
http//device/netconf.wsdl
Note www.ietf.org can host DTD, XSD, and
WSDL just as it now hosts RFC
Primarily extension
Primarily inclusion/aggregation
4
NETCONF SOAP Request

• POST /netconf HTTP/1.0
• Content-Type text/xml charsetutf-8
• SOAPAction "netconfsession123"
• Content-Length 470
• lt?xml version"1.0" encoding"UTF-8"?gt
• ltsoapenvEnvelope xmlnssoapenv"http//schemas.xm
  lsoap.org/soap/envelope/"gt
• ltsoapenvBodygt
• ltrpc id"101" xmlns"http//ietf.org/netconf/1
  .0/base"gt
• ltget-configgt
• ltsourcegt ltrunning/gt lt/sourcegt
• ltconfig xmlns"http//example.com/schema/1
  .2/config"gt ltusers/gt lt/configgt
• ltformatgtxmllt/formatgt
• lt/get-configgt
• lt/rpcgt
• lt/soapenvBodygt
• lt/soapenvEnvelopegt

5
NETCONF SOAP Response

• HTTP/1.0 200 OK
• Content-Type text/xml charsetutf-8
• lt?xml version"1.0" encoding"UTF-8"?gt
• ltsoapenvEnvelope
• xmlnssoapenv"http//schemas.xmlsoap.org/soap/e
  nvelope/"gt
• ltsoapenvBodygt
• ltrpc-reply id"101" xmlns"http//ietf.org/net
  conf/1.0/base"gt
• ltconfig xmlns"http//example.com/schema/1.2
  /config"gt
• ltusersgt
• ltusergt ltnamegtrootlt/namegt
  lttypegtsuperuserlt/typegt lt/usergt
• ltusergt ltnamegtfredlt/namegt
  lttypegtadminlt/typegt lt/usergt
• ltusergt ltnamegtbarneylt/namegt
  lttypegtadminlt/typegt lt/usergt
• lt/usersgt
• lt/configgt
• lt/rpc-replygt
• lt/soapenvBodygt
• lt/soapenvEnvelopegt

6
SSH Transport Candidates

• A sequence of valid XML documents
• lt?xml version"1.0" encoding"UTF-8"?gt
• ltrpcgt
• ...
• lt/rpcgt
• lt?xml version"1.0" encoding"UTF-8"?gt
• ltrpcgt
• ...
• lt/rpcgt

• or a single document with a special root element
• lt?xml version"1.0" encoding"UTF-8"?gt
• ltrpcSequencegt
• ltrpcgt
• ...
• lt/rpcgt
• ltrpcgt
• ...
• lt/rpcgt
• lt/rpcSequencegt