Revision 0b7d3b31 docs/build/latex/ncclient.tex
| b/docs/build/latex/ncclient.tex | ||
|---|---|---|
| 91 | 91 |
|
| 92 | 92 |
\chapter{Introduction}
|
| 93 | 93 |
|
| 94 |
NCClient is a Python library for NETCONF clients. NETCONF is a network management protocol defined in \index{RFC!RFC 4741}\href{http://tools.ietf.org/html/rfc4741.html}{\textbf{RFC 4741}}. It is meant for Python 2.6+ (not Python 3 yet, though).
|
|
| 94 |
NCClient is a Python library for NETCONF clients. NETCONF is a network management protocol defined in \index{RFC!RFC 4741}\href{http://tools.ietf.org/html/rfc4741.html}{\textbf{RFC 4741}}.
|
|
| 95 |
|
|
| 96 |
It is meant for Python 2.6+ (not Python 3 yet, though). |
|
| 95 | 97 |
|
| 96 | 98 |
The features of NCClient include: |
| 97 | 99 |
\begin{itemize}
|
| ... | ... | |
| 275 | 277 |
|
| 276 | 278 |
\hypertarget{ncclient.manager.Manager.close_session}{}\begin{methoddesc}{close\_session}{*args, **kwds}~\begin{quote}\begin{description}
|
| 277 | 279 |
\item[See] |
| 278 |
\code{CloseSession.request()}
|
|
| 280 |
\hyperlink{ncclient.operations.CloseSession.request}{\code{CloseSession.request()}}
|
|
| 279 | 281 |
|
| 280 | 282 |
\end{description}\end{quote}
|
| 281 | 283 |
\end{methoddesc}
|
| ... | ... | |
| 283 | 285 |
|
| 284 | 286 |
\hypertarget{ncclient.manager.Manager.kill_session}{}\begin{methoddesc}{kill\_session}{*args, **kwds}~\begin{quote}\begin{description}
|
| 285 | 287 |
\item[See] |
| 286 |
\code{KillSession.request()}
|
|
| 288 |
\hyperlink{ncclient.operations.KillSession.request}{\code{KillSession.request()}}
|
|
| 287 | 289 |
|
| 288 | 290 |
\end{description}\end{quote}
|
| 289 | 291 |
\end{methoddesc}
|
| ... | ... | |
| 296 | 298 |
\emph{target} (\href{http://docs.python.org/library/string.html\#string}{\code{string}}) -- name of the datastore to lock
|
| 297 | 299 |
|
| 298 | 300 |
\item[Return type] |
| 299 |
\code{operations.LockContext}
|
|
| 301 |
\hyperlink{ncclient.operations.LockContext}{\code{LockContext}}
|
|
| 300 | 302 |
|
| 301 | 303 |
\end{description}\end{quote}
|
| 302 | 304 |
\end{methoddesc}
|
| ... | ... | |
| 1240 | 1242 |
\emph{\textless{}discard-changes\textgreater{}} RPC. Depends on the \emph{:candidate} capability.
|
| 1241 | 1243 |
\index{request() (ncclient.operations.DiscardChanges method)}
|
| 1242 | 1244 |
|
| 1243 |
\hypertarget{ncclient.operations.DiscardChanges.request}{}\begin{methoddesc}{request}{*args, **kwds}
|
|
| 1244 |
Subclasses implement this method. Here, the operation is constructed |
|
| 1245 |
in \hyperlink{dtree}{\emph{DictTree XML representation}}, and the result of \code{\_request()} returned.
|
|
| 1245 |
\hypertarget{ncclient.operations.DiscardChanges.request}{}\begin{methoddesc}{request}{}~\begin{quote}\begin{description}
|
|
| 1246 |
\item[Seealso] |
|
| 1247 |
\hyperlink{return}{\emph{Return type}}
|
|
| 1248 |
|
|
| 1249 |
\end{description}\end{quote}
|
|
| 1246 | 1250 |
\end{methoddesc}
|
| 1247 | 1251 |
\end{classdesc}
|
| 1248 | 1252 |
|
| ... | ... | |
| 1254 | 1258 |
Bases: \hyperlink{ncclient.operations.rpc.RPC}{\code{ncclient.operations.rpc.RPC}}
|
| 1255 | 1259 |
|
| 1256 | 1260 |
\emph{\textless{}close-session\textgreater{}} RPC. The connection to NETCONF server is also closed.
|
| 1261 |
\index{request() (ncclient.operations.CloseSession method)}
|
|
| 1262 |
|
|
| 1263 |
\hypertarget{ncclient.operations.CloseSession.request}{}\begin{methoddesc}{request}{}~\begin{quote}\begin{description}
|
|
| 1264 |
\item[Seealso] |
|
| 1265 |
\hyperlink{return}{\emph{Return type}}
|
|
| 1266 |
|
|
| 1267 |
\end{description}\end{quote}
|
|
| 1268 |
\end{methoddesc}
|
|
| 1257 | 1269 |
\end{classdesc}
|
| 1258 | 1270 |
\index{KillSession (class in ncclient.operations)}
|
| 1259 | 1271 |
|
| ... | ... | |
| 1261 | 1273 |
Bases: \hyperlink{ncclient.operations.rpc.RPC}{\code{ncclient.operations.rpc.RPC}}
|
| 1262 | 1274 |
|
| 1263 | 1275 |
\emph{\textless{}kill-session\textgreater{}} RPC.
|
| 1276 |
\index{request() (ncclient.operations.KillSession method)}
|
|
| 1277 |
|
|
| 1278 |
\hypertarget{ncclient.operations.KillSession.request}{}\begin{methoddesc}{request}{session\_id}~\begin{quote}\begin{description}
|
|
| 1279 |
\item[Parameter] |
|
| 1280 |
\emph{session\_id} (\href{http://docs.python.org/library/string.html\#string}{\code{string}}) -- \emph{session-id} of NETCONF session to kill
|
|
| 1281 |
|
|
| 1282 |
\item[Seealso] |
|
| 1283 |
\hyperlink{return}{\emph{Return type}}
|
|
| 1284 |
|
|
| 1285 |
\end{description}\end{quote}
|
|
| 1286 |
\end{methoddesc}
|
|
| 1264 | 1287 |
\end{classdesc}
|
| 1265 | 1288 |
|
| 1266 | 1289 |
|
Also available in: Unified diff