ip
ip - configure the IP parameters for a port on a card on a chassis
SYNOPSIS
ip sub-command options
DESCRIPTION
The ip command is used to configure the IP-specific information used when building IP-type packets if the protocol config-name has been set to ip. See RFC 791 for a complete definition of IP header fields. Note that stream get must be called before this command's get sub-command.
The TOS byte in the IP header may be interpreted as TOS or DSCP. The options controlling this choice and DSCP settings are qosMode, dscpMode, dscpValue, classSelector, assuredForwardingClass and assuredForwardingPrecedence.
The source and destination addresses may be set from the result of a PPP negotiation through the use of the enableDestSyncFromPpp and enableSourceSyncFromPpp options. Note that it is necessary to wait until the PPP session has been negotiated before:
- performing a chassis refresh command
- performing a stream get command
- performing an ip get command
- reading the destAddr and sourceAddr values using ip cget
Note that when using ATM ports, different types of ATM encapsulation result in different length headers, as discussed in atmHeader The data portion of the packet normally follows the header, except in the case of the two LLC Bridged Ethernet choices, where 12 octets of MAC address and 2 octets of Ethernet type follow the header. The offsets used in this command is with respect to the beginning of the AAL5 packet and must be adjusted by hand to account for the header.
STANDARD OPTIONS
assuredForwarding
Class
If qosMode is set to ipv4ConfigDscp and dscpMode is set to ipV4DscpAssuredForwarding, then this is the assured forwarding class.
Option |
Value |
Usage |
---|---|---|
ipV4DscpClass1 |
0 |
(default) Class 1 |
ipV4DscpClass2 |
1 |
Class 2 |
ipV4DscpClass3 |
2 |
Class 3 |
ipV4DscpClass4 |
3 |
Class 4 |
ipV4DscpClass5 |
4 |
Class 5 |
ipV4DscpClass6 |
5 |
Class 6 |
ipV4DscpClass7 |
6 |
Class 7 |
assuredForwarding
Precedence
If qosMode is set to ipv4ConfigDscp and dscpMode is set to ipV4DscpAssuredForwarding, then this is the assured forwarding precedence.
Option |
Value |
Usage |
---|---|---|
ipV4DscpPrecedenceLowDrop |
0 |
(default) Low drop rate. |
ipV4DscpPrecedenceMediumDrop |
1 |
Medium drop rate. |
ipV4DscpPrecedenceHighDrop |
2 |
High drop rate. |
checksum
Read-only. Value of the checksum in the valid ip stream. Valid only if the stream set is performed.
classSelector
If qosMode is set to ipv4ConfigDscp and dscpMode is set to ipV4DscpClassSelector, then this holds the class selector value.
Option |
Value |
Usage |
---|---|---|
ipV4DscpClass1 |
0 |
(default) Class 1 |
ipV4DscpClass2 |
1 |
Class 2 |
ipV4DscpClass3 |
2 |
Class 3 |
ipV4DscpClass4 |
3 |
Class 4 |
ipV4DscpClass5 |
4 |
Class 5 |
ipV4DscpClass6 |
5 |
Class 6 |
ipV4DscpClass7 |
6 |
Class 7 |
cost
Part of the Type of Service byte of the IP header datagram (bit 6). Options include:
Option |
Value |
Usage |
---|---|---|
normalCost |
0 |
(default) |
lowCost |
1 |
|
delay
Part of the Type of Service byte of the IP header datagram (bit 3). Options include:
Option |
Value |
Usage |
---|---|---|
normalDelay |
0 |
(default) |
lowDelay |
1 |
|
destClass
Class type associated with the destination IP address of the Ixia port. Options include:
Option |
Value |
Usage |
---|---|---|
classA |
0 |
|
classB |
1 |
|
classC |
2 |
(default) |
classD |
3 |
|
noClass |
4 |
|
destDutIpAddr
IP address of the DUT (device under test) port. This value is stored at the TclHal level. (default = 127.0.0.1)
destIpAddr
Destination IP address of the Ixia port. (default = 127.0.0.1)
destIpAddrMode
Specifies how the destination IP address is incremented or decremented. If destIpAddrRepeatCount is set to 1, this variable has no effect. Possible values include:
Option |
Value |
Usage |
---|---|---|
ipIdle |
0 |
(default) no change to IP address regardless of destIpAddrRepeatCount |
ipIncrHost |
1 |
increment the host portion of the IP address for as many destIpAddrRepeatCount specified |
ipDecrHost |
2 |
decrement the host portion of the IP address for as many destIpAddrRepeatCount specified |
ipContIncrHost |
3 |
Continuously increment the host portion of the IP address for each packet |
ipContDecrHost |
4 |
Continuously decrement the host portion of the IP address for each packet |
ipIncrNetwork |
5 |
increment the network portion of the IP address for as many destIpAddrRepeatCount specified |
ipDecrNetwork |
6 |
increment the network portion of the IP address for as many destIpAddrRepeatCount specified |
ipContIncrNetwork |
7 |
Continuously increment the network portion of the IP address for each packet |
ipContDecrNetwork |
8 |
Continuously decrement the network portion of the IP address for each packet. |
ipRandom |
9 |
Generate random IP addresses |
destIpAddrRepeat
Count
Number of destination IP addresses. If set to 1, destIpAddrMode has no effect (default = 1)
destIpMask
Destination IP subnet mask. (default = 255.0.0.0)
destMacAddr
Destination MAC address, generally the MAC address of the DUT port; this field is modified on receipt of ARP frames. This value is stored at the TclHal level. (default = 00 00 00 00 00 00)
dscpMode
If qosMode is set to ipv4ConfigDscp, then this indicates the particular DSCP mode to be used.
Option |
Value |
Usage |
---|---|---|
ipV4DscpDefault |
0 |
(default) The default mode of best efforts. No other options apply |
ipV4DscpClassSelector |
1 |
Class selector mode. The particular class is set in the classSelector option. |
ipV4DscpAssuredForwarding |
2 |
Assured forwarding. The class is set in the assuredForwardingClass option and the assured forwarding precedence is set in the assuredForwardingPrecedence option. |
ipV4DscpExpeditedForwarding |
3 |
Expedited forwarding. No other options apply. |
ipV4DscpCustom |
4 |
An arbitrary value may be set in the TOS byte, held in dscpValue. |
dscpValue
If qosMode is set to ipv4ConfigDscp and dscpMode is set to ipV4DscpCustom, then this holds the value of the TOS/DSCP byte.
enableDestSyncFrom
Ppp true | false
If true, then the destIpAddr is set from negotiated PPP session. See the note at the head of this command about interaction with the PPP negotiation process. (default = false)
enableHeaderLength Override true | false
If false, then the headerLength field is automatically set, based on the Frame Size set in the Frame Control tab. If true, then the value may be overridden. (default = false)
enableSourceSyncFrom
Ppp true | false
If true, then the sourceIpAddr is set from negotiated PPP session. See the note at the head of this command about interaction with the PPP negotiation process. (default = false)
fragment
If set to true, this field indicates this is a fragmented datagram. Used in conjuction with identifier, fragmentoffset and lastFragment. Options include:
Option |
Value |
Usage |
---|---|---|
may |
0 |
(default) |
dont |
1 |
|
fragmentOffset
This field indicates where in the datagram this fragment belongs. The fragment offset is measured in units of 8 octets (64 bits). This differs from the display in IxExplorer, where the fragment offiset is displayed in terms of bytes. The first fragment has offset zero. (default = 0)
headerLength
Automatically calculated to include the minimum of five 32-bit words plus optional data and padding. (default = 20)
identifier
An identifying value assigned by the sender to aid in assembling the fragments of a datagram. (default = 0)
ipProtocol
The next level protocol used in the data portion of the internet datagram. Possible values include:
Option |
Value |
Usage |
---|---|---|
ipV6HopToHop |
0 |
|
icmp |
1 |
|
igmp |
2 |
|
ggp |
3 |
|
ipv4ProtocolIpV4 |
4 |
|
st |
5 |
|
tcp |
6 |
|
ucl |
7 |
|
egp |
8 |
|
igp |
9 |
|
bbn_rcc_mon |
10 |
|
nvp_ii |
11 |
|
pup |
12 |
|
argus |
13 |
|
emcon |
14 |
|
xnet |
15 |
|
chaos |
16 |
|
udp |
17 |
(default) |
mux |
18 |
|
dcn_meas |
19 |
|
hmp |
20 |
|
prm |
21 |
|
xns_idp |
22 |
|
trunk_1 |
23 |
|
trunk_2 |
24 |
|
leaf_1 |
25 |
|
leaf_2 |
26 |
|
rdp |
27 |
|
irtp |
28 |
|
iso_tp4 |
29 |
|
netblt |
30 |
|
mfe_nsp |
31 |
|
merit_inp |
32 |
|
sep |
33 |
|
ipV4Protocol3pc |
34 |
|
ipV4ProtocolIdpr |
35 |
|
ipV4ProtocolXtp |
36 |
|
ipV4ProtocolDdr |
37 |
|
ipV4ProtocolIdprCmtp |
38 |
|
ipV4ProtocolTpPlusPlus |
39 |
|
ipV4ProtocolIlTransportProtocol |
40 |
|
ipV4ProtocolIpv6 |
41 |
|
ipV4ProtocolSdrp |
42 |
|
ipV4ProtocolSipSr |
43 |
|
ipV4ProtocolSipFrag |
44 |
|
ipV4ProtocolIdrp |
45 |
|
ipV4ProtocolRsvp |
46 |
|
ipV4ProtocolGre |
47 |
|
ipV4ProtocolMhrp |
48 |
|
ipV4ProtocolBna |
49 |
|
ipV4ProtocolSippEsp |
50 |
|
ipV4ProtocolSippAh |
51 |
|
ipV4ProtocolNlsp |
52 |
|
ipV4ProtocolSwipe |
53 |
|
ipV4ProtocolNarp |
54 |
|
ipV4ProtocolMobile |
55 |
|
ipV4ProtocolTlsp |
56 |
|
ipV4ProtocolSkip |
57 |
|
ipV4ProtocolIpv6Icmp |
58 |
|
ipV4ProtocolIpv6NoNext |
59 |
|
ipV4ProtocolIpv6Opts |
60 |
|
ipV4ProtocolHostInternalProtocol |
61 |
|
cftp |
62 |
|
ipV4ProtocolAnyLocalNetwork |
63 |
|
sat_expak |
64 |
|
mit_subnet |
65 |
|
rvd |
66 |
|
ippc |
67 |
|
ipV4ProtocolAnyDistFileSystem |
68 |
|
ipV4ProtocolSatMon |
69 |
|
ipV4ProtocolVisa |
70 |
|
ipcv |
71 |
|
ipV4ProtocolCpnx |
72 |
|
ipV4ProtocolCphb |
73 |
|
ipV4ProtocolWsn |
74 |
|
ipV4ProtocolPvp |
75 |
|
br_sat_mon |
76 |
|
ipV4ProtocolSunNd |
77 |
|
wb_mon |
78 |
|
wb_expak |
79 |
|
ipV4ProtocolIsoIp |
80 |
|
ipV4ProtocolVmtp |
81 |
|
ipV4ProtocolSequreVmtp |
82 |
|
ipV4ProtocolVines |
83 |
|
ipV4ProtocolTtp |
84 |
|
ipV4ProtocolNsfnet |
85 |
|
ipV4ProtocolDgp |
86 |
|
ipV4ProtocolTcf |
87 |
|
ipV4ProtocolEigrp |
88 |
|
ipV4ProtocolOspf |
89 |
|
ipV4ProtocolSpriteRpc |
90 |
|
ipV4ProtocolLarp |
91 |
|
ipV4ProtocolMtp |
92 |
|
ipV4ProtocolAx25 |
93 |
|
ipV4ProtocolIpip |
94 |
|
ipV4ProtocolMicp |
95 |
|
ipV4ProtocolSccSp |
96 |
|
ipV4ProtocolEtherip |
97 |
|
ipV4ProtocolEncap |
98 |
|
ipV4ProtocolAnyPrivateEncrScheme |
99 |
|
ipV4ProtocolGmtp |
100 |
|
ipV4ProtocolIfmp |
101 |
|
ipV4ProtocolPnni |
102 |
|
ipV4ProtocolPim |
103 |
|
ipV4ProtocolAris |
104 |
|
ipV4ProtocolScps |
105 |
|
ipV4ProtocolQnx |
106 |
|
ipV4ProtocolActiveNetwork |
107 |
|
ipV4ProtocolIpComp |
108 |
|
ipV4ProtocolSnp |
109 |
|
ipV4ProtocolCompaqPeer |
110 |
|
ipV4ProtocolIpxInIp |
111 |
|
ipV4ProtocolVrrp |
112 |
|
ipV4ProtocolAnyZeroHop |
113 |
|
ipV4ProtocolL2tp |
115 |
|
ipV4ProtocolDdx |
116 |
|
ipV4ProtocolIatp |
117 |
|
ipV4ProtocolStp |
118 |
|
ipV4ProtocolSrp |
119 |
|
ipV4ProtocolUti |
120 |
|
ipV4ProtocolSmp |
121 |
|
ipV4ProtocolSm |
122 |
|
ipV4ProtocolPtp |
123 |
|
ipV4ProtocolIsis |
124 |
|
ipV4ProtocolFire |
125 |
|
ipV4ProtocolCrtp |
126 |
|
ipV4ProtocolCrudp |
127 |
|
ipV4ProtocolSscopmce |
128 |
|
ipV4ProtocolIplt |
129 |
|
ipV4ProtocolSps |
130 |
|
ipV4ProtocolPipe |
131 |
|
ipV4ProtocolSctp |
132 |
|
ipV4ProtocolFiberChannel |
133 |
|
ipV4ProtocolRsvpE2eIgnore |
134 |
|
ipV4ProtocolMobilityHeader |
135 |
|
ipV4ProtocolUdpLite |
136 |
|
ipV4ProtocolMplsInIp |
137 |
|
lastFragment
Controls whether there are additional fragments used to assemble this datagram. Options include:
Option |
Value |
Usage |
---|---|---|
last |
0 |
(default) |
more |
1 |
|
lengthOverride
true / false
If true, enables changing the total length in the ip header. (default = false)
options
Variable length option field in the IP header datagram. (default = { })
precedence
Part of the Type of Service byte of the IP header datagram. Establishes precedence of delivery. Possible values are:
Option |
Value |
Usage |
---|---|---|
routine |
0x0 |
(default) |
priority |
0x1 |
|
immediate |
0x2 |
|
flash |
0x3 |
|
flashOverride |
0x4 |
|
criticEcp |
0x5 |
|
internetControl |
0x6 |
|
networkControl |
0x7 |
|
qosMode
The manner in which the TOS byte is to be interpreted.
Option |
Value |
Usage |
---|---|---|
ipV4ConfigTos |
0 |
(default) TOS - type of service. |
ipV4ConfigDscp |
1 |
DSCP - DiffSrv. |
reliability
Part of the Type of Service byte of the IP header datagram (bit 5). Options include:
Option |
Value |
Usage |
---|---|---|
normalReliability |
0 |
(default) |
highReliability |
1 |
|
reserved
Part of the Type of Service byte of the IP header datagram (bit 7 - 0/1). (default = 0)
sourceClass
Class type associated with the source IP address. Options include:
Option |
Value |
Usage |
---|---|---|
classA |
0 |
|
classB |
1 |
|
classC |
2 |
(default) |
classD |
3 |
|
noClass |
4 |
|
sourceIpAddr
Source IP address. (default = 127.0.0.1)
Note: If the source address equals a DHCP Protocol Interface entry, then the command - chassis refresh <chassis name> - must be issued before subsequently issuing the get and cget commands in the local Tcl client to ensure an accurate reading.
sourceIpAddrMode
Specifies how the source IP address is incremented or decremented. If sourceIpAddrRepeatCount is set to 1, this variable has no effect. Possible values include:
Option |
Value |
Usage |
---|---|---|
ipIdle |
0 |
(default) no change to IP address regardless of sourceIpAddrRepeatCount |
ipIncrHost |
1 |
increment the network portion of the IP address for as many sourceIpAddrRepeatCount specified |
ipDecrHost |
2 |
decrement the network portion of the IP address for as many sourceIpAddrRepeatCount specified |
ipContIncrHost |
3 |
Continuously increment the network portion of the IP address for each packet |
ipContDecrHost |
4 |
Continuously decrement the network portion of the IP address for each packet |
ipIncrNetwork |
5 |
increment the network portion of the IP address for as many sourceIpAddrRepeatCount specified |
ipDecrNetwork |
6 |
increment the network portion of the IP address for as many sourceIpAddrRepeatCount specified |
ipContIncrNetwork |
7 |
Continuously increment the network portion of the IP address for each packet |
ipContDecrNetwork |
8 |
Continuously decrement the network portion of the IP address for each packet. |
ipRandom |
9 |
Generate random IP addresses |
sourceIpAddrRepeat
Count
Number of source IP addresses. If set to 1, sourceAddrMode has no effect. (default = 1)
sourceIpMask
Source IP subnet mask. (default = 255.0.0.0)
throughput
Part of the Type of Service byte of the IP header datagram (bit 4). Options include:
Option |
Value |
Usage |
---|---|---|
normalThruput |
0 |
(default) |
highThruput |
1 |
|
totalLength
Total Length is the length of the datagram, measured in octets, including internet header and data. (default = 46)
ttl
Time-to-Live, measured in units of seconds. (default = 64)
useValidChecksum valid/invalid/override
If portFeatureTcpIPv4ChecksumOverride = true, then:
Valid: (default) The calculated header checksum is automatically calculated.
Invalid: The calculated header checksum is automatically calculated (with error).
Override: The header checksum can be set to a user-defined, 2-octet value.
COMMANDS
The ip command is invoked with the following sub-commands. If no sub-command is specified, returns a list of all sub-commands available.
ip cget option
Returns the current value of the configuration option given by option. Option may have any of the values accepted by the ip command.
ip config option value
Modify the IP configuration options of the port. If no option is specified, returns a list describing all of the available IP options (see STANDARD OPTIONS) for port.
ip decode capFrame chasID cardID portID
Decodes a captured frame in the capture buffer and updates TclHal. ip cget option command can be used after decoding to get the option data. Specific errors are:
- No connection to a chassis
- Invalid port number
- The captured frame is not a valid IP frame
ip get chasID cardID portID
Gets the current IP configuration of the port with id portID on card cardID, chassis chasID. Note that stream get must be called before this command's get sub-command. Call this command before calling ip cget option value to get the value of the configuration option. Specific errors are:
- No connection to a chassis
- Invalid port number
ip set chasID cardID portID
Sets the IP configuration of the port with id portID on card cardID, chassis chasID by reading the configuration option values set by the ip config option value command. Specific errors are:
- No connection to a chassis
- Invalid port number
- The port is being used by another user
- The configured parameters are not valid for this port
ip setDefault
Sets to IxTclHal default values for all configuration options.
EXAMPLES
See examples under tcp