<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html xmlns:fn="http://www.w3.org/2005/02/xpath-functions">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../doc/otp_doc.css" type="text/css">
<title>Erlang -- ct_netconfc</title>
</head>
<body bgcolor="white" text="#000000" link="#0000ff" vlink="#ff00ff" alink="#ff0000"><div id="container">
<script id="js" type="text/javascript" language="JavaScript" src="../../../../doc/js/flipmenu/flipmenu.js"></script><script id="js2" type="text/javascript" src="../../../../doc/js/erlresolvelinks.js"></script><script language="JavaScript" type="text/javascript">
<!--
function getWinHeight() {
var myHeight = 0;
if( typeof( window.innerHeight ) == 'number' ) {
//Non-IE
myHeight = window.innerHeight;
} else if( document.documentElement && ( document.documentElement.clientWidth ||
document.documentElement.clientHeight ) ) {
//IE 6+ in 'standards compliant mode'
myHeight = document.documentElement.clientHeight;
} else if( document.body && ( document.body.clientWidth || document.body.clientHeight ) ) {
//IE 4 compatible
myHeight = document.body.clientHeight;
}
return myHeight;
}
function setscrollpos() {
var objf=document.getElementById('loadscrollpos');
document.getElementById("leftnav").scrollTop = objf.offsetTop - getWinHeight()/2;
}
function addEvent(obj, evType, fn){
if (obj.addEventListener){
obj.addEventListener(evType, fn, true);
return true;
} else if (obj.attachEvent){
var r = obj.attachEvent("on"+evType, fn);
return r;
} else {
return false;
}
}
addEvent(window, 'load', setscrollpos);
//--></script><div id="leftnav"><div class="innertube">
<img alt="Erlang logo" src="../../../../doc/erlang-logo.png"><br><small><a href="users_guide.html">User's Guide</a><br><a href="index.html">Reference Manual</a><br><a href="release_notes.html">Release Notes</a><br><a href="../pdf/common_test-1.6.3.pdf">PDF</a><br><a href="../../../../doc/index.html">Top</a></small><p><strong>Common Test</strong><br><strong>Reference Manual</strong><br><small>Version 1.6.3</small></p>
<br><a href="javascript:openAllFlips()">Expand All</a><br><a href="javascript:closeAllFlips()">Contract All</a><p><small><strong>Table of Contents</strong></small></p>
<ul class="flipMenu">
<li id="no" title="common_test " expanded="false">common_test<ul>
<li><a href="common_test.html">
Top of manual page
</a></li>
<li title="Module:all-0"><a href="common_test.html#Module:all-0">Module:all/0</a></li>
<li title="Module:groups-0"><a href="common_test.html#Module:groups-0">Module:groups/0</a></li>
<li title="Module:suite-0"><a href="common_test.html#Module:suite-0">Module:suite/0</a></li>
<li title="Module:init_per_suite-1"><a href="common_test.html#Module:init_per_suite-1">Module:init_per_suite/1</a></li>
<li title="Module:end_per_suite-1"><a href="common_test.html#Module:end_per_suite-1">Module:end_per_suite/1</a></li>
<li title="Module:group-1"><a href="common_test.html#Module:group-1">Module:group/1</a></li>
<li title="Module:init_per_group-2"><a href="common_test.html#Module:init_per_group-2">Module:init_per_group/2</a></li>
<li title="Module:end_per_group-2"><a href="common_test.html#Module:end_per_group-2">Module:end_per_group/2</a></li>
<li title="Module:init_per_testcase-2"><a href="common_test.html#Module:init_per_testcase-2">Module:init_per_testcase/2</a></li>
<li title="Module:end_per_testcase-2"><a href="common_test.html#Module:end_per_testcase-2">Module:end_per_testcase/2</a></li>
<li title="Module:Testcase-0"><a href="common_test.html#Module:Testcase-0">Module:Testcase/0</a></li>
<li title="Module:Testcase-1"><a href="common_test.html#Module:Testcase-1">Module:Testcase/1</a></li>
</ul>
</li>
<li title="ct_run"><a href="ct_run.html">ct_run</a></li>
<li id="no" title="ct " expanded="false">ct<ul>
<li><a href="ct.html">
Top of manual page
</a></li>
<li title="abort_current_testcase-1"><a href="ct.html#abort_current_testcase-1">abort_current_testcase/1</a></li>
<li title="add_config-2"><a href="ct.html#add_config-2">add_config/2</a></li>
<li title="break-1"><a href="ct.html#break-1">break/1</a></li>
<li title="break-2"><a href="ct.html#break-2">break/2</a></li>
<li title="capture_get-0"><a href="ct.html#capture_get-0">capture_get/0</a></li>
<li title="capture_get-1"><a href="ct.html#capture_get-1">capture_get/1</a></li>
<li title="capture_start-0"><a href="ct.html#capture_start-0">capture_start/0</a></li>
<li title="capture_stop-0"><a href="ct.html#capture_stop-0">capture_stop/0</a></li>
<li title="comment-1"><a href="ct.html#comment-1">comment/1</a></li>
<li title="comment-2"><a href="ct.html#comment-2">comment/2</a></li>
<li title="continue-0"><a href="ct.html#continue-0">continue/0</a></li>
<li title="continue-1"><a href="ct.html#continue-1">continue/1</a></li>
<li title="decrypt_config_file-2"><a href="ct.html#decrypt_config_file-2">decrypt_config_file/2</a></li>
<li title="decrypt_config_file-3"><a href="ct.html#decrypt_config_file-3">decrypt_config_file/3</a></li>
<li title="encrypt_config_file-2"><a href="ct.html#encrypt_config_file-2">encrypt_config_file/2</a></li>
<li title="encrypt_config_file-3"><a href="ct.html#encrypt_config_file-3">encrypt_config_file/3</a></li>
<li title="fail-1"><a href="ct.html#fail-1">fail/1</a></li>
<li title="fail-2"><a href="ct.html#fail-2">fail/2</a></li>
<li title="get_config-1"><a href="ct.html#get_config-1">get_config/1</a></li>
<li title="get_config-2"><a href="ct.html#get_config-2">get_config/2</a></li>
<li title="get_config-3"><a href="ct.html#get_config-3">get_config/3</a></li>
<li title="get_status-0"><a href="ct.html#get_status-0">get_status/0</a></li>
<li title="get_target_name-1"><a href="ct.html#get_target_name-1">get_target_name/1</a></li>
<li title="get_timetrap_info-0"><a href="ct.html#get_timetrap_info-0">get_timetrap_info/0</a></li>
<li title="install-1"><a href="ct.html#install-1">install/1</a></li>
<li title="listenv-1"><a href="ct.html#listenv-1">listenv/1</a></li>
<li title="log-1"><a href="ct.html#log-1">log/1</a></li>
<li title="log-2"><a href="ct.html#log-2">log/2</a></li>
<li title="log-3"><a href="ct.html#log-3">log/3</a></li>
<li title="log-4"><a href="ct.html#log-4">log/4</a></li>
<li title="make_priv_dir-0"><a href="ct.html#make_priv_dir-0">make_priv_dir/0</a></li>
<li title="notify-2"><a href="ct.html#notify-2">notify/2</a></li>
<li title="pal-1"><a href="ct.html#pal-1">pal/1</a></li>
<li title="pal-2"><a href="ct.html#pal-2">pal/2</a></li>
<li title="pal-3"><a href="ct.html#pal-3">pal/3</a></li>
<li title="pal-4"><a href="ct.html#pal-4">pal/4</a></li>
<li title="parse_table-1"><a href="ct.html#parse_table-1">parse_table/1</a></li>
<li title="print-1"><a href="ct.html#print-1">print/1</a></li>
<li title="print-2"><a href="ct.html#print-2">print/2</a></li>
<li title="print-3"><a href="ct.html#print-3">print/3</a></li>
<li title="print-4"><a href="ct.html#print-4">print/4</a></li>
<li title="reload_config-1"><a href="ct.html#reload_config-1">reload_config/1</a></li>
<li title="remove_config-2"><a href="ct.html#remove_config-2">remove_config/2</a></li>
<li title="require-1"><a href="ct.html#require-1">require/1</a></li>
<li title="require-2"><a href="ct.html#require-2">require/2</a></li>
<li title="run-1"><a href="ct.html#run-1">run/1</a></li>
<li title="run-2"><a href="ct.html#run-2">run/2</a></li>
<li title="run-3"><a href="ct.html#run-3">run/3</a></li>
<li title="run_test-1"><a href="ct.html#run_test-1">run_test/1</a></li>
<li title="run_testspec-1"><a href="ct.html#run_testspec-1">run_testspec/1</a></li>
<li title="sleep-1"><a href="ct.html#sleep-1">sleep/1</a></li>
<li title="start_interactive-0"><a href="ct.html#start_interactive-0">start_interactive/0</a></li>
<li title="step-3"><a href="ct.html#step-3">step/3</a></li>
<li title="step-4"><a href="ct.html#step-4">step/4</a></li>
<li title="stop_interactive-0"><a href="ct.html#stop_interactive-0">stop_interactive/0</a></li>
<li title="sync_notify-2"><a href="ct.html#sync_notify-2">sync_notify/2</a></li>
<li title="testcases-2"><a href="ct.html#testcases-2">testcases/2</a></li>
<li title="timetrap-1"><a href="ct.html#timetrap-1">timetrap/1</a></li>
<li title="userdata-2"><a href="ct.html#userdata-2">userdata/2</a></li>
<li title="userdata-3"><a href="ct.html#userdata-3">userdata/3</a></li>
</ul>
</li>
<li id="no" title="ct_master " expanded="false">ct_master<ul>
<li><a href="ct_master.html">
Top of manual page
</a></li>
<li title="abort-0"><a href="ct_master.html#abort-0">abort/0</a></li>
<li title="abort-1"><a href="ct_master.html#abort-1">abort/1</a></li>
<li title="basic_html-1"><a href="ct_master.html#basic_html-1">basic_html/1</a></li>
<li title="progress-0"><a href="ct_master.html#progress-0">progress/0</a></li>
<li title="run-1"><a href="ct_master.html#run-1">run/1</a></li>
<li title="run-3"><a href="ct_master.html#run-3">run/3</a></li>
<li title="run-4"><a href="ct_master.html#run-4">run/4</a></li>
<li title="run_on_node-2"><a href="ct_master.html#run_on_node-2">run_on_node/2</a></li>
<li title="run_on_node-3"><a href="ct_master.html#run_on_node-3">run_on_node/3</a></li>
<li title="run_test-2"><a href="ct_master.html#run_test-2">run_test/2</a></li>
</ul>
</li>
<li id="no" title="ct_cover " expanded="false">ct_cover<ul>
<li><a href="ct_cover.html">
Top of manual page
</a></li>
<li title="add_nodes-1"><a href="ct_cover.html#add_nodes-1">add_nodes/1</a></li>
<li title="remove_nodes-1"><a href="ct_cover.html#remove_nodes-1">remove_nodes/1</a></li>
</ul>
</li>
<li id="no" title="ct_ftp " expanded="false">ct_ftp<ul>
<li><a href="ct_ftp.html">
Top of manual page
</a></li>
<li title="cd-2"><a href="ct_ftp.html#cd-2">cd/2</a></li>
<li title="close-1"><a href="ct_ftp.html#close-1">close/1</a></li>
<li title="delete-2"><a href="ct_ftp.html#delete-2">delete/2</a></li>
<li title="get-3"><a href="ct_ftp.html#get-3">get/3</a></li>
<li title="ls-2"><a href="ct_ftp.html#ls-2">ls/2</a></li>
<li title="open-1"><a href="ct_ftp.html#open-1">open/1</a></li>
<li title="put-3"><a href="ct_ftp.html#put-3">put/3</a></li>
<li title="recv-2"><a href="ct_ftp.html#recv-2">recv/2</a></li>
<li title="recv-3"><a href="ct_ftp.html#recv-3">recv/3</a></li>
<li title="send-2"><a href="ct_ftp.html#send-2">send/2</a></li>
<li title="send-3"><a href="ct_ftp.html#send-3">send/3</a></li>
<li title="type-2"><a href="ct_ftp.html#type-2">type/2</a></li>
</ul>
</li>
<li id="no" title="ct_ssh " expanded="false">ct_ssh<ul>
<li><a href="ct_ssh.html">
Top of manual page
</a></li>
<li title="apread-4"><a href="ct_ssh.html#apread-4">apread/4</a></li>
<li title="apread-5"><a href="ct_ssh.html#apread-5">apread/5</a></li>
<li title="apwrite-4"><a href="ct_ssh.html#apwrite-4">apwrite/4</a></li>
<li title="apwrite-5"><a href="ct_ssh.html#apwrite-5">apwrite/5</a></li>
<li title="aread-3"><a href="ct_ssh.html#aread-3">aread/3</a></li>
<li title="aread-4"><a href="ct_ssh.html#aread-4">aread/4</a></li>
<li title="awrite-3"><a href="ct_ssh.html#awrite-3">awrite/3</a></li>
<li title="awrite-4"><a href="ct_ssh.html#awrite-4">awrite/4</a></li>
<li title="close-2"><a href="ct_ssh.html#close-2">close/2</a></li>
<li title="close-3"><a href="ct_ssh.html#close-3">close/3</a></li>
<li title="connect-1"><a href="ct_ssh.html#connect-1">connect/1</a></li>
<li title="connect-2"><a href="ct_ssh.html#connect-2">connect/2</a></li>
<li title="connect-3"><a href="ct_ssh.html#connect-3">connect/3</a></li>
<li title="del_dir-2"><a href="ct_ssh.html#del_dir-2">del_dir/2</a></li>
<li title="del_dir-3"><a href="ct_ssh.html#del_dir-3">del_dir/3</a></li>
<li title="delete-2"><a href="ct_ssh.html#delete-2">delete/2</a></li>
<li title="delete-3"><a href="ct_ssh.html#delete-3">delete/3</a></li>
<li title="disconnect-1"><a href="ct_ssh.html#disconnect-1">disconnect/1</a></li>
<li title="exec-2"><a href="ct_ssh.html#exec-2">exec/2</a></li>
<li title="exec-3"><a href="ct_ssh.html#exec-3">exec/3</a></li>
<li title="exec-4"><a href="ct_ssh.html#exec-4">exec/4</a></li>
<li title="get_file_info-2"><a href="ct_ssh.html#get_file_info-2">get_file_info/2</a></li>
<li title="get_file_info-3"><a href="ct_ssh.html#get_file_info-3">get_file_info/3</a></li>
<li title="list_dir-2"><a href="ct_ssh.html#list_dir-2">list_dir/2</a></li>
<li title="list_dir-3"><a href="ct_ssh.html#list_dir-3">list_dir/3</a></li>
<li title="make_dir-2"><a href="ct_ssh.html#make_dir-2">make_dir/2</a></li>
<li title="make_dir-3"><a href="ct_ssh.html#make_dir-3">make_dir/3</a></li>
<li title="make_symlink-3"><a href="ct_ssh.html#make_symlink-3">make_symlink/3</a></li>
<li title="make_symlink-4"><a href="ct_ssh.html#make_symlink-4">make_symlink/4</a></li>
<li title="open-3"><a href="ct_ssh.html#open-3">open/3</a></li>
<li title="open-4"><a href="ct_ssh.html#open-4">open/4</a></li>
<li title="opendir-2"><a href="ct_ssh.html#opendir-2">opendir/2</a></li>
<li title="opendir-3"><a href="ct_ssh.html#opendir-3">opendir/3</a></li>
<li title="position-3"><a href="ct_ssh.html#position-3">position/3</a></li>
<li title="position-4"><a href="ct_ssh.html#position-4">position/4</a></li>
<li title="pread-4"><a href="ct_ssh.html#pread-4">pread/4</a></li>
<li title="pread-5"><a href="ct_ssh.html#pread-5">pread/5</a></li>
<li title="pwrite-4"><a href="ct_ssh.html#pwrite-4">pwrite/4</a></li>
<li title="pwrite-5"><a href="ct_ssh.html#pwrite-5">pwrite/5</a></li>
<li title="read-3"><a href="ct_ssh.html#read-3">read/3</a></li>
<li title="read-4"><a href="ct_ssh.html#read-4">read/4</a></li>
<li title="read_file-2"><a href="ct_ssh.html#read_file-2">read_file/2</a></li>
<li title="read_file-3"><a href="ct_ssh.html#read_file-3">read_file/3</a></li>
<li title="read_file_info-2"><a href="ct_ssh.html#read_file_info-2">read_file_info/2</a></li>
<li title="read_file_info-3"><a href="ct_ssh.html#read_file_info-3">read_file_info/3</a></li>
<li title="read_link-2"><a href="ct_ssh.html#read_link-2">read_link/2</a></li>
<li title="read_link-3"><a href="ct_ssh.html#read_link-3">read_link/3</a></li>
<li title="read_link_info-2"><a href="ct_ssh.html#read_link_info-2">read_link_info/2</a></li>
<li title="read_link_info-3"><a href="ct_ssh.html#read_link_info-3">read_link_info/3</a></li>
<li title="receive_response-2"><a href="ct_ssh.html#receive_response-2">receive_response/2</a></li>
<li title="receive_response-3"><a href="ct_ssh.html#receive_response-3">receive_response/3</a></li>
<li title="receive_response-4"><a href="ct_ssh.html#receive_response-4">receive_response/4</a></li>
<li title="rename-3"><a href="ct_ssh.html#rename-3">rename/3</a></li>
<li title="rename-4"><a href="ct_ssh.html#rename-4">rename/4</a></li>
<li title="send-3"><a href="ct_ssh.html#send-3">send/3</a></li>
<li title="send-4"><a href="ct_ssh.html#send-4">send/4</a></li>
<li title="send-5"><a href="ct_ssh.html#send-5">send/5</a></li>
<li title="send_and_receive-3"><a href="ct_ssh.html#send_and_receive-3">send_and_receive/3</a></li>
<li title="send_and_receive-4"><a href="ct_ssh.html#send_and_receive-4">send_and_receive/4</a></li>
<li title="send_and_receive-5"><a href="ct_ssh.html#send_and_receive-5">send_and_receive/5</a></li>
<li title="send_and_receive-6"><a href="ct_ssh.html#send_and_receive-6">send_and_receive/6</a></li>
<li title="session_close-2"><a href="ct_ssh.html#session_close-2">session_close/2</a></li>
<li title="session_open-1"><a href="ct_ssh.html#session_open-1">session_open/1</a></li>
<li title="session_open-2"><a href="ct_ssh.html#session_open-2">session_open/2</a></li>
<li title="sftp_connect-1"><a href="ct_ssh.html#sftp_connect-1">sftp_connect/1</a></li>
<li title="subsystem-3"><a href="ct_ssh.html#subsystem-3">subsystem/3</a></li>
<li title="subsystem-4"><a href="ct_ssh.html#subsystem-4">subsystem/4</a></li>
<li title="write-3"><a href="ct_ssh.html#write-3">write/3</a></li>
<li title="write-4"><a href="ct_ssh.html#write-4">write/4</a></li>
<li title="write_file-3"><a href="ct_ssh.html#write_file-3">write_file/3</a></li>
<li title="write_file-4"><a href="ct_ssh.html#write_file-4">write_file/4</a></li>
<li title="write_file_info-3"><a href="ct_ssh.html#write_file_info-3">write_file_info/3</a></li>
<li title="write_file_info-4"><a href="ct_ssh.html#write_file_info-4">write_file_info/4</a></li>
</ul>
</li>
<li id="loadscrollpos" title="ct_netconfc " expanded="true">ct_netconfc<ul>
<li><a href="ct_netconfc.html">
Top of manual page
</a></li>
<li title="action-2"><a href="ct_netconfc.html#action-2">action/2</a></li>
<li title="action-3"><a href="ct_netconfc.html#action-3">action/3</a></li>
<li title="close_session-1"><a href="ct_netconfc.html#close_session-1">close_session/1</a></li>
<li title="close_session-2"><a href="ct_netconfc.html#close_session-2">close_session/2</a></li>
<li title="copy_config-3"><a href="ct_netconfc.html#copy_config-3">copy_config/3</a></li>
<li title="copy_config-4"><a href="ct_netconfc.html#copy_config-4">copy_config/4</a></li>
<li title="create_subscription-1"><a href="ct_netconfc.html#create_subscription-1">create_subscription/1</a></li>
<li title="create_subscription-2"><a href="ct_netconfc.html#create_subscription-2">create_subscription/2</a></li>
<li title="create_subscription-3"><a href="ct_netconfc.html#create_subscription-3">create_subscription/3</a></li>
<li title="create_subscription-4"><a href="ct_netconfc.html#create_subscription-4">create_subscription/4</a></li>
<li title="create_subscription-5"><a href="ct_netconfc.html#create_subscription-5">create_subscription/5</a></li>
<li title="create_subscription-6"><a href="ct_netconfc.html#create_subscription-6">create_subscription/6</a></li>
<li title="delete_config-2"><a href="ct_netconfc.html#delete_config-2">delete_config/2</a></li>
<li title="delete_config-3"><a href="ct_netconfc.html#delete_config-3">delete_config/3</a></li>
<li title="edit_config-3"><a href="ct_netconfc.html#edit_config-3">edit_config/3</a></li>
<li title="edit_config-4"><a href="ct_netconfc.html#edit_config-4">edit_config/4</a></li>
<li title="format_data-2"><a href="ct_netconfc.html#format_data-2">format_data/2</a></li>
<li title="get-2"><a href="ct_netconfc.html#get-2">get/2</a></li>
<li title="get-3"><a href="ct_netconfc.html#get-3">get/3</a></li>
<li title="get_capabilities-1"><a href="ct_netconfc.html#get_capabilities-1">get_capabilities/1</a></li>
<li title="get_capabilities-2"><a href="ct_netconfc.html#get_capabilities-2">get_capabilities/2</a></li>
<li title="get_config-3"><a href="ct_netconfc.html#get_config-3">get_config/3</a></li>
<li title="get_config-4"><a href="ct_netconfc.html#get_config-4">get_config/4</a></li>
<li title="get_event_streams-2"><a href="ct_netconfc.html#get_event_streams-2">get_event_streams/2</a></li>
<li title="get_event_streams-3"><a href="ct_netconfc.html#get_event_streams-3">get_event_streams/3</a></li>
<li title="get_session_id-1"><a href="ct_netconfc.html#get_session_id-1">get_session_id/1</a></li>
<li title="get_session_id-2"><a href="ct_netconfc.html#get_session_id-2">get_session_id/2</a></li>
<li title="handle_msg-2"><a href="ct_netconfc.html#handle_msg-2">handle_msg/2</a></li>
<li title="hello-1"><a href="ct_netconfc.html#hello-1">hello/1</a></li>
<li title="hello-2"><a href="ct_netconfc.html#hello-2">hello/2</a></li>
<li title="kill_session-2"><a href="ct_netconfc.html#kill_session-2">kill_session/2</a></li>
<li title="kill_session-3"><a href="ct_netconfc.html#kill_session-3">kill_session/3</a></li>
<li title="lock-2"><a href="ct_netconfc.html#lock-2">lock/2</a></li>
<li title="lock-3"><a href="ct_netconfc.html#lock-3">lock/3</a></li>
<li title="only_open-1"><a href="ct_netconfc.html#only_open-1">only_open/1</a></li>
<li title="only_open-2"><a href="ct_netconfc.html#only_open-2">only_open/2</a></li>
<li title="open-1"><a href="ct_netconfc.html#open-1">open/1</a></li>
<li title="open-2"><a href="ct_netconfc.html#open-2">open/2</a></li>
<li title="unlock-2"><a href="ct_netconfc.html#unlock-2">unlock/2</a></li>
<li title="unlock-3"><a href="ct_netconfc.html#unlock-3">unlock/3</a></li>
</ul>
</li>
<li id="no" title="ct_rpc " expanded="false">ct_rpc<ul>
<li><a href="ct_rpc.html">
Top of manual page
</a></li>
<li title="app_node-2"><a href="ct_rpc.html#app_node-2">app_node/2</a></li>
<li title="app_node-3"><a href="ct_rpc.html#app_node-3">app_node/3</a></li>
<li title="app_node-4"><a href="ct_rpc.html#app_node-4">app_node/4</a></li>
<li title="call-4"><a href="ct_rpc.html#call-4">call/4</a></li>
<li title="call-5"><a href="ct_rpc.html#call-5">call/5</a></li>
<li title="call-6"><a href="ct_rpc.html#call-6">call/6</a></li>
<li title="cast-4"><a href="ct_rpc.html#cast-4">cast/4</a></li>
<li title="cast-5"><a href="ct_rpc.html#cast-5">cast/5</a></li>
</ul>
</li>
<li id="no" title="ct_snmp " expanded="false">ct_snmp<ul>
<li><a href="ct_snmp.html">
Top of manual page
</a></li>
<li title="get_next_values-3"><a href="ct_snmp.html#get_next_values-3">get_next_values/3</a></li>
<li title="get_values-3"><a href="ct_snmp.html#get_values-3">get_values/3</a></li>
<li title="load_mibs-1"><a href="ct_snmp.html#load_mibs-1">load_mibs/1</a></li>
<li title="register_agents-2"><a href="ct_snmp.html#register_agents-2">register_agents/2</a></li>
<li title="register_users-2"><a href="ct_snmp.html#register_users-2">register_users/2</a></li>
<li title="register_usm_users-2"><a href="ct_snmp.html#register_usm_users-2">register_usm_users/2</a></li>
<li title="set_info-1"><a href="ct_snmp.html#set_info-1">set_info/1</a></li>
<li title="set_values-4"><a href="ct_snmp.html#set_values-4">set_values/4</a></li>
<li title="start-2"><a href="ct_snmp.html#start-2">start/2</a></li>
<li title="start-3"><a href="ct_snmp.html#start-3">start/3</a></li>
<li title="stop-1"><a href="ct_snmp.html#stop-1">stop/1</a></li>
<li title="unregister_agents-1"><a href="ct_snmp.html#unregister_agents-1">unregister_agents/1</a></li>
<li title="unregister_users-1"><a href="ct_snmp.html#unregister_users-1">unregister_users/1</a></li>
<li title="update_usm_users-2"><a href="ct_snmp.html#update_usm_users-2">update_usm_users/2</a></li>
</ul>
</li>
<li id="no" title="ct_telnet " expanded="false">ct_telnet<ul>
<li><a href="ct_telnet.html">
Top of manual page
</a></li>
<li title="close-1"><a href="ct_telnet.html#close-1">close/1</a></li>
<li title="cmd-2"><a href="ct_telnet.html#cmd-2">cmd/2</a></li>
<li title="cmd-3"><a href="ct_telnet.html#cmd-3">cmd/3</a></li>
<li title="cmdf-3"><a href="ct_telnet.html#cmdf-3">cmdf/3</a></li>
<li title="cmdf-4"><a href="ct_telnet.html#cmdf-4">cmdf/4</a></li>
<li title="cont_log-2"><a href="ct_telnet.html#cont_log-2">cont_log/2</a></li>
<li title="end_log-0"><a href="ct_telnet.html#end_log-0">end_log/0</a></li>
<li title="expect-2"><a href="ct_telnet.html#expect-2">expect/2</a></li>
<li title="expect-3"><a href="ct_telnet.html#expect-3">expect/3</a></li>
<li title="get_data-1"><a href="ct_telnet.html#get_data-1">get_data/1</a></li>
<li title="open-1"><a href="ct_telnet.html#open-1">open/1</a></li>
<li title="open-2"><a href="ct_telnet.html#open-2">open/2</a></li>
<li title="open-3"><a href="ct_telnet.html#open-3">open/3</a></li>
<li title="open-4"><a href="ct_telnet.html#open-4">open/4</a></li>
<li title="send-2"><a href="ct_telnet.html#send-2">send/2</a></li>
<li title="sendf-3"><a href="ct_telnet.html#sendf-3">sendf/3</a></li>
</ul>
</li>
<li title="unix_telnet"><a href="unix_telnet.html">unix_telnet</a></li>
<li id="no" title="ct_slave " expanded="false">ct_slave<ul>
<li><a href="ct_slave.html">
Top of manual page
</a></li>
<li title="start-1"><a href="ct_slave.html#start-1">start/1</a></li>
<li title="start-2"><a href="ct_slave.html#start-2">start/2</a></li>
<li title="start-3"><a href="ct_slave.html#start-3">start/3</a></li>
<li title="stop-1"><a href="ct_slave.html#stop-1">stop/1</a></li>
<li title="stop-2"><a href="ct_slave.html#stop-2">stop/2</a></li>
</ul>
</li>
<li id="no" title="ct_hooks " expanded="false">ct_hooks<ul>
<li><a href="ct_hooks.html">
Top of manual page
</a></li>
<li title="Module:init-2"><a href="ct_hooks.html#Module:init-2">Module:init/2</a></li>
<li title="Module:pre_init_per_suite-3"><a href="ct_hooks.html#Module:pre_init_per_suite-3">Module:pre_init_per_suite/3</a></li>
<li title="Module:post_init_per_suite-4"><a href="ct_hooks.html#Module:post_init_per_suite-4">Module:post_init_per_suite/4</a></li>
<li title="Module:pre_init_per_group-3"><a href="ct_hooks.html#Module:pre_init_per_group-3">Module:pre_init_per_group/3</a></li>
<li title="Module:post_init_per_group-4"><a href="ct_hooks.html#Module:post_init_per_group-4">Module:post_init_per_group/4</a></li>
<li title="Module:pre_init_per_testcase-3"><a href="ct_hooks.html#Module:pre_init_per_testcase-3">Module:pre_init_per_testcase/3</a></li>
<li title="Module:post_end_per_testcase-4"><a href="ct_hooks.html#Module:post_end_per_testcase-4">Module:post_end_per_testcase/4</a></li>
<li title="Module:pre_end_per_group-3"><a href="ct_hooks.html#Module:pre_end_per_group-3">Module:pre_end_per_group/3</a></li>
<li title="Module:post_end_per_group-4"><a href="ct_hooks.html#Module:post_end_per_group-4">Module:post_end_per_group/4</a></li>
<li title="Module:pre_end_per_suite-3"><a href="ct_hooks.html#Module:pre_end_per_suite-3">Module:pre_end_per_suite/3</a></li>
<li title="Module:post_end_per_suite-4"><a href="ct_hooks.html#Module:post_end_per_suite-4">Module:post_end_per_suite/4</a></li>
<li title="Module:on_tc_fail-3"><a href="ct_hooks.html#Module:on_tc_fail-3">Module:on_tc_fail/3</a></li>
<li title="Module:on_tc_skip-3"><a href="ct_hooks.html#Module:on_tc_skip-3">Module:on_tc_skip/3</a></li>
<li title="Module:terminate-1"><a href="ct_hooks.html#Module:terminate-1">Module:terminate/1</a></li>
<li title="Module:id-1"><a href="ct_hooks.html#Module:id-1">Module:id/1</a></li>
</ul>
</li>
</ul>
</div></div>
<div id="content">
<div class="innertube">
<!-- refpage --><center><h1>ct_netconfc</h1></center>
<h3>MODULE</h3>
<div class="REFBODY">ct_netconfc</div>
<h3>MODULE SUMMARY</h3>
<div class="REFBODY">Netconf client module.</div>
<h3>DESCRIPTION</h3>
<div class="REFBODY"><p>
<p>Netconf client module.</p>
<p>The Netconf client is compliant with RFC4741 and RFC4742.</p>
<p> For each server to test against, the following entry can be
added to a configuration file:</p>
<p><span class="code">{server_id(),options()}.</span></p>
<p> The <span class="code">server_id()</span> or an associated <span class="code">target_name()</span> (see
<span class="bold_code"><a href="ct.html">ct</a></span>) shall then be used in calls to <span class="bold_code"><a href="#open-2">open/2</a></span>.</p>
<p>If no configuration exists for a server, a session can still be
opened by calling <span class="bold_code"><a href="#open-2">open/2</a></span> with all necessary options given
in the call. The first argument to <span class="bold_code"><a href="#open-2">open/2</a></span> can then be any
atom.</p>
<p><strong><a name="Logging">Logging</a></strong></p>
<p>The netconf server uses the <span class="code">error_logger</span> for logging of netconf
traffic. A special purpose error handler is implemented in
<span class="code">ct_conn_log_h</span>. To use this error handler, add the <span class="code">cth_conn_log</span>
hook in your test suite, e.g.</p>
<div class="example"><pre> suite() ->
[{ct_hooks, [{cth_conn_log, [{conn_mod(),hook_options()}]}]}].</pre></div>
<p>The <span class="code">conn_mod()</span> is the name of the common_test module implementing
the connection protocol, e.g. <span class="code">ct_netconfc</span>.</p>
<p>The hook option <span class="code">log_type</span> specifies the type of logging:</p>
<dl>
<dt><strong><span class="code">raw</span></strong></dt>
<dd><p>The sent and received netconf data is logged to a separate
text file as is without any formatting. A link to the file is
added to the test case HTML log.</p></dd>
<dt><strong><span class="code">pretty</span></strong></dt>
<dd><p>The sent and received netconf data is logged to a separate
text file with XML data nicely indented. A link to the file is
added to the test case HTML log.</p></dd>
<dt><strong><span class="code">html (default)</span></strong></dt>
<dd><p>The sent and received netconf traffic is pretty printed
directly in the test case HTML log.</p></dd>
<dt><strong><span class="code">silent</span></strong></dt>
<dd><p>Netconf traffic is not logged.</p></dd>
</dl>
<p>By default, all netconf traffic is logged in one single log
file. However, it is possible to have different connections logged
in separate files. To do this, use the hook option <span class="code">hosts</span> and
list the names of the servers/connections that will be used in the
suite. Note that the connections must be named for this to work,
i.e. they must be opened with <span class="bold_code"><a href="#open-2">open/2</a></span>.</p>
<p>The <span class="code">hosts</span> option has no effect if <span class="code">log_type</span> is set to <span class="code">html</span> or
<span class="code">silent</span>.</p>
<p>The hook options can also be specified in a configuration file with
the configuration variable <span class="code">ct_conn_log</span>:</p>
<div class="example"><pre> {ct_conn_log,[{conn_mod(),hook_options()}]}.</pre></div>
<p>For example:</p>
<div class="example"><pre> {ct_conn_log,[{ct_netconfc,[{log_type,pretty},
{hosts,[key_or_name()]}]}]}</pre></div>
<p><strong>Note</strong> that hook options specified in a configuration file
will overwrite the hardcoded hook options in the test suite.</p>
<p><strong><a name="Logging_example_1">Logging example 1</a></strong></p>
<p>The following <span class="code">ct_hooks</span> statement will cause pretty printing of
netconf traffic to separate logs for the connections named
<span class="code">nc_server1</span> and <span class="code">nc_server2</span>. Any other connections will be logged
to default netconf log.</p>
<div class="example"><pre> suite() ->
[{ct_hooks, [{cth_conn_log, [{ct_netconfc,[{log_type,pretty}},
{hosts,[nc_server1,nc_server2]}]}
]}]}].</pre></div>
<p>Connections must be opened like this:</p>
<div class="example"><pre> open(nc_server1,[...]),
open(nc_server2,[...]).</pre></div>
<p><strong><a name="Logging_example_2">Logging example 2</a></strong></p>
<p>The following configuration file will cause raw logging of all
netconf traffic into one single text file.</p>
<div class="example"><pre> {ct_conn_log,[{ct_netconfc,[{log_type,raw}]}]}.</pre></div>
<p>The <span class="code">ct_hooks</span> statement must look like this:</p>
<div class="example"><pre> suite() ->
[{ct_hooks, [{cth_conn_log, []}]}].</pre></div>
<p>The same <span class="code">ct_hooks</span> statement without the configuration file would
cause HTML logging of all netconf connections into the test case
HTML log.</p>
<p><strong><a name="Notifications">Notifications</a></strong></p>
<p>The netconf client is also compliant with RFC5277 NETCONF Event
Notifications, which defines a mechanism for an asynchronous
message notification delivery service for the netconf protocol.</p>
<p>Specific functions to support this are <span class="bold_code"><a href="#create_subscription-6">create_subscription/6</a></span> and <span class="bold_code"><a href="#get_event_streams-3">get_event_streams/3</a></span>. (The
functions also exist with other arities.)
</p></p></div>
<h3><a name="id97761">DATA TYPES</a></h3>
<div class="REFBODY">
<a name="types"></a>
<dl>
<dt><strong><span class="code">client() = handle() | server_id() | target_name()</span></strong></dt>
<dd>
<a name="type-client"></a> </dd>
<dt><strong><span class="code">conn_mod() = ct_netconfc</span></strong></dt>
<dd>
<a name="type-conn_mod"></a> </dd>
<dt><strong><span class="code">error_reason() = term()</span></strong></dt>
<dd>
<a name="type-error_reason"></a> </dd>
<dt><strong><span class="code">event_time() = {eventTime, xml_attributes(), [xs_datetime()]}</span></strong></dt>
<dd>
<a name="type-event_time"></a> </dd>
<dt><strong><span class="code">handle() = term()</span></strong></dt>
<dd>
<a name="type-handle"></a>
<p> An opaque reference for a connection (netconf session). See <span class="bold_code"><a href="ct.html">ct</a></span> for more information.</p>
</dd>
<dt><strong><span class="code">hook_option() = {log_type, log_type()} | {hosts, [key_or_name()]}</span></strong></dt>
<dd>
<a name="type-hook_option"></a> </dd>
<dt><strong><span class="code">hook_options() = [hook_option()]</span></strong></dt>
<dd>
<a name="type-hook_options"></a>
<p> Options that can be given to <span class="code">cth_conn_log</span> in the <span class="code">ct_hook</span> statement.</p>
</dd>
<dt><strong><span class="code">host() = host_name() (see module inet) | ip_address() (see module inet)</span></strong></dt>
<dd>
<a name="type-host"></a> </dd>
<dt><strong><span class="code">key_or_name() = server_id() | target_name()</span></strong></dt>
<dd>
<a name="type-key_or_name"></a> </dd>
<dt><strong><span class="code">log_type() = raw | pretty | html | silent</span></strong></dt>
<dd>
<a name="type-log_type"></a>
<p>-type error_handler() :: module().</p>
</dd>
<dt><strong><span class="code">netconf_db() = running | startup | candidate</span></strong></dt>
<dd>
<a name="type-netconf_db"></a> </dd>
<dt><strong><span class="code">notification() = {notification, xml_attributes(), notification_content()}</span></strong></dt>
<dd>
<a name="type-notification"></a> </dd>
<dt><strong><span class="code">notification_content() = [event_time() | simple_xml()]</span></strong></dt>
<dd>
<a name="type-notification_content"></a> </dd>
<dt><strong><span class="code">option() = {ssh, host()} | {port, port_number() (see module inet)} | {user, string()} | {password, string()} | {user_dir, string()} | {timeout, timeout()}</span></strong></dt>
<dd>
<a name="type-option"></a> </dd>
<dt><strong><span class="code">options() = [option()]</span></strong></dt>
<dd>
<a name="type-options"></a>
<p> Options used for setting up ssh connection to a netconf server.</p>
</dd>
<dt><strong><span class="code">server_id() = atom()</span></strong></dt>
<dd>
<a name="type-server_id"></a>
<p> A <span class="code">ServerId</span> which exists in a configuration file.</p>
</dd>
<dt><strong><span class="code">simple_xml() = {xml_tag(), xml_attributes(), xml_content()} | {xml_tag(), xml_content()} | xml_tag()</span></strong></dt>
<dd>
<a name="type-simple_xml"></a>
<p>This type is further described in the documentation for the
<span class="code">Xmerl</span> application.</p>
</dd>
<dt><strong><span class="code">stream_data() = {description, string()} | {replaySupport, string()} | {replayLogCreationTime, string()} | {replayLogAgedTime, string()}</span></strong></dt>
<dd>
<a name="type-stream_data"></a>
<p> See XML Schema for Event Notifications found in RFC5277 for further
detail about the data format for the string values.</p>
</dd>
<dt><strong><span class="code">stream_name() = string()</span></strong></dt>
<dd>
<a name="type-stream_name"></a> </dd>
<dt><strong><span class="code">streams() = [{stream_name(), [stream_data()]}]</span></strong></dt>
<dd>
<a name="type-streams"></a> </dd>
<dt><strong><span class="code">target_name() = atom()</span></strong></dt>
<dd>
<a name="type-target_name"></a>
<p> A name which is associated to a <span class="code">server_id()</span> via a
<span class="code">require</span> statement or a call to <span class="bold_code"><a href="ct.html#require-2">ct:require/2</a></span> in the
test suite.</p>
</dd>
<dt><strong><span class="code">xml_attribute_tag() = atom()</span></strong></dt>
<dd>
<a name="type-xml_attribute_tag"></a> </dd>
<dt><strong><span class="code">xml_attribute_value() = string()</span></strong></dt>
<dd>
<a name="type-xml_attribute_value"></a> </dd>
<dt><strong><span class="code">xml_attributes() = [{xml_attribute_tag(), xml_attribute_value()}]</span></strong></dt>
<dd>
<a name="type-xml_attributes"></a> </dd>
<dt><strong><span class="code">xml_content() = [simple_xml() | iolist()]</span></strong></dt>
<dd>
<a name="type-xml_content"></a> </dd>
<dt><strong><span class="code">xml_tag() = atom()</span></strong></dt>
<dd>
<a name="type-xml_tag"></a> </dd>
<dt><strong><span class="code">xpath() = {xpath, string()}</span></strong></dt>
<dd>
<a name="type-xpath"></a> </dd>
<dt><strong><span class="code">xs_datetime() = string()</span></strong></dt>
<dd>
<a name="type-xs_datetime"></a>
<p> This date and time identifyer has the same format as the XML type
dateTime and compliant to RFC3339. The format is
</p>
<div class="example"><pre> [-]CCYY-MM-DDThh:mm:ss[.s][Z|(+|-)hh:mm]</pre></div>
</dd>
</dl>
</div>
<h3>EXPORTS</h3>
<p><a name="action-2"><span class="bold_code">action(Client, Action) -> Result</span></a><br></p>
<div class="REFBODY"><p><a name="action-2"></a>
<p>Equivalent to <span class="bold_code"><a href="#action-3">action(Client, Action, infinity)</a></span>.</p>
</p></div>
<p><a name="action-3"><span class="bold_code">action(Client, Action, Timeout) -> Result</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Client = client()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Action = simple_xml()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Timeout = timeout()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Result = {ok, simple_xml()} | {error, error_reason()}</span><br>
</div>
</div>
<div class="REFBODY"><p><a name="action-3"></a>
<p>Execute an action.
</p>
</p></div>
<p><a name="close_session-1"><span class="bold_code">close_session(Client) -> Result</span></a><br></p>
<div class="REFBODY"><p><a name="close_session-1"></a>
<p>Equivalent to <span class="bold_code"><a href="#close_session-2">close_session(Client, infinity)</a></span>.</p>
</p></div>
<p><a name="close_session-2"><span class="bold_code">close_session(Client, Timeout) -> Result</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Client = client()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Timeout = timeout()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Result = ok | {error, error_reason()}</span><br>
</div>
</div>
<div class="REFBODY"><p><a name="close_session-2"></a>
<p>Request graceful termination of the session associated with the client.</p>
<p>When a netconf server receives a <span class="code">close-session</span> request, it
will gracefully close the session. The server will release any
locks and resources associated with the session and gracefully
close any associated connections. Any NETCONF requests received
after a <span class="code">close-session</span> request will be ignored.
</p>
</p></div>
<p><a name="copy_config-3"><span class="bold_code">copy_config(Client, Source, Target) -> Result</span></a><br></p>
<div class="REFBODY"><p><a name="copy_config-3"></a>
<p>Equivalent to <span class="bold_code"><a href="#copy_config-4">copy_config(Client, Source, Target, infinity)</a></span>.</p>
</p></div>
<p><a name="copy_config-4"><span class="bold_code">copy_config(Client, Target, Source, Timeout) -> Result</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Client = client()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Target = netconf_db()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Source = netconf_db()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Timeout = timeout()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Result = ok | {error, error_reason()}</span><br>
</div>
</div>
<div class="REFBODY"><p><a name="copy_config-4"></a>
<p>Copy configuration data.</p>
<p>Which source and target options that can be issued depends on the
capabilities supported by the server. I.e. <span class="code">:candidate</span> and/or
<span class="code">:startup</span> are required.
</p>
</p></div>
<p><a name="create_subscription-1"><span class="bold_code">create_subscription(Client) -> term()
</span></a><br></p>
<div class="REFBODY"><p><a name="create_subscription-1"></a>
</p></div>
<p><a name="create_subscription-2"><span class="bold_code">create_subscription(Client, Timeout) -> term()
</span></a><br></p>
<div class="REFBODY"><p><a name="create_subscription-2"></a>
</p></div>
<p><a name="create_subscription-3"><span class="bold_code">create_subscription(Client, Stream, Timeout) -> term()
</span></a><br></p>
<div class="REFBODY"><p><a name="create_subscription-3"></a>
</p></div>
<p><a name="create_subscription-4"><span class="bold_code">create_subscription(Client, StartTime, StopTime, Timeout) -> term()
</span></a><br></p>
<div class="REFBODY"><p><a name="create_subscription-4"></a>
</p></div>
<p><a name="create_subscription-5"><span class="bold_code">create_subscription(Client, Stream, StartTime, StopTime, Timeout) -> term()
</span></a><br></p>
<div class="REFBODY"><p><a name="create_subscription-5"></a>
</p></div>
<p><a name="create_subscription-6"><span class="bold_code">create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout) -> Result</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Client = client()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Stream = stream_name()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Filter = simple_xml()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">StartTime = xs_datetime()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">StopTime = xs_datetime()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Timeout = timeout()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Result = ok | {error, error_reason()}</span><br>
</div>
</div>
<div class="REFBODY"><p><a name="create_subscription-6"></a>
<p>Create a subscription for event notifications.</p>
<p>This function sets up a subscription for netconf event
notifications of the given stream type, matching the given
filter. The calling process will receive notifications as messages
of type <span class="code">notification()</span>.</p>
<dl>
<dt><strong>Stream:</strong></dt>
<dd><p> An optional parameter that indicates which stream of events
is of interest. If not present, events in the default NETCONF
stream will be sent.</p></dd>
<dt><strong>Filter:</strong></dt>
<dd><p>An optional parameter that indicates which subset of all
possible events is of interest. The format of this parameter is
the same as that of the filter parameter in the NETCONF protocol
operations. If not present, all events not precluded by other
parameters will be sent. See section 3.6 for more information on
filters.</p></dd>
<dt><strong>StartTime:</strong></dt>
<dd><p>An optional parameter used to trigger the replay feature and
indicate that the replay should start at the time specified. If
<span class="code">StartTime</span> is not present, this is not a replay subscription.
It is not valid to specify start times that are later than the
current time. If the <span class="code">StartTime</span> specified is earlier than the
log can support, the replay will begin with the earliest
available notification. This parameter is of type dateTime and
compliant to [RFC3339]. Implementations must support time
zones.</p></dd>
<dt><strong>StopTime:</strong></dt>
<dd><p>An optional parameter used with the optional replay feature
to indicate the newest notifications of interest. If <span class="code">StopTime</span>
is not present, the notifications will continue until the
subscription is terminated. Must be used with and be later than
<span class="code">StartTime</span>. Values of <span class="code">StopTime</span> in the future are valid. This
parameter is of type dateTime and compliant to [RFC3339].
Implementations must support time zones.</p></dd>
</dl>
<p>See RFC5277 for further details about the event notification
mechanism.
</p>
</p></div>
<p><a name="delete_config-2"><span class="bold_code">delete_config(Client, Target) -> Result</span></a><br></p>
<div class="REFBODY"><p><a name="delete_config-2"></a>
<p>Equivalent to <span class="bold_code"><a href="#delete_config-3">delete_config(Client, Target, infinity)</a></span>.</p>
</p></div>
<p><a name="delete_config-3"><span class="bold_code">delete_config(Client, Target, Timeout) -> Result</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Client = client()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Target = startup | candidate</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Timeout = timeout()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Result = ok | {error, error_reason()}</span><br>
</div>
</div>
<div class="REFBODY"><p><a name="delete_config-3"></a>
<p>Delete configuration data.</p>
<p>The running configuration cannot be deleted and <span class="code">:candidate</span>
or <span class="code">:startup</span> must be advertised by the server.
</p>
</p></div>
<p><a name="edit_config-3"><span class="bold_code">edit_config(Client, Target, Config) -> Result</span></a><br></p>
<div class="REFBODY"><p><a name="edit_config-3"></a>
<p>Equivalent to <span class="bold_code"><a href="#edit_config-4">edit_config(Client, Target, Config, infinity)</a></span>.</p>
</p></div>
<p><a name="edit_config-4"><span class="bold_code">edit_config(Client, Target, Config, Timeout) -> Result</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Client = client()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Target = netconf_db()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Config = simple_xml()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Timeout = timeout()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Result = ok | {error, error_reason()}</span><br>
</div>
</div>
<div class="REFBODY"><p><a name="edit_config-4"></a>
<p>Edit configuration data.</p>
<p>Per default only the running target is available, unless the server
include <span class="code">:candidate</span> or <span class="code">:startup</span> in its list of
capabilities.
</p>
</p></div>
<p><a name="format_data-2"><span class="bold_code">format_data(X1, Data) -> term()
</span></a><br></p>
<div class="REFBODY"><p><a name="format_data-2"></a>
</p></div>
<p><a name="get-2"><span class="bold_code">get(Client, Filter) -> Result</span></a><br></p>
<div class="REFBODY"><p><a name="get-2"></a>
<p>Equivalent to <span class="bold_code"><a href="#get-3">get(Client, Filter, infinity)</a></span>.</p>
</p></div>
<p><a name="get-3"><span class="bold_code">get(Client, Filter, Timeout) -> Result</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Client = client()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Filter = simple_xml() | xpath()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Timeout = timeout()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Result = {ok, simple_xml()} | {error, error_reason()}</span><br>
</div>
</div>
<div class="REFBODY"><p><a name="get-3"></a>
<p>Get data.</p>
<p>This operation returns both configuration and state data from the
server.</p>
<p>Filter type <span class="code">xpath</span> can only be used if the server supports
<span class="code">:xpath</span>.
</p>
</p></div>
<p><a name="get_capabilities-1"><span class="bold_code">get_capabilities(Client) -> Result</span></a><br></p>
<div class="REFBODY"><p><a name="get_capabilities-1"></a>
<p>Equivalent to <span class="bold_code"><a href="#get_capabilities-2">get_capabilities(Client, infinity)</a></span>.</p>
</p></div>
<p><a name="get_capabilities-2"><span class="bold_code">get_capabilities(Client, Timeout) -> Result</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Client = client()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Timeout = timeout()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Result = [string()] | {error, error_reason()}</span><br>
</div>
</div>
<div class="REFBODY"><p><a name="get_capabilities-2"></a>
<p>Returns the server side capabilities</p>
<p>The following capability identifiers, defined in RFC 4741, can be returned:</p>
<ul>
<li><p><span class="code">"urn:ietf:params:netconf:base:1.0"</span></p></li>
<li><p><span class="code">"urn:ietf:params:netconf:capability:writable-running:1.0"</span></p></li>
<li><p><span class="code">"urn:ietf:params:netconf:capability:candidate:1.0"</span></p></li>
<li><p><span class="code">"urn:ietf:params:netconf:capability:confirmed-commit:1.0"</span></p></li>
<li><p><span class="code">"urn:ietf:params:netconf:capability:rollback-on-error:1.0"</span></p></li>
<li><p><span class="code">"urn:ietf:params:netconf:capability:startup:1.0"</span></p></li>
<li><p><span class="code">"urn:ietf:params:netconf:capability:url:1.0"</span></p></li>
<li><p><span class="code">"urn:ietf:params:netconf:capability:xpath:1.0"</span></p></li>
</ul>
<p>Note, additional identifiers may exist, e.g. server side namespace.
</p>
</p></div>
<p><a name="get_config-3"><span class="bold_code">get_config(Client, Source, Filter) -> Result</span></a><br></p>
<div class="REFBODY"><p><a name="get_config-3"></a>
<p>Equivalent to <span class="bold_code"><a href="#get_config-4">get_config(Client, Source, Filter, infinity)</a></span>.</p>
</p></div>
<p><a name="get_config-4"><span class="bold_code">get_config(Client, Source, Filter, Timeout) -> Result</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Client = client()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Source = netconf_db()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Filter = simple_xml() | xpath()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Timeout = timeout()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Result = {ok, simple_xml()} | {error, error_reason()}</span><br>
</div>
</div>
<div class="REFBODY"><p><a name="get_config-4"></a>
<p>Get configuration data.</p>
<p>To be able to access another source than <span class="code">running</span>, the server
must advertise <span class="code">:candidate</span> and/or <span class="code">:startup</span>.</p>
<p>Filter type <span class="code">xpath</span> can only be used if the server supports
<span class="code">:xpath</span>.</p>
</p></div>
<p><a name="get_event_streams-2"><span class="bold_code">get_event_streams(Client, Timeout) -> Result</span></a><br></p>
<div class="REFBODY"><p><a name="get_event_streams-2"></a>
<p>Equivalent to <span class="bold_code"><a href="#get_event_streams-3">get_event_streams(Client, [], Timeout)</a></span>.</p>
</p></div>
<p><a name="get_event_streams-3"><span class="bold_code">get_event_streams(Client, Streams, Timeout) -> Result</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Client = client()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Streams = [stream_name()]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Timeout = timeout()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Result = {ok, streams()} | {error, error_reason()}</span><br>
</div>
</div>
<div class="REFBODY"><p><a name="get_event_streams-3"></a>
<p>Send a request to get the given event streams.</p>
<p><span class="code">Streams</span> is a list of stream names. The following filter will
be sent to the netconf server in a <span class="code">get</span> request:</p>
<div class="example"><pre> <netconf xmlns="urn:ietf:params:xml:ns:netmod:notification">
<streams>
<stream>
<name>StreamName1</name>
</stream>
<stream>
<name>StreamName2</name>
</stream>
...
</streams>
</netconf></pre></div>
<p>If <span class="code">Streams</span> is an empty list, ALL streams will be requested
by sending the following filter:</p>
<div class="example"><pre> <netconf xmlns="urn:ietf:params:xml:ns:netmod:notification">
<streams/>
</netconf></pre></div>
<p>If more complex filtering is needed, a use <span class="bold_code"><a href="#get-2">get/2</a></span> or <span class="bold_code"><a href="#get-3">get/3</a></span> and specify the exact filter according to XML Schema for
Event Notifications found in RFC5277.
</p>
</p></div>
<p><a name="get_session_id-1"><span class="bold_code">get_session_id(Client) -> Result</span></a><br></p>
<div class="REFBODY"><p><a name="get_session_id-1"></a>
<p>Equivalent to <span class="bold_code"><a href="#get_session_id-2">get_session_id(Client, infinity)</a></span>.</p>
</p></div>
<p><a name="get_session_id-2"><span class="bold_code">get_session_id(Client, Timeout) -> Result</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Client = client()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Timeout = timeout()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Result = pos_integer() | {error, error_reason()}</span><br>
</div>
</div>
<div class="REFBODY"><p><a name="get_session_id-2"></a>
<p>Returns the session id associated with the given client.
</p>
</p></div>
<p><a name="handle_msg-2"><span class="bold_code">handle_msg(X1, State) -> term()
</span></a><br></p>
<div class="REFBODY"><p><a name="handle_msg-2"></a>
</p></div>
<p><a name="hello-1"><span class="bold_code">hello(Client) -> Result</span></a><br></p>
<div class="REFBODY"><p><a name="hello-1"></a>
<p>Equivalent to <span class="bold_code"><a href="#hello-2">hello(Client, infinity)</a></span>.</p>
</p></div>
<p><a name="hello-2"><span class="bold_code">hello(Client, Timeout) -> Result</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Client = handle()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Timeout = timeout()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Result = ok | {error, error_reason()}</span><br>
</div>
</div>
<div class="REFBODY"><p><a name="hello-2"></a>
<p>Exchange <span class="code">hello</span> messages with the server.</p>
<p>Sends a <span class="code">hello</span> message to the server and waits for the return.
</p>
</p></div>
<p><a name="kill_session-2"><span class="bold_code">kill_session(Client, SessionId) -> Result</span></a><br></p>
<div class="REFBODY"><p><a name="kill_session-2"></a>
<p>Equivalent to <span class="bold_code"><a href="#kill_session-3">kill_session(Client, SessionId, infinity)</a></span>.</p>
</p></div>
<p><a name="kill_session-3"><span class="bold_code">kill_session(Client, SessionId, Timeout) -> Result</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Client = client()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">SessionId = pos_integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Timeout = timeout()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Result = ok | {error, error_reason()}</span><br>
</div>
</div>
<div class="REFBODY"><p><a name="kill_session-3"></a>
<p>Force termination of the session associated with the supplied
session id.</p>
<p>The server side shall abort any operations currently in process,
release any locks and resources associated with the session, and
close any associated connections.</p>
<p>Only if the server is in the confirmed commit phase, the
configuration will be restored to its state before entering the
confirmed commit phase. Otherwise, no configuration roll back will
be performed.</p>
<p>If the given <span class="code">SessionId</span> is equal to the current session id,
an error will be returned.
</p>
</p></div>
<p><a name="lock-2"><span class="bold_code">lock(Client, Target) -> Result</span></a><br></p>
<div class="REFBODY"><p><a name="lock-2"></a>
<p>Equivalent to <span class="bold_code"><a href="#lock-3">lock(Client, Target, infinity)</a></span>.</p>
</p></div>
<p><a name="lock-3"><span class="bold_code">lock(Client, Target, Timeout) -> Result</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Client = client()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Target = netconf_db()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Timeout = timeout()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Result = ok | {error, error_reason()}</span><br>
</div>
</div>
<div class="REFBODY"><p><a name="lock-3"></a>
<p>Unlock configuration target.</p>
<p>Which target parameters that can be used depends on if
<span class="code">:candidate</span> and/or <span class="code">:startup</span> are supported by the
server. If successfull, the configuration system of the device is
not available to other clients (Netconf, CORBA, SNMP etc). Locks
are intended to be short-lived.</p>
<p>The operations <span class="bold_code"><a href="#kill_session-2">kill_session/2</a></span> or <span class="bold_code"><a href="#kill_session-3">kill_session/3</a></span> can
be used to force the release of a lock owned by another Netconf
session. How this is achieved by the server side is implementation
specific.
</p>
</p></div>
<p><a name="only_open-1"><span class="bold_code">only_open(Options) -> Result</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Options = options()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Result = {ok, handle()} | {error, error_reason()}</span><br>
</div>
</div>
<div class="REFBODY"><p><a name="only_open-1"></a>
<p>Open a netconf session, but don't send <span class="code">hello</span>.</p>
<p>As <span class="bold_code"><a href="#open-1">open/1</a></span> but does not send a <span class="code">hello</span> message.
</p>
</p></div>
<p><a name="only_open-2"><span class="bold_code">only_open(KeyOrName, ExtraOptions) -> Result</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">KeyOrName = key_or_name()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ExtraOptions = options()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Result = {ok, handle()} | {error, error_reason()}</span><br>
</div>
</div>
<div class="REFBODY"><p><a name="only_open-2"></a>
<p>Open a name netconf session, but don't send <span class="code">hello</span>.</p>
<p>As <span class="bold_code"><a href="#open-2">open/2</a></span> but does not send a <span class="code">hello</span> message.
</p>
</p></div>
<p><a name="open-1"><span class="bold_code">open(Options) -> Result</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Options = options()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Result = {ok, handle()} | {error, error_reason()}</span><br>
</div>
</div>
<div class="REFBODY"><p><a name="open-1"></a>
<p>Open a netconf session and exchange <span class="code">hello</span> messages.</p>
<p>If the server options are specified in a configuration file, or if
a named client is needed for logging purposes (see <span class="bold_code"><a href="#Logging">Logging</a></span>) use <span class="bold_code"><a href="#open-2">open/2</a></span> instead.</p>
<p>The opaque <span class="code">handler()</span> reference which is returned from this
function is required as client identifier when calling any other
function in this module.</p>
<p>The <span class="code">timeout</span> option (milli seconds) is used when setting up
the ssh connection and when waiting for the hello message from the
server. It is not used for any other purposes during the lifetime
of the connection.
</p>
</p></div>
<p><a name="open-2"><span class="bold_code">open(KeyOrName, ExtraOptions) -> Result</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">KeyOrName = key_or_name()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ExtraOptions = options()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Result = {ok, handle()} | {error, error_reason()}</span><br>
</div>
</div>
<div class="REFBODY"><p><a name="open-2"></a>
<p>Open a named netconf session and exchange <span class="code">hello</span> messages.</p>
<p>If <span class="code">KeyOrName</span> is a configured <span class="code">server_id()</span> or a
<span class="code">target_name()</span> associated with such an ID, then the options
for this server will be fetched from the configuration file.</p>
<p>The <span class="code">ExtraOptions</span> argument will be added to the options found in
the configuration file. If the same options are given, the values
from the configuration file will overwrite <span class="code">ExtraOptions</span>.</p>
<p>If the server is not specified in a configuration file, use <span class="bold_code"><a href="#open-1">open/1</a></span> instead.</p>
<p>The opaque <span class="code">handle()</span> reference which is returned from this
function can be used as client identifier when calling any other
function in this module. However, if <span class="code">KeyOrName</span> is a
<span class="code">target_name()</span>, i.e. if the server is named via a call to
<span class="code">ct:require/2</span> or a <span class="code">require</span> statement in the test
suite, then this name may be used instead of the <span class="code">handle()</span>.</p>
<p>The <span class="code">timeout</span> option (milli seconds) is used when setting up
the ssh connection and when waiting for the hello message from the
server. It is not used for any other purposes during the lifetime
of the connection.
</p>
<p><strong>See also:</strong> <span class="bold_code"><a href="ct.html#require-2">ct:require/2</a></span>.</p>
</p></div>
<p><a name="unlock-2"><span class="bold_code">unlock(Client, Target) -> Result</span></a><br></p>
<div class="REFBODY"><p><a name="unlock-2"></a>
<p>Equivalent to <span class="bold_code"><a href="#unlock-3">unlock(Client, Target, infinity)</a></span>.</p>
</p></div>
<p><a name="unlock-3"><span class="bold_code">unlock(Client, Target, Timeout) -> Result</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Client = client()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Target = netconf_db()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Timeout = timeout()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Result = ok | {error, error_reason()}</span><br>
</div>
</div>
<div class="REFBODY"><p><a name="unlock-3"></a>
<p>Unlock configuration target.</p>
<p>If the client earlier has aquired a lock, via <span class="bold_code"><a href="#lock-2">lock/2</a></span> or
<span class="bold_code"><a href="#lock-3">lock/3</a></span>, this operation release the associated lock. To be
able to access another target than <span class="code">running</span>, the server must
support <span class="code">:candidate</span> and/or <span class="code">:startup</span>.
</p>
</p></div>
Support
</div>
<div class="footer">
<hr>
<p>Copyright © 2003-2012 Ericsson AB. All Rights Reserved.</p>
</div>
</div>
</div></body>
</html>
