datatracker.ietf.org
Sign in
Version 5.3.1, 2014-04-16
Report a bug

Using NETCONF over the Simple Object Access Protocol (SOAP)
RFC 4743

Document type: RFC - Historic (December 2006)
Document stream: IETF
Last updated: 2013-03-02
Other versions: plain text, pdf, html

IETF State: (None)
Consensus: Unknown
Document shepherd: No shepherd assigned

IESG State: RFC 4743 (Historic)
Responsible AD: (None)
Send notices to: simon@switch.ch, ietf@andybierman.com; ted.goddard@icesoft.com

Network Working Group                                         T. Goddard
Request for Comments: 4743                     ICEsoft Technologies Inc.
Category: Standards Track                                  December 2006

      Using NETCONF over the Simple Object Access Protocol (SOAP)

Status of This Memo

   This document specifies an Internet standards track protocol for the
   Internet community, and requests discussion and suggestions for
   improvements.  Please refer to the current edition of the "Internet
   Official Protocol Standards" (STD 1) for the standardization state
   and status of this protocol.  Distribution of this memo is unlimited.

Copyright Notice

   Copyright (C) The IETF Trust (2006).

Abstract

   The Network Configuration Protocol (NETCONF) is applicable to a wide
   range of devices in a variety of environments.  Web Services is one
   such environment and is presently characterized by the use of the
   Simple Object Access Protocol (SOAP).  NETCONF finds many benefits in
   this environment: from the reuse of existing standards, to ease of
   software development, to integration with deployed systems.  Herein,
   we describe SOAP over HTTP and SOAP over Blocks Exchange Extensible
   Protocol (BEEP) bindings for NETCONF.

Goddard                     Standards Track                     [Page 1]
RFC 4743                   NETCONF over SOAP               December 2006

Table of Contents

   1. Introduction ....................................................2
   2. SOAP Background for NETCONF .....................................3
      2.1. Use and Storage of WSDL and XSD ............................4
      2.2. SOAP over HTTP .............................................4
      2.3. HTTP Drawbacks .............................................4
      2.4. BCP56: On the Use of HTTP as a Substrate ...................5
      2.5. Important HTTP 1.1 Features ................................6
      2.6. SOAP over BEEP .............................................7
      2.7. SOAP Implementation Considerations .........................7
           2.7.1. SOAP Feature Exploitation ...........................7
           2.7.2. SOAP Headers ........................................7
           2.7.3. SOAP Faults .........................................8
   3. A SOAP Service for NETCONF ......................................9
      3.1. Fundamental Use Case .......................................9
      3.2. NETCONF Session Establishment ..............................9
      3.3. NETCONF Capabilities Exchange ..............................9
      3.4. NETCONF Session Usage .....................................11
      3.5. NETCONF Session Teardown ..................................11
      3.6. A NETCONF over SOAP Example ...............................11
      3.7. NETCONF SOAP WSDL .........................................13
      3.8. Sample Service Definition WSDL ............................14
   4. Security Considerations ........................................15
      4.1. Integrity, Privacy, and Authentication ....................15
      4.2. Vulnerabilities ...........................................16
      4.3. Environmental Specifics ...................................16
   5. IANA Considerations ............................................17
   6. References .....................................................17
      6.1. Normative References ......................................17
      6.2. Informative References ....................................18

1.  Introduction

   Given the use of Extensible Markup Language (XML) [2] and the remote
   procedure call characteristics, it is natural to consider a binding
   of the NETCONF [1] operations to a SOAP [3] application protocol.
   This document proposes a binding of this form.

   In general, SOAP is a natural messaging scheme for NETCONF,
   essentially because of the remote procedure call character of both.
   However, care must be taken with SOAP over HTTP as it is inherently
   synchronous and client-driven.  SOAP over BEEP [11] is technically
   superior, but is not as widely adopted.

   Four basic topics are presented: SOAP specifics of interest to
   NETCONF, specifics on implementing NETCONF as a SOAP-based web
   service, security considerations, and functional Web Services

Goddard                     Standards Track                     [Page 2]
RFC 4743                   NETCONF over SOAP               December 2006

   Description Language (WSDL) definitions.  In some sense, the most
   important part of the document is the brief WSDL document presented
   in Section 3.7.  With the right tools, the WSDL combined with the
   base NETCONF XML Schemas provides machine-readable descriptions

[include full document text]