Skip to content

Commit

Permalink
fix doc html chars
Browse files Browse the repository at this point in the history
Change-Id: Icbe2969bd0ac9de0e05de4fd44e4ed28677af6f9
Reviewed-on: http://photon-jenkins.eng.vmware.com:8082/4184
Reviewed-by: Sharath George
Tested-by: Sharath George
  • Loading branch information
Priyesh Padmavilasom authored and Sharath George committed Nov 2, 2017
1 parent 6d3c757 commit b1f6c7b
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 78 deletions.
41 changes: 18 additions & 23 deletions docs/netmgr.python.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,22 +21,21 @@ To set up and run the latest version of the Network Manager API for Python:
# Initialization Steps
~~~~
# python3
>>> import pmd
>>> net = pmd.server().net
>>> net._command_
>>> import pmd
>>> net = pmd.server().net
~~~~
# Get Online Help

Get help for all commands.
~~~~
>>> help(net)
>>> help(net)
~~~~
Get help for a specific command.
~~~~
>>> help(net.add_ntp_servers)
>>> help(net.add_ntp_servers)
-in function add_ntp_servers:
add_ntp_servers(...) method of [server.net](http://server.net/) instance
net.add_ntp_servers(ntpservers = ["20.20.20.20", "25.30.40.70"])
net.add_ntp_servers(ntpservers = ["20.20.20.20", "25.30.40.70"])
adds ntp servers. returns success: 0, failure: exception.
(END)
~~~~
Expand All @@ -57,23 +56,19 @@ net.get_system_network_info()

**Example**
~~~~
>>> system_network_info = netmgmt.get_system_network_info()
>>> system_network_info = netmgmt.get_system_network_info()
>>> type (system_network_info)
>>> print ( system_network_info)
<class 'list'>
>>> print ( system_network_info)
[{DUID: 00:02:11:22:33:44:55:66:77:20, DNS Mode: (null), DNS ServerList: ['10.10.100.100', '20.20.200.10'], DNS domain list: [' [abcd.com](http://abcd.com)'], NTP ServerList: (null)}]
[{DUID: 00:02:11:22:33:44:55:66:77:20, DNS Mode: (null), DNS ServerList: ['10.10.100.100', '20.20.200.10'], DNS domain list: [' [abcd.com](http://abcd.com)'], NTP ServerList: (null)}]
~~~~
### get_err_info

Get information about the specified error number.

**Syntax**
~~~~
net.get_err_info(error = <error_number>)
net.get_err_info(error = <error_number>)
~~~~
**Parameters**

Expand All @@ -100,9 +95,9 @@ Here is the list of error numbers:

Example
~~~~
&gt;&gt; net.get_err_info(error = 4097)
>> net.get_err_info(error = 4097)
&#39;invalid parameter&#39;
'invalid parameter'
~~~~
# Interface Configuration

Expand Down Expand Up @@ -509,7 +504,7 @@ Set the list of DNS domains for the specified interface.

**Syntax**
~~~~
net.set_dns_domains(domains = [&quot;domain1&quot;,&quot;domain2&quot;,...], ifname = interface_name)
net.set_dns_domains(domains = ["domain1","domain2",...], ifname = interface_name)
~~~~
**Parameters**

Expand All @@ -527,7 +522,7 @@ Set the list of DNS servers for the specified interface.

**Syntax**
~~~~
net.set_dns_servers(dns_mode = [dhcp, static], servers = [&quot;server1&quot;,&quot;server2&quot;, ...], ifname = interface_name)
net.set_dns_servers(dns_mode = [dhcp, static], servers = ["server1","server2", ...], ifname = interface_name)
~~~~
**Parameters**

Expand Down Expand Up @@ -565,7 +560,7 @@ Set the IAID for the specified interface.

**Syntax**
~~~~
net.set_link_iaid(ifname = interface_name, iaid = &lt;iaid&gt;)
net.set_link_iaid(ifname = interface_name, iaid = <iaid>)
~~~~
**Parameters**

Expand Down Expand Up @@ -622,7 +617,7 @@ Add one or more NTP servers to the NTP servers list.

**Syntax**
~~~~
net.add_ntp_servers(ntpservers = [&quot;server1&quot;, &quot;server2&quot;, ...])
net.add_ntp_servers(ntpservers = ["server1", "server2", ...])
~~~~
**Parameters**

Expand All @@ -639,7 +634,7 @@ Remove one or more NTP servers from the NTP servers list.

**Syntax**
~~~~
net.del_ntp_servers(ntpservers = [&quot;server1&quot;, &quot;server2&quot;, ...])
net.del_ntp_servers(ntpservers = ["server1", "server2", ...])
~~~~
**Parameters**

Expand Down Expand Up @@ -669,7 +664,7 @@ Set the NTP servers list.

**Syntax**
~~~~
net.set_ntp_servers(ntpservers = [&quot;server1&quot;, &quot;server2&quot;, ...])
net.set_ntp_servers(ntpservers = ["server1", "server2", ...])
~~~~
**Parameters**

Expand Down Expand Up @@ -781,4 +776,4 @@ net.set_network_param(object = interface_name or filename, paramname = SectionNa
**Returns**

- success: 0
- failure: exception
- failure: exception
Loading

0 comments on commit b1f6c7b

Please sign in to comment.