User Guide
DDOC0108-000-A2
CNS4 CSfC
11 - 23
Command Line Interface
Revision 0.0
11.2.16
ipconfig
Syntax
ipconfig [-h |
--
help |
--
version]
ipconfig [-e device] [-V[ [-S] [-M]
ipconfig [-e device] -D [-c cliented] [-F]
ipconfig [-e device] [-i address] [-n netmask] [-g gateway] [-F]
ipconfig [-e device] [-remove]
Description
The ipconfig command allows for configuration of an IP interface. By default, changes take
effect on the next bootup.
Options
-h, --help.............................. Print help message.
--version ............................. Print program version.
-e, --eth <str> ...................... Ethernet device: eth0, eth1, ..., eth[n]. Default is 'all' when viewing
status (see -V), otherwise eth0.
-i, --ip <str>.......................... Assign static IP address.
-n, --net <str> ...................... Assign static IP netmask. Use '.' to clear.
-g, --gate <str> ................... Assign static gateway address. Use '.' to clear.
-t, --mtu <int>....................... Assing MTU value.
-D, --dhcp ............................ Use DHCP.
-O, --onboot......................... Configure interface to come up on boot.
-Z, --zone............................. Zone to use when enabling ports in firewall. default:public
-F, --force............................. Force reconfiguration without reboot. Note: This will cause
termination of active connections.
-V, --view ............................. View interface status and configuration settings. Default action when
other options absent.
-M, --mac............................. View MAC addresses.
-S......................................... Like -V, but status only.
Example 1.
Status/config display
NOTE
Command 'ipconfig -S' reports only the STS_ETH_# lines as above.
Line Identifier
STS_ETH_# Current status for Ethernet device eth#.
CFG_ETH_#Configuration settings for Ethernet device eth#.
Fields
ink=<lnk>............................. Link speed / link down indicator
ip=<ip> ................................ IP address
nm=<ip> .............................. Subnet mask (netmask)
gw=<ip> .............................. Gateway address
prot=<prot> ......................... Identifies protocol/method of assigning TCP/IP parameters.
zone=<zone> ...................... Zone to use when enabling port in firewall. default:public
onBoot=<y/n>...................... Yes or no response indicating interface is started on boot.
status=<sts>........................ Summary status for the given line.
Enumerated types:
<lnk> Link speed (10, 100, 1000, down)
<ip> ..................................... IPv4 dotted-decimal address (Ex: 10.19.6.6), netmask (Ex:
255.255.255.0), gateway (Ex: 10.19.0.0), or 'NA' for "Not available"
cns>
ipconfig -V
[ipconfig]
STS_ETH_0: link=<lnk> ip=<ip> nm=<ip> gw=<ip> status=<sts>
STS_ETH_1: link=<lnk> ip=<ip> nm=<ip> gw=<ip> status=<sts>
CFG_ETH_0: prot=<prot> ip=<ip> nm=<ip> gw=<ip> zone=<zone> onBoot=<y/n>
status=<sts>
CFG_ETH_1: prot=<prot> ip=<ip> nm=<ip> gw=<ip> zone=<zone> onBoot=<y/n>
status=<sts>
[!ipconfig] <summary>