interfaceEntry

interfaceEntry - configure an interface associated with a port

SYNOPSIS

interfaceEntry sub-command options

DESCRIPTION

The interfaceEntry command is used to configure a single interface associated with a port. Interface entries hold one or more IPv4 or IPv6 addresses. Data from this command must be added to the interface table using the interfaceTable command.

STANDARD OPTIONS
atmEncapsulation

For ATM type load modules, this is the type of ATM encapsulation that is used on the interface.

Option

Value

Usage

atmEncapsulationVccMuxIPV4Routed

101

 

atmEncapsulationVccMuxBridgedEthernetFCS

102

 

atmEncapsulationVccMuxBridgedEthernetNoFCS

103

 

atmEncapsulationVccMuxIPV6Routed

104

 

atmEncapsulationVccMuxMPLSRouted

105

 

atmEncapsulationLLCRoutedCLIP

106

 

atmEncapsulationLLCBridgedEthernetFCS

107

(default)

atmEncapsulationLLCBridgedEthernetNoFCS

108

 

atmEncapsulationLLCPPPoA

109

 

atmEncapsulationVccMuxPPPoA

110

 

atmVci

For ATM type cards, the VCI associated with the interface. (default = 0)

atmVpi

For ATM type cards, the VPI associated with the interface. (default = 0)

connectedVia

If interfaceType is set to interfaceTypeRouted, then this is the description of the interface that this internal interface is made available through. (default = "")

description

An optional description for the interface. This may be used to later access a particular interface by name in the interfaceTable command. (default = "")

enable true | false

Enables the use of this interface entry. (default = false)

enableDcbx true | false

Enables the use of DCBX negotiation on this interface entry. (default = false)

See enableLldp, below.

enableDhcp true | false

Enables the use of DHCP negotiation on this interface entry. If this option is true, then no address items may be added to this interface entry. Any existing IPv4 addresses are deleted. (default = false)

enableDhcpV6 true | false

Enables the use of DHCPv6 negotiation on this interface entry. If this option is true, then no address items may be added to this interface entry. Any existing IPv4 addresses are deleted. (default = false)

enableFlogi true | false

Enable Fabric login (for FCoE protocol). (default = false)

enableGreChecksum true | false

If interfaceType is interfaceTypeGre, this enables the presence of the optional Checksum and Reserved1 fields of the GRE header. The Checksum is set to a correct value and theReserved1 field is set to 0. (default = 0.0.0.0)

enableGreKey

true | false

If true, the Key field is included in outgoing packets using the value in the greOutKey field. (default = false)

enableGreSequence true | false

If true, the Sequence Number field is included in outgoing packets. (default = false)

enableLldp true | false

Enables the use of LLDP Tx and Rx negotiation on this interface entry. (default = false)

Note: Since DCBX is an acknowledged protocol which uses LLDP, for the protocol to operate correctly, both LLDP Rx and Tx are enabled on the interface on which DCBX runs.

enablePtp true | false

Enables the use of PTP on this interface. When set to true, the PTP configuration is stored in the ptpProperties command. (default = false)

enableVlan true | false

Enables the use of the VLAN on this interface. (default = false)

eui64Id

The EUI-64 ID associated with POS boards with IPv6 support. (default = {00 00 00 FF FE 00 00 00})

greDestIpAddress

If interfaceType is interfaceTypeGre, this is the destination IP address to be set in the GRE header. (default = 0.0.0.0)

greInKey

If interfaceType is interfaceTypeGre, this is the key used to match incoming packets. (default = 0)

greOutKey

If interfaceType is interfaceTypeGreand enableGreKey is set to true, this is the key inserted in outgoing packets. (default = 0)

greSourceIpAddress

If interfaceType is interfaceTypeGre, this is the source IP address to be set in the GRE header. (default = 0.0.0.0)

interfaceType

The type of interface being defined.

Option

Value

Usage

interfaceTypeConnected

0

(default) A standard, connected interface

interfaceTypeGre

4

A GRE internal interface. The connected-Via option must be set to the name of an interface of type interfaceTypeConnected.

interfaceTypeRouted

5

An internal, unconnected interface. The connectedVia option must have the name of a connected interface that this interface is routed through.

interfaceTypeNpiv

6

An NPIV type interface.

interfaceTypePtp

7

A PTP type interface. (Note: When enablePTP is set 'true' in the interfaceEntry command, the PTP configuration is stored in the ptpProperties command.)

ipv6Gateway

There can be one gateway per IPv6 interface (default = '0:0:0:0:0:0:0:0'

macAddress

The MAC address of the interface. (default = "00 00 00 00 00 00")

mtu

Sets the Maximum Transmission Unit size, in kilobytes. The range possible depends on the port type. (default =1500)

vcatCircuit

Sets the circuit ID for an IxRouter interface. (default = "")

vlanId

If enableVlan is true, the routing protocols are VLAN encapsulated with this ID. Although a value of `0' is allowed, VLAN IDs normally start at 1. (default = 0)

vlanPriority

If enableVlan is true, the user priority of the VLAN ID tag (from 0 to 7). (default = 0)

vlanTPID

If enableVlan is true, the VLAN Tag Protocol ID. EtherTypes identify the protocol that follows the VLAN header. (default = 0x8100)

DEPRECATED OPTIONS
atmMode

The encapsulation associated with the atmHeader is used instead.

COMMANDS

The interfaceEntry command is invoked with the following sub-commands. If no sub-command is specified, returns a list of all sub-commands available.

interfaceEntry addItem ipType

Adds an IPv4 or IPv6 address, depending on the value of ipType, which is one of these:

Option

Value

Usage

addressTypeIpV4

17

An IPv4 address is added from the options associated with the interfaceIpV4 command.

addressTypeIpV6

18

An IPv6 address is added from the options associated with the interfaceIpV6 command.

Only one IPv4 address can be associated with an interface at this time.

Specific errors are:

interfaceEntry clearAllItems ipType

Clears all IPv4 and IPv6 addresses of the interface, depending on the value of ipType, which is one of these:

Option

Value

Usage

addressTypeIpV4

17

An IPv4 address is added from the options associated with the interfaceIpV4 command.

addressTypeIpV6

18

An IPv6 address is added from the options associated with the interfaceIpV6 command.

interfaceEntry delItem ipType [ipAddr]

Removes an address of type ipType (see the addItem sub-command above for a description of the items). The address may either be specified with the ipAddr of the entry or the current interface as accessed with getFirstItem, getNextItem and getItem. Separate current list pointers are kept for IPv4 and IPv6 items. Specific errors are:

interfaceEntry getFirstItem ipType

Gets the first address of type ipType (see the addItem sub-command above for a description of the items) from the interface entry. Separate current list pointers are kept for IPv4 and IPv6 items. The data may be accessed with the interfaceIpV4 or interfaceIpV6 command. Specific errors are:

interfaceEntry getItem ipAddress

Gets the IPv4 or IPv6 item from the interface entry which matches the specified ipAddress. The type of entry is figured out from the format of the ipAddress. The data may be accessed with the interfaceIpV4 or interfaceIpV6 command. Specific errors are:

interfaceEntry getNextItem ipType

Gets the next interface entry from the interface table. The data may be accessed with the interfaceEntry command. Specific errors are:

interfaceEntry setDefault

Sets to IxTclHal default values for all configuration options.

EXAMPLES

See examples under interfaceTable.

SEE ALSO

interfaceTable, dhcpV4DiscoveredInfo, dhcpV4Properties, dhcpV4Tlv