diff options
Diffstat (limited to 'lib/common_test/doc/src/ct_netconfc.xml')
| -rw-r--r-- | lib/common_test/doc/src/ct_netconfc.xml | 66 |
1 files changed, 33 insertions, 33 deletions
diff --git a/lib/common_test/doc/src/ct_netconfc.xml b/lib/common_test/doc/src/ct_netconfc.xml index f4d98b611b..a19f5c4663 100644 --- a/lib/common_test/doc/src/ct_netconfc.xml +++ b/lib/common_test/doc/src/ct_netconfc.xml @@ -45,21 +45,21 @@ <marker id="Connecting"/> <p><em>Connecting to a NETCONF server</em></p> - <p>Call <seealso marker="#connect-1"><c>connect/1,2</c></seealso> + <p>Call <seealso marker="#connect/1"><c>connect/1,2</c></seealso> to establish a connection to a server, then pass the returned - handle to <seealso marker="#session-1"><c>session/1-3</c></seealso> to + handle to <seealso marker="#session/1"><c>session/1-3</c></seealso> to establish a NETCONF session on a new SSH channel. Each call to - <seealso marker="#session-1"><c>session/1-3</c></seealso> establishes a + <seealso marker="#session/1"><c>session/1-3</c></seealso> establishes a new session on the same connection, and results in a hello message to the server.</p> <p>Alternately, - <seealso marker="#open-1"><c>open/1,2</c></seealso> can be used to + <seealso marker="#open/1"><c>open/1,2</c></seealso> can be used to establish a single session on a dedicated connection. (Or, equivalently, - <seealso marker="#only_open-1"><c>only_open/1,2</c></seealso> - followed by <seealso marker="#hello-1"><c>hello/1-3</c></seealso>.)</p> + <seealso marker="#only_open/1"><c>only_open/1,2</c></seealso> + followed by <seealso marker="#hello/1"><c>hello/1-3</c></seealso>.)</p> <p>Connect/session options can be specified in a configuration file with entries like the following.</p> @@ -80,12 +80,12 @@ procedure calls (RPCs) from client to server and a corresponding reply from server to client. RPCs are sent using like-named functions (eg. - <seealso marker="#edit_config-3"><c>edit_config/3-5</c></seealso> + <seealso marker="#edit_config/3"><c>edit_config/3-5</c></seealso> to send an edit-config RPC), with the server reply as return value. There are functions for each RPC defined in RFC 6241 and the create-subscription RPC from RFC 5277, all of which are - wrappers on <seealso marker="#send_rpc-2"><c>send_rpc/2,3</c></seealso>, + wrappers on <seealso marker="#send_rpc/2"><c>send_rpc/2,3</c></seealso>, that can be used to send an arbitrary RPC not defined in RFC 6241 or RFC 5277.</p> @@ -137,7 +137,7 @@ To do this, use hook option <c>hosts</c> and list the names of the servers/connections to be used in the suite. The connections must be named for this to work, that is, they must be opened with - <seealso marker="#open-2"><c>open/2</c></seealso>.</p> + <seealso marker="#open/2"><c>open/2</c></seealso>.</p> <p>Option <c>hosts</c> has no effect if <c>log_type</c> is set to <c>html</c> or <c>silent</c>.</p> @@ -215,11 +215,11 @@ <desc> <p>Handle to a connection to a NETCONF server as returned by - <seealso marker="#connect-1"><c>connect/1,2</c></seealso>, + <seealso marker="#connect/1"><c>connect/1,2</c></seealso>, or to a session as returned by - <seealso marker="#session-1"><c>session/1-3</c></seealso>, - <seealso marker="#open-1"><c>open/1,2</c></seealso>, - or <seealso marker="#only_open-1"><c>only_open/1,2</c></seealso>.</p> + <seealso marker="#session/1"><c>session/1-3</c></seealso>, + <seealso marker="#open/1"><c>open/1,2</c></seealso>, + or <seealso marker="#only_open/1"><c>only_open/1,2</c></seealso>.</p> </desc> </datatype> <datatype> @@ -244,7 +244,7 @@ <name name="notification"/> <desc> <p>Event notification messages sent as a result of calls to - <seealso marker="#create_subscription-2"><c>create_subscription/2,3</c></seealso>.</p> + <seealso marker="#create_subscription/2"><c>create_subscription/2,3</c></seealso>.</p> </desc> </datatype> <datatype> @@ -253,7 +253,7 @@ <p>Options <c>host</c> and <c>port</c> specify the server endpoint to which to connect, and are passed directly to <seealso - marker="ssh:ssh#connect-3"><c>ssh:connect/4</c></seealso>, + marker="ssh:ssh#connect/3"><c>ssh:connect/4</c></seealso>, as are arbitrary ssh options. Common options are <c>user</c>, <c>password</c> and <c>user_dir</c>.</p> @@ -299,7 +299,7 @@ <name name="streams"/> <desc> <p>Stream information as returned by - <seealso marker="#get_event_streams-1"><c>get_event_streams/1-3</c></seealso>. + <seealso marker="#get_event_streams/1"><c>get_event_streams/1-3</c></seealso>. See RFC 5277, "XML Schema for Event Notifications", for detail on the format of the string values.</p> </desc> @@ -377,14 +377,14 @@ <p>Opens an SSH connection to a NETCONF server.</p> <p>If the server options are specified in a configuration file, use - <seealso marker="#connect-2"><c>connect/2</c></seealso> + <seealso marker="#connect/2"><c>connect/2</c></seealso> instead.</p> <p>The opaque <seealso marker="#type-handle"><c>handle()</c></seealso> reference returned from this function is required as connection identifier when opening sessions over this connection, see - <seealso marker="#session-1"><c>session/1-3</c></seealso>.</p> + <seealso marker="#session/1"><c>session/1-3</c></seealso>.</p> </desc> </func> @@ -404,17 +404,17 @@ the configuration file takes precedence.</p> <p>If the server is not specified in a configuration file, use - <seealso marker="#connect-1"><c>connect/1</c></seealso> + <seealso marker="#connect/1"><c>connect/1</c></seealso> instead.</p> <p>The opaque <seealso marker="#type-handle"><c>handle()</c></seealso> reference returned from this function can be used as connection identifier when opening sessions over this connection, see - <seealso marker="#session-1"><c>session/1-3</c></seealso>. + <seealso marker="#session/1"><c>session/1-3</c></seealso>. However, if <c><anno>KeyOrName</anno></c> is a <c>target_name()</c>, that is, if the server is named through a - call to <seealso marker="ct#require-2"><c>ct:require/2</c></seealso> + call to <seealso marker="ct#require/2"><c>ct:require/2</c></seealso> or a <c>require</c> statement in the test suite, then this name can be used instead of <seealso marker="#type-handle"><c>handle()</c></seealso>.</p> @@ -513,7 +513,7 @@ <p>If there are open NETCONF sessions on the connection, these will be brutally aborted. To avoid this, close each session - with <seealso marker="#close_session-1"><c>close_session/1,2</c></seealso></p> + with <seealso marker="#close_session/1"><c>close_session/1,2</c></seealso></p> </desc> </func> @@ -618,7 +618,7 @@ </netconf></pre> <p>If more complex filtering is needed, use - <seealso marker="#get-2"><c>ct_netconfc:get/2,3</c></seealso> and + <seealso marker="#get/2"><c>ct_netconfc:get/2,3</c></seealso> and specify the exact filter according to "XML Schema for Event Notifications" in RFC 5277.</p> </desc> @@ -645,7 +645,7 @@ specified timeout.</p> <p>Note that capabilities for an outgoing hello can be passed - directly to <seealso marker="#open-2"><c>open/2</c></seealso>.</p> + directly to <seealso marker="#open/2"><c>open/2</c></seealso>.</p> </desc> </func> @@ -685,7 +685,7 @@ Locks are intended to be short-lived.</p> <p>Operation - <seealso marker="#kill_session-2"><c>kill_session/2,3</c></seealso> + <seealso marker="#kill_session/2"><c>kill_session/2,3</c></seealso> 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> @@ -698,7 +698,7 @@ <desc> <p>Opens a NETCONF session, but does not send <c>hello</c>.</p> - <p>As <seealso marker="#open-1"><c>open/1</c></seealso>, but + <p>As <seealso marker="#open/1"><c>open/1</c></seealso>, but does not send a <c>hello</c> message.</p> </desc> </func> @@ -709,7 +709,7 @@ <desc> <p>Opens a named NETCONF session, but does not send <c>hello</c>.</p> - <p>As <seealso marker="#open-2"><c>open/2</c></seealso>, but + <p>As <seealso marker="#open/2"><c>open/2</c></seealso>, but does not send a <c>hello</c> message.</p> </desc> </func> @@ -723,7 +723,7 @@ <p>If the server options are specified in a configuration file, or if a named client is needed for logging purposes (see section <seealso marker="#Logging">Logging</seealso> in this module), use - <seealso marker="#open-2"><c>open/2</c></seealso> + <seealso marker="#open/2"><c>open/2</c></seealso> instead.</p> <p>The opaque <seealso marker="#type-handle"><c>handle()</c></seealso> @@ -751,7 +751,7 @@ the configuration file take precedence.</p> <p>If the server is not specified in a configuration file, use - <seealso marker="#open-1"><c>open/1</c></seealso> + <seealso marker="#open/1"><c>open/1</c></seealso> instead.</p> <p>The opaque <seealso marker="#type-handle"><c>handle()</c></seealso> @@ -759,13 +759,13 @@ function can be used as client identifier when calling any other function in this module. However, if <c><anno>KeyOrName</anno></c> is a <c>target_name()</c>, that is, if the server is named through a - call to <seealso marker="ct#require-2"><c>ct:require/2</c></seealso> + call to <seealso marker="ct#require/2"><c>ct:require/2</c></seealso> or a <c>require</c> statement in the test suite, then this name can be used instead of <seealso marker="#type-handle"><c>handle()</c></seealso>.</p> <p>See also - <seealso marker="ct#require-2"><c>ct:require/2</c></seealso>.</p> + <seealso marker="ct#require/2"><c>ct:require/2</c></seealso>.</p> </desc> </func> @@ -817,7 +817,7 @@ other function in this module. However, if <c><anno>KeyOrName</anno></c> is used and it is a <c>target_name()</c>, that is, if the server is named through a call - to <seealso marker="ct#require-2"><c>ct:require/2</c></seealso> + to <seealso marker="ct#require/2"><c>ct:require/2</c></seealso> or a <c>require</c> statement in the test suite, then this name can be used instead of <seealso marker="#type-handle"><c>handle()</c></seealso>.</p> @@ -833,7 +833,7 @@ <p>Unlocks the configuration target.</p> <p>If the client earlier has acquired a lock through - <seealso marker="#lock-2"><c>lock/2,3</c></seealso>, this + <seealso marker="#lock/2"><c>lock/2,3</c></seealso>, this operation releases the associated lock. To access another target than <c>running</c>, the server must support <c>:candidate</c> and/or <c>:startup</c>.</p> |