Change-Id: Icbe2969bd0ac9de0e05de4fd44e4ed28677af6f9
Reviewed-on: http://photon-jenkins.eng.vmware.com:8082/4184
Reviewed-by: Sharath George
Tested-by: Sharath George
| ... | ... |
@@ -21,22 +21,21 @@ To set up and run the latest version of the Network Manager API for Python: |
| 21 | 21 |
# Initialization Steps |
| 22 | 22 |
~~~~ |
| 23 | 23 |
# python3 |
| 24 |
->>> import pmd |
|
| 25 |
->>> net = pmd.server().net |
|
| 26 |
->>> net._command_ |
|
| 24 |
+>>> import pmd |
|
| 25 |
+>>> net = pmd.server().net |
|
| 27 | 26 |
~~~~ |
| 28 | 27 |
# Get Online Help |
| 29 | 28 |
|
| 30 | 29 |
Get help for all commands. |
| 31 | 30 |
~~~~ |
| 32 |
->>> help(net) |
|
| 31 |
+>>> help(net) |
|
| 33 | 32 |
~~~~ |
| 34 | 33 |
Get help for a specific command. |
| 35 | 34 |
~~~~ |
| 36 |
->>> help(net.add_ntp_servers) |
|
| 35 |
+>>> help(net.add_ntp_servers) |
|
| 37 | 36 |
-in function add_ntp_servers: |
| 38 | 37 |
add_ntp_servers(...) method of [server.net](http://server.net/) instance |
| 39 |
- net.add_ntp_servers(ntpservers = ["20.20.20.20", "25.30.40.70"]) |
|
| 38 |
+ net.add_ntp_servers(ntpservers = ["20.20.20.20", "25.30.40.70"]) |
|
| 40 | 39 |
adds ntp servers. returns success: 0, failure: exception. |
| 41 | 40 |
(END) |
| 42 | 41 |
~~~~ |
| ... | ... |
@@ -57,15 +56,11 @@ net.get_system_network_info() |
| 57 | 57 |
|
| 58 | 58 |
**Example** |
| 59 | 59 |
~~~~ |
| 60 |
->>> system_network_info = netmgmt.get_system_network_info() |
|
| 60 |
+>>> system_network_info = netmgmt.get_system_network_info() |
|
| 61 | 61 |
|
| 62 |
->>> type (system_network_info) |
|
| 62 |
+>>> print ( system_network_info) |
|
| 63 | 63 |
|
| 64 |
-<class 'list'> |
|
| 65 |
- |
|
| 66 |
->>> print ( system_network_info) |
|
| 67 |
- |
|
| 68 |
-[{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)}]
|
|
| 64 |
+[{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)}]
|
|
| 69 | 65 |
~~~~ |
| 70 | 66 |
### get_err_info |
| 71 | 67 |
|
| ... | ... |
@@ -73,7 +68,7 @@ Get information about the specified error number. |
| 73 | 73 |
|
| 74 | 74 |
**Syntax** |
| 75 | 75 |
~~~~ |
| 76 |
-net.get_err_info(error = <error_number>) |
|
| 76 |
+net.get_err_info(error = <error_number>) |
|
| 77 | 77 |
~~~~ |
| 78 | 78 |
**Parameters** |
| 79 | 79 |
|
| ... | ... |
@@ -100,9 +95,9 @@ Here is the list of error numbers: |
| 100 | 100 |
|
| 101 | 101 |
Example |
| 102 | 102 |
~~~~ |
| 103 |
->> net.get_err_info(error = 4097) |
|
| 103 |
+>> net.get_err_info(error = 4097) |
|
| 104 | 104 |
|
| 105 |
-'invalid parameter' |
|
| 105 |
+'invalid parameter' |
|
| 106 | 106 |
~~~~ |
| 107 | 107 |
# Interface Configuration |
| 108 | 108 |
|
| ... | ... |
@@ -509,7 +504,7 @@ Set the list of DNS domains for the specified interface. |
| 509 | 509 |
|
| 510 | 510 |
**Syntax** |
| 511 | 511 |
~~~~ |
| 512 |
-net.set_dns_domains(domains = ["domain1","domain2",...], ifname = interface_name) |
|
| 512 |
+net.set_dns_domains(domains = ["domain1","domain2",...], ifname = interface_name) |
|
| 513 | 513 |
~~~~ |
| 514 | 514 |
**Parameters** |
| 515 | 515 |
|
| ... | ... |
@@ -527,7 +522,7 @@ Set the list of DNS servers for the specified interface. |
| 527 | 527 |
|
| 528 | 528 |
**Syntax** |
| 529 | 529 |
~~~~ |
| 530 |
-net.set_dns_servers(dns_mode = [dhcp, static], servers = ["server1","server2", ...], ifname = interface_name) |
|
| 530 |
+net.set_dns_servers(dns_mode = [dhcp, static], servers = ["server1","server2", ...], ifname = interface_name) |
|
| 531 | 531 |
~~~~ |
| 532 | 532 |
**Parameters** |
| 533 | 533 |
|
| ... | ... |
@@ -565,7 +560,7 @@ Set the IAID for the specified interface. |
| 565 | 565 |
|
| 566 | 566 |
**Syntax** |
| 567 | 567 |
~~~~ |
| 568 |
-net.set_link_iaid(ifname = interface_name, iaid = <iaid>) |
|
| 568 |
+net.set_link_iaid(ifname = interface_name, iaid = <iaid>) |
|
| 569 | 569 |
~~~~ |
| 570 | 570 |
**Parameters** |
| 571 | 571 |
|
| ... | ... |
@@ -622,7 +617,7 @@ Add one or more NTP servers to the NTP servers list. |
| 622 | 622 |
|
| 623 | 623 |
**Syntax** |
| 624 | 624 |
~~~~ |
| 625 |
-net.add_ntp_servers(ntpservers = ["server1", "server2", ...]) |
|
| 625 |
+net.add_ntp_servers(ntpservers = ["server1", "server2", ...]) |
|
| 626 | 626 |
~~~~ |
| 627 | 627 |
**Parameters** |
| 628 | 628 |
|
| ... | ... |
@@ -639,7 +634,7 @@ Remove one or more NTP servers from the NTP servers list. |
| 639 | 639 |
|
| 640 | 640 |
**Syntax** |
| 641 | 641 |
~~~~ |
| 642 |
-net.del_ntp_servers(ntpservers = ["server1", "server2", ...]) |
|
| 642 |
+net.del_ntp_servers(ntpservers = ["server1", "server2", ...]) |
|
| 643 | 643 |
~~~~ |
| 644 | 644 |
**Parameters** |
| 645 | 645 |
|
| ... | ... |
@@ -669,7 +664,7 @@ Set the NTP servers list. |
| 669 | 669 |
|
| 670 | 670 |
**Syntax** |
| 671 | 671 |
~~~~ |
| 672 |
-net.set_ntp_servers(ntpservers = ["server1", "server2", ...]) |
|
| 672 |
+net.set_ntp_servers(ntpservers = ["server1", "server2", ...]) |
|
| 673 | 673 |
~~~~ |
| 674 | 674 |
**Parameters** |
| 675 | 675 |
|
| ... | ... |
@@ -781,4 +776,4 @@ net.set_network_param(object = interface_name or filename, paramname = SectionNa |
| 781 | 781 |
**Returns** |
| 782 | 782 |
|
| 783 | 783 |
- success: 0 |
| 784 |
-- failure: exception |
|
| 785 | 784 |
\ No newline at end of file |
| 785 |
+- failure: exception |
| ... | ... |
@@ -17,7 +17,7 @@ tndf install pmd-cli |
| 17 | 17 |
~~~~ |
| 18 | 18 |
# Syntax |
| 19 | 19 |
~~~~ |
| 20 |
-pmd-cli [connection_auth_options] <component> <command> [command_options] |
|
| 20 |
+pmd-cli [connection_auth_options] <component> <command> [command_options] |
|
| 21 | 21 |
~~~~ |
| 22 | 22 |
Passed-in parameter values can be enclosed in single (') or double-quotes (") as long as you use matching characters to denote the beginning and end of the value. Unless a parameter value contains special characters or spaces, you can also omit quotes altogether. |
| 23 | 23 |
|
| ... | ... |
@@ -27,7 +27,7 @@ Passed-in parameter values can be enclosed in single (') or double-quotes (& |
| 27 | 27 |
|
| 28 | 28 |
For local connections, you omit the connection and authorization options: |
| 29 | 29 |
~~~~ |
| 30 |
-pmd-cli <component> <cmd> <options> |
|
| 30 |
+pmd-cli <component> <cmd> <options> |
|
| 31 | 31 |
~~~~ |
| 32 | 32 |
Permissions for the currently logged-in user apply when executing commands. This is the same as specifying --servername localhost. |
| 33 | 33 |
|
| ... | ... |
@@ -44,23 +44,23 @@ What follows are three options for remote connections. |
| 44 | 44 |
|
| 45 | 45 |
**System User** |
| 46 | 46 |
~~~~ |
| 47 |
-pmd-cli --servername <server> --user <username> |
|
| 47 |
+pmd-cli --servername <server> --user <username> |
|
| 48 | 48 |
~~~~ |
| 49 | 49 |
**Lightwave User** |
| 50 | 50 |
|
| 51 | 51 |
Before using this method, the pmd server must be joined or should be part of embedded Lightwave. |
| 52 | 52 |
~~~~ |
| 53 |
-pmd-cli --servername <server> --user <username> --domain <lightwave_domain> |
|
| 53 |
+pmd-cli --servername <server> --user <username> --domain <lightwave_domain> |
|
| 54 | 54 |
~~~~ |
| 55 | 55 |
**Kerberos spn** |
| 56 | 56 |
|
| 57 | 57 |
Before using this method, the client must run kinit successfully. |
| 58 | 58 |
~~~~ |
| 59 |
-pmd-cli --servername <server> --spn <service_principal_name> |
|
| 59 |
+pmd-cli --servername <server> --spn <service_principal_name> |
|
| 60 | 60 |
~~~~ |
| 61 | 61 |
## Component |
| 62 | 62 |
|
| 63 |
-``<component>`` is one of the following values: |
|
| 63 |
+``<component>`` is one of the following values: |
|
| 64 | 64 |
|
| 65 | 65 |
- ``firewall`` |
| 66 | 66 |
- ``net`` |
| ... | ... |
@@ -73,7 +73,7 @@ The Photon Management Daemon provides CLI commands to help you get information a |
| 73 | 73 |
|
| 74 | 74 |
## Syntax |
| 75 | 75 |
~~~~ |
| 76 |
-pmd-cli [connection_auth_options] firewall <command> [command_options] |
|
| 76 |
+pmd-cli [connection_auth_options] firewall <command> [command_options] |
|
| 77 | 77 |
~~~~ |
| 78 | 78 |
## firewall help |
| 79 | 79 |
|
| ... | ... |
@@ -91,17 +91,17 @@ This command returns information about each firewall rule, such as the chain to |
| 91 | 91 |
|
| 92 | 92 |
Add a new firewall rule. |
| 93 | 93 |
~~~~ |
| 94 |
-pmd-cli firewall rules --chain <chain_name> --add <rule_specification> |
|
| 94 |
+pmd-cli firewall rules --chain <chain_name> --add <rule_specification> |
|
| 95 | 95 |
~~~~ |
| 96 | 96 |
Example: |
| 97 | 97 |
~~~~ |
| 98 |
-pmd-cli firewall rules --chain INPUT --add "-p tcp -m tcp --dport 21 -j ACCEPT" |
|
| 98 |
+pmd-cli firewall rules --chain INPUT --add "-p tcp -m tcp --dport 21 -j ACCEPT" |
|
| 99 | 99 |
~~~~ |
| 100 | 100 |
**Note:** To confirm that the firewall rule was added, run iptables -S. Running pmd-cli firewall rules lists only persistent rules. |
| 101 | 101 |
|
| 102 | 102 |
Delete a new firewall rule. |
| 103 | 103 |
~~~~ |
| 104 |
-pmd-cli firewall rules --chain <chain_name> --delete <rule_specification> |
|
| 104 |
+pmd-cli firewall rules --chain <chain_name> --delete <rule_specification> |
|
| 105 | 105 |
~~~~ |
| 106 | 106 |
**Note:** To confirm that the firewall rule was removed, run iptables -S. Running pmd-cli firewall rules lists only persistent rules. |
| 107 | 107 |
|
| ... | ... |
@@ -117,7 +117,7 @@ The Photon Management Daemon provides CLI commands to help you manage network in |
| 117 | 117 |
|
| 118 | 118 |
## Syntax |
| 119 | 119 |
~~~~ |
| 120 |
-pmd-cli [connection_auth_options] net <command> [command_options] |
|
| 120 |
+pmd-cli [connection_auth_options] net <command> [command_options] |
|
| 121 | 121 |
~~~~ |
| 122 | 122 |
Many of these commands require the interface name (–interface <ifname>). IP addresses can be specified in dot-decimal notation or as prefixes. Other command options are described below. |
| 123 | 123 |
|
| ... | ... |
@@ -125,53 +125,53 @@ Many of these commands require the interface name (–interface <ifname>). |
| 125 | 125 |
|
| 126 | 126 |
Get the mac address, mtu, link state, and link mode for the specified interface. |
| 127 | 127 |
~~~~ |
| 128 |
-pmd-cli net link_info --get --interface <ifame> |
|
| 128 |
+pmd-cli net link_info --get --interface <ifname> |
|
| 129 | 129 |
~~~~ |
| 130 | 130 |
Set the MAC address, mode (manual or auto), link state (up or down), link mode (manual or auto), and MTU for the specified interface. |
| 131 | 131 |
~~~~ |
| 132 |
-pmd-cli net link_info --set --interface <ifname> --macaddr <mac_address> --mode <manual|auto> --state <up|down> --mtu <mtu> |
|
| 132 |
+pmd-cli net link_info --set --interface <ifname> --macaddr <mac_address> --mode <manual|auto> --state <up|down> --mtu <mtu> |
|
| 133 | 133 |
~~~~ |
| 134 | 134 |
## net ip4_address |
| 135 | 135 |
|
| 136 | 136 |
Get the IPv4 address for the specified interface. |
| 137 | 137 |
~~~~ |
| 138 |
-pmd-cli net ip4_address --get --interface <ifame> |
|
| 138 |
+pmd-cli net ip4_address --get --interface <ifname> |
|
| 139 | 139 |
~~~~ |
| 140 | 140 |
Set the IPv4 address (dot-decimal or prefix notation), mode (dhcp, static, or none), and (optionally) the default gateway for the specified interface. |
| 141 | 141 |
~~~~ |
| 142 |
-pmd-cli net ip4_address --set --interface <ifname> --mode <dhcp|static|none> --addr <IPv4Address/prefix> --gateway <gateway_address> |
|
| 142 |
+pmd-cli net ip4_address --set --interface <ifname> --mode <dhcp|static|none> --addr <IPv4Address/prefix> --gateway <gateway_address> |
|
| 143 | 143 |
~~~~ |
| 144 | 144 |
## net ip6_address |
| 145 | 145 |
|
| 146 | 146 |
Get IPv6 address(es) for the specified interface. |
| 147 | 147 |
~~~~ |
| 148 |
-pmd-cli net ip6_address --get --interface <ifame> |
|
| 148 |
+pmd-cli net ip6_address --get --interface <ifname> |
|
| 149 | 149 |
~~~~ |
| 150 | 150 |
Add one or more IPv6 addresses (comma-separated list in dot-decimal or prefix notation) to the specified interface. |
| 151 | 151 |
~~~~ |
| 152 |
-pmd-cli net ip6_address --add --interface <ifame> --addrlist <IPv6Addr1/prefix,IPv6Addr2/prefix,...> |
|
| 152 |
+pmd-cli net ip6_address --add --interface <ifname> --addrlist <IPv6Addr1/prefix,IPv6Addr2/prefix,...> |
|
| 153 | 153 |
~~~~ |
| 154 | 154 |
Delete one or more IPv6 addresses (comma-separated list in dot-decimal or prefix notation) from the specified interface. |
| 155 | 155 |
~~~~ |
| 156 |
-pmd-cli net ip6_address --del --interface <ifame> --addrlist <IPv6Addr1/prefix,IPv6Addr2/prefix,...> |
|
| 156 |
+pmd-cli net ip6_address --del --interface <ifname> --addrlist <IPv6Addr1/prefix,IPv6Addr2/prefix,...> |
|
| 157 | 157 |
~~~~ |
| 158 | 158 |
Set the DHCP mode (1=enable, 0=disable) and autoconfigure settings (1=enable, 0=disable) for the specified interface. |
| 159 | 159 |
~~~~ |
| 160 |
-pmd-cli net ip6_address --set --interface <ifname> --dhcp <1|0> --autoconf <1|0> |
|
| 160 |
+pmd-cli net ip6_address --set --interface <ifname> --dhcp <1|0> --autoconf <1|0> |
|
| 161 | 161 |
~~~~ |
| 162 | 162 |
## net ip_route |
| 163 | 163 |
|
| 164 | 164 |
Get the static IP route for the specified interface. |
| 165 | 165 |
~~~~ |
| 166 |
-pmd-cli net ip_route --get --interface <ifame> |
|
| 166 |
+pmd-cli net ip_route --get --interface <ifname> |
|
| 167 | 167 |
~~~~ |
| 168 | 168 |
Add the static IP route (gateway IP, destination network, and metric) to the specified interface. |
| 169 | 169 |
~~~~ |
| 170 |
-pmd-cli net ip_route --add --interface <ifname> --gateway <GatewayIP> --destination <DestinationNetwork/prefix> --metric <N> |
|
| 170 |
+pmd-cli net ip_route --add --interface <ifname> --gateway <GatewayIP> --destination <DestinationNetwork/prefix> --metric <N> |
|
| 171 | 171 |
~~~~ |
| 172 | 172 |
Delete the specified static IP route from the specified interface. |
| 173 | 173 |
~~~~ |
| 174 |
-pmd-cli net ip_route --del --interface <ifname> --destination <DestIP/N> |
|
| 174 |
+pmd-cli net ip_route --del --interface <ifname> --destination <DestIP/N> |
|
| 175 | 175 |
~~~~ |
| 176 | 176 |
## net dns_servers |
| 177 | 177 |
|
| ... | ... |
@@ -181,15 +181,15 @@ pmd-cli net dns_servers --get |
| 181 | 181 |
~~~~ |
| 182 | 182 |
Set the DNS mode (dhcp or static) for one or more DNS servers (comma-separated list). |
| 183 | 183 |
~~~~ |
| 184 |
-pmd-cli net dns_servers --set --mode <dhcp|static> --servers <server1,server2,...> |
|
| 184 |
+pmd-cli net dns_servers --set --mode <dhcp|static> --servers <server1,server2,...> |
|
| 185 | 185 |
~~~~ |
| 186 | 186 |
Add a DNS server to the list of DNS servers. |
| 187 | 187 |
~~~~ |
| 188 |
-pmd-cli net dns_servers --add --servers <server> |
|
| 188 |
+pmd-cli net dns_servers --add --servers <server> |
|
| 189 | 189 |
~~~~ |
| 190 | 190 |
Remove the specified DNS server from the list of DNS servers. |
| 191 | 191 |
~~~~ |
| 192 |
-pmd-cli net dns_servers --del --servers <server> |
|
| 192 |
+pmd-cli net dns_servers --del --servers <server> |
|
| 193 | 193 |
~~~~ |
| 194 | 194 |
## net dns_domains |
| 195 | 195 |
|
| ... | ... |
@@ -199,15 +199,15 @@ pmd-cli net dns_domains --get |
| 199 | 199 |
~~~~ |
| 200 | 200 |
Set the list of DNS domains (one or more DNS domains in a comma-separated list). |
| 201 | 201 |
~~~~ |
| 202 |
-pmd-cli net dns_domains --set --domains <domain1,domain2,...> |
|
| 202 |
+pmd-cli net dns_domains --set --domains <domain1,domain2,...> |
|
| 203 | 203 |
~~~~ |
| 204 | 204 |
Add a DNS domain to the list of DNS domains. |
| 205 | 205 |
~~~~ |
| 206 |
-pmd-cli net dns_domains --add --domains <domain1> |
|
| 206 |
+pmd-cli net dns_domains --add --domains <domain1> |
|
| 207 | 207 |
~~~~ |
| 208 | 208 |
Delete a DNS domain from the list of DNS domains. |
| 209 | 209 |
~~~~ |
| 210 |
-pmd-cli net dns_domains --del --domains <domain1> |
|
| 210 |
+pmd-cli net dns_domains --del --domains <domain1> |
|
| 211 | 211 |
~~~~ |
| 212 | 212 |
## net dhcp_duid |
| 213 | 213 |
|
| ... | ... |
@@ -217,17 +217,17 @@ pmd-cli net dhcp_duid --get |
| 217 | 217 |
~~~~ |
| 218 | 218 |
Set the DHCP DUID for all interfaces in the system. |
| 219 | 219 |
~~~~ |
| 220 |
-pmd-cli net dhcp_duid --set --duid <duid> |
|
| 220 |
+pmd-cli net dhcp_duid --set --duid <duid> |
|
| 221 | 221 |
~~~~ |
| 222 | 222 |
## net if_iaid |
| 223 | 223 |
|
| 224 | 224 |
Get the IAID for the specified interface. |
| 225 | 225 |
~~~~ |
| 226 |
-pmd-cli net if_iaid --get --interface <ifname> |
|
| 226 |
+pmd-cli net if_iaid --get --interface <ifname> |
|
| 227 | 227 |
~~~~ |
| 228 | 228 |
Set the IAID for the specified interface. |
| 229 | 229 |
~~~~ |
| 230 |
-pmd-cli net if_iaid --set --interface <ifname> --iaid <iaid> |
|
| 230 |
+pmd-cli net if_iaid --set --interface <ifname> --iaid <iaid> |
|
| 231 | 231 |
~~~~ |
| 232 | 232 |
## net ntp_servers |
| 233 | 233 |
|
| ... | ... |
@@ -237,15 +237,15 @@ pmd-cli net ntp_servers --get |
| 237 | 237 |
~~~~ |
| 238 | 238 |
Set the NTP servers list. |
| 239 | 239 |
~~~~ |
| 240 |
-pmd-cli net ntp_servers --set --servers <server1,server2,...> |
|
| 240 |
+pmd-cli net ntp_servers --set --servers <server1,server2,...> |
|
| 241 | 241 |
~~~~ |
| 242 | 242 |
Add the specified server to the NTP servers list. |
| 243 | 243 |
~~~~ |
| 244 |
-pmd-cli net ntp_servers --add --servers <server> |
|
| 244 |
+pmd-cli net ntp_servers --add --servers <server> |
|
| 245 | 245 |
~~~~ |
| 246 | 246 |
Delete the specified server from the NTP servers list. |
| 247 | 247 |
~~~~ |
| 248 |
-pmd-cli net ntp_servers --del --servers <server> |
|
| 248 |
+pmd-cli net ntp_servers --del --servers <server> |
|
| 249 | 249 |
~~~~ |
| 250 | 250 |
## net hostname |
| 251 | 251 |
|
| ... | ... |
@@ -255,13 +255,13 @@ pmd-cli net hostname --get |
| 255 | 255 |
~~~~ |
| 256 | 256 |
Set the system hostname. |
| 257 | 257 |
~~~~ |
| 258 |
-pmd-cli net hostname --set --name <hostname> |
|
| 258 |
+pmd-cli net hostname --set --name <hostname> |
|
| 259 | 259 |
~~~~ |
| 260 | 260 |
## net wait_for_link |
| 261 | 261 |
|
| 262 | 262 |
Wait for the specified network interface to be up and usable (it can send and receive packets). |
| 263 | 263 |
~~~~ |
| 264 |
-pmd-cli net wait_for_link --interface <ifname> --timeout <timeout> |
|
| 264 |
+pmd-cli net wait_for_link --interface <ifname> --timeout <timeout> |
|
| 265 | 265 |
~~~~ |
| 266 | 266 |
The timeout (in seconds) specifies the maximum time to wait. Specify 0 for no timeout (wait indefinitely). |
| 267 | 267 |
|
| ... | ... |
@@ -271,7 +271,7 @@ The timeout (in seconds) specifies the maximum time to wait. Specify 0 for no ti |
| 271 | 271 |
|
| 272 | 272 |
Wait for the specified interface to acquire a valid IP address for the specified address type. |
| 273 | 273 |
~~~~ |
| 274 |
-pmd-cli net wait_for_ip --interface <ifname> --timeout <timeout> --addrtype <ipv4,ipv6,static_ipv4,static_ipv6,dhcp_ipv4,dhcp_ipv6,auto_ipv6,link_local_ipv6> |
|
| 274 |
+pmd-cli net wait_for_ip --interface <ifname> --timeout <timeout> --addrtype <ipv4,ipv6,static_ipv4,static_ipv6,dhcp_ipv4,dhcp_ipv6,auto_ipv6,link_local_ipv6> |
|
| 275 | 275 |
~~~~ |
| 276 | 276 |
The timeout (in seconds) specifies the maximum time to wait. Specify 0 for no timeout (wait indefinitely). |
| 277 | 277 |
|
| ... | ... |
@@ -279,7 +279,7 @@ The timeout (in seconds) specifies the maximum time to wait. Specify 0 for no ti |
| 279 | 279 |
|
| 280 | 280 |
Get error information about the specified error code. |
| 281 | 281 |
~~~~ |
| 282 |
-pmd-cli net error_info --errcode <error_code> |
|
| 282 |
+pmd-cli net error_info --errcode <error_code> |
|
| 283 | 283 |
~~~~ |
| 284 | 284 |
Here is a list of error codes: |
| 285 | 285 |
|
| ... | ... |
@@ -299,13 +299,13 @@ Here is a list of error codes: |
| 299 | 299 |
|
| 300 | 300 |
Get the specified network configuration parameter for the specified object. |
| 301 | 301 |
~~~~ |
| 302 |
-pmd-cli net net_info --get --object <ifname or filename> --paramname <param_name> |
|
| 302 |
+pmd-cli net net_info --get --object <ifname or filename> --paramname <param_name> |
|
| 303 | 303 |
~~~~ |
| 304 | 304 |
**Note:** The object can be an interface name (for example, "eth0") or a file name (for example, /etc/systemd/resolved.conf). |
| 305 | 305 |
|
| 306 | 306 |
Set the value of the specified network configuration parameter for the specified object (interface or file). |
| 307 | 307 |
~~~~ |
| 308 |
-pmd-cli net net_info --set --object <ifname or filename> --paramname <param_name> --paramvalue <param_value> |
|
| 308 |
+pmd-cli net net_info --set --object <ifname or filename> --paramname <param_name> --paramvalue <param_value> |
|
| 309 | 309 |
~~~~ |
| 310 | 310 |
**Note** : You can add (+) or remove (-) a parameter by prepending the parameter name with + or -. |
| 311 | 311 |
|
| ... | ... |
@@ -315,11 +315,11 @@ The Photon Management Daemon provides CLI commands to help you manage packages a |
| 315 | 315 |
|
| 316 | 316 |
## Syntax |
| 317 | 317 |
~~~~ |
| 318 |
-pmd-cli [connection options] pkg <command> [command options] |
|
| 318 |
+pmd-cli [connection options] pkg <command> [command options] |
|
| 319 | 319 |
~~~~ |
| 320 | 320 |
If a command allows for multiple package names, simply specify on the command line, separated by spaces. |
| 321 | 321 |
~~~~ |
| 322 |
-pmd-cli pkg info <package_name_1> <package_name_2> <package_name_3> ... |
|
| 322 |
+pmd-cli pkg info <package_name_1> <package_name_2> <package_name_3> ... |
|
| 323 | 323 |
~~~~ |
| 324 | 324 |
## pkg help |
| 325 | 325 |
|
| ... | ... |
@@ -343,19 +343,19 @@ pmd-cli pkg distro-sync |
| 343 | 343 |
|
| 344 | 344 |
Downgrade the specified package(s). If no packages are specified, then all available packages are downgraded. |
| 345 | 345 |
~~~~ |
| 346 |
-pmd-cli pkg downgrade <package_name> |
|
| 346 |
+pmd-cli pkg downgrade <package_name> |
|
| 347 | 347 |
~~~~ |
| 348 | 348 |
## pkg erase |
| 349 | 349 |
|
| 350 | 350 |
Remove the specified package(s). |
| 351 | 351 |
~~~~ |
| 352 |
-pmd-cli pkg erase <package_name> |
|
| 352 |
+pmd-cli pkg erase <package_name> |
|
| 353 | 353 |
~~~~ |
| 354 | 354 |
## pkg info |
| 355 | 355 |
|
| 356 | 356 |
Get general information about the specified package(s), such as name, version, release, repository, install size, and so on. |
| 357 | 357 |
~~~~ |
| 358 |
-pmd-cli pkg info <package_name> |
|
| 358 |
+pmd-cli pkg info <package_name> |
|
| 359 | 359 |
~~~~ |
| 360 | 360 |
If no packages are specified, then this command returns information about all packages. |
| 361 | 361 |
~~~~ |
| ... | ... |
@@ -363,7 +363,7 @@ If no packages are specified, then this command returns information about all pa |
| 363 | 363 |
~~~~ |
| 364 | 364 |
Install the specified package(s). Update the package if an update is available. |
| 365 | 365 |
~~~~ |
| 366 |
-pmd-cli pkg install <package_name> |
|
| 366 |
+pmd-cli pkg install <package_name> |
|
| 367 | 367 |
~~~~ |
| 368 | 368 |
## pkg list |
| 369 | 369 |
|
| ... | ... |
@@ -383,7 +383,7 @@ pmd-cli pkg list ph\* |
| 383 | 383 |
|
| 384 | 384 |
Reinstall the specified package(s). |
| 385 | 385 |
~~~~ |
| 386 |
-pmd-cli pkg reinstall <package_name> |
|
| 386 |
+pmd-cli pkg reinstall <package_name> |
|
| 387 | 387 |
~~~~ |
| 388 | 388 |
## pkg repolist |
| 389 | 389 |
|
| ... | ... |
@@ -397,7 +397,7 @@ This command returns a list of the configured software repositories, including t |
| 397 | 397 |
|
| 398 | 398 |
Update the specified package(s). |
| 399 | 399 |
~~~~ |
| 400 |
-pmd-cli pkg update <package_name> |
|
| 400 |
+pmd-cli pkg update <package_name> |
|
| 401 | 401 |
~~~~ |
| 402 | 402 |
If no parameters are specified, then all available packages are updated. |
| 403 | 403 |
|
| ... | ... |
@@ -413,7 +413,7 @@ The Photon Management Daemon provides CLI commands to help you manage users and |
| 413 | 413 |
|
| 414 | 414 |
## Syntax |
| 415 | 415 |
~~~~ |
| 416 |
-pmd-cli [connection options] usr <command> [command options] |
|
| 416 |
+pmd-cli [connection options] usr <command> [command options] |
|
| 417 | 417 |
~~~~ |
| 418 | 418 |
## usr help |
| 419 | 419 |
|
| ... | ... |
@@ -431,7 +431,7 @@ pmd-cli usr users |
| 431 | 431 |
|
| 432 | 432 |
Add a new user. Specify the username. |
| 433 | 433 |
~~~~ |
| 434 |
-pmd-cli usr useradd <username> |
|
| 434 |
+pmd-cli usr useradd <username> |
|
| 435 | 435 |
~~~~ |
| 436 | 436 |
The system assigns a user ID, home directory, and default shell to the new user. The user group is unspecified. |
| 437 | 437 |
|
| ... | ... |
@@ -439,13 +439,13 @@ The system assigns a user ID, home directory, and default shell to the new user. |
| 439 | 439 |
|
| 440 | 440 |
Delete the specified user. |
| 441 | 441 |
~~~~ |
| 442 |
-pmd-cli usr userdel <username> |
|
| 442 |
+pmd-cli usr userdel <username> |
|
| 443 | 443 |
~~~~ |
| 444 | 444 |
## usr userid |
| 445 | 445 |
|
| 446 | 446 |
Get the user ID of the specified user (by name). Used to determine whether the specified user exists. |
| 447 | 447 |
~~~~ |
| 448 |
-pmd-cli usr userid <username> |
|
| 448 |
+pmd-cli usr userid <username> |
|
| 449 | 449 |
~~~~ |
| 450 | 450 |
## usr groups |
| 451 | 451 |
|
| ... | ... |
@@ -457,7 +457,7 @@ pmd-cli usr groups |
| 457 | 457 |
|
| 458 | 458 |
Add a new user group. |
| 459 | 459 |
~~~~ |
| 460 |
-pmd-cli usr groupadd <user_group_name> |
|
| 460 |
+pmd-cli usr groupadd <user_group_name> |
|
| 461 | 461 |
~~~~ |
| 462 | 462 |
The system assigns a group ID to the new user group. |
| 463 | 463 |
|
| ... | ... |
@@ -465,13 +465,13 @@ The system assigns a group ID to the new user group. |
| 465 | 465 |
|
| 466 | 466 |
Delete the specified user group. |
| 467 | 467 |
~~~~ |
| 468 |
-pmd-cli usr groupdel <user_group_name> |
|
| 468 |
+pmd-cli usr groupdel <user_group_name> |
|
| 469 | 469 |
~~~~ |
| 470 | 470 |
## usr groupid |
| 471 | 471 |
|
| 472 | 472 |
Get the group ID for the specified user group (by name). Used to determine whether the specified user group exists. |
| 473 | 473 |
~~~~ |
| 474 |
-pmd-cli usr groupid <user_group_name> |
|
| 474 |
+pmd-cli usr groupid <user_group_name> |
|
| 475 | 475 |
~~~~ |
| 476 | 476 |
## usr version |
| 477 | 477 |
|