Ipv4If Object


Description:

IPv4 interface object.

Parents: EmulatedDevice, ExternalDevice, ExternalDevicePort, Host, Port, Router, SUT

Children: GroupIf, MplsGeneralizedPwBindInfo, MplsIpv4MultiLayerStaticBindInfo, MplsIpv4PrefixBindInfo, MplsIpv4VpnBindInfo, MplsIpv6MultiLayerStaticBindInfo, MplsIpv6PrefixBindInfo, MplsIpv6VpnBindInfo, MplsRsvpTunnelBindInfo, MplsRsvpTunnelSrcDstBindInfo, MplsSrBindInfo, MplsTpStaticLspBindInfo, MplsTpStaticPseudoWireBindInfo, MplsVcBindInfo, MplsVplsBindInfo, Rfc4814EthIIIfDecorator

Relations:

Side name
(Type)
Relative Description
GroupIf
(AffiliatedGroupIf)

GroupIf

Affiliated group interface.

DstBoundTo
(DstBinding)

PathDescriptor, StreamBlock, TrafficDescriptor

Specifies destination endpoints bound to StreamBlock.

EncapsulationSource
(Encapsulation)

PathDescriptor

Specifies the encapsulation.

NetworkLink
(LinkSrc)

CustomLink, CustomLink, DualStackLiteLink, DualStackLiteLink, EoamLink, EoamLink, EthernetBridgeLink, EthernetBridgeLink, EvpnCeToPeLink, EvpnCeToPeLink, IpForwardingLink, IpForwardingLink, Ipv6RapidDeploymentLink, Ipv6RapidDeploymentLink, ItagServiceLink, ItagServiceLink, L2GreTunnelLink, L2GreTunnelLink, L2tpv3ForwardingLink, L2tpv3ForwardingLink, MplsForwardingLink, MplsForwardingLink, MplsHierarchicalLink, MplsHierarchicalLink, MplsIpv4VpnCeToPeLink, MplsIpv4VpnCeToPeLink, MplsIpv6VpnCeToPeLink, MplsIpv6VpnCeToPeLink, MplsL2VpnPeToPLink, MplsL2VpnPeToPLink, MplsL3VpnPeToPLink, MplsL3VpnPeToPLink, MVpnGreCeToPeLink, MVpnGreCeToPeLink, MVpnGrePeToPLink, MVpnGrePeToPLink, OtvEdgeDeviceLink, OtvEdgeDeviceLink, StationToScompLink, StationToScompLink, VifToVicLink, VifToVicLink, VlanSwitchLink, VlanSwitchLink, VplsBgpCeToPeLink, VplsBgpCeToPeLink, VplsLdpCeToPeLink, VplsLdpCeToPeLink, VsiToStationLink, VsiToStationLink, VxlanGpeLink, VxlanGpeLink, VxlanVmToVtepLink, VxlanVmToVtepLink

Link source.

MemberOfVpn
(MemberOfVpn)

EthernetVpnSiteInfo, VpnIdGroup, VpnSiteInfo6Pe, VpnSiteInfoMplsTpStatic, VpnSiteInfoRfc2547, VpnSiteInfoRfc4659, VpnSiteInfoVplsBgp, VpnSiteInfoVplsLdp

Do not use, to be removed

MulticastExpectedRxPorts
(MulticastExpectedRxPorts)

Port

Traffic sent to this end point is expected to be received as multicast traffic by any of the ports connected through this relation.

OptionallyStackedUnder
(OptionallyStackedOnEndpoint)

Aal5If, Dhcpv4ServerDefaultPoolConfig, Dhcpv4ServerPoolConfig, Dhcpv6ServerAddrPoolConfig, Dhcpv6ServerDefaultAddrPoolConfig, Dhcpv6ServerDefaultPrefixPoolConfig, Dhcpv6ServerPrefixPoolConfig, EthIIIf, FcIf, GreIf, GroupIf, HdlcIf, Ipv4If, Ipv4NetworkBlock, Ipv4VpnMcastNetworkBlock, Ipv6If, Ipv6NetworkBlock, Ipv6SrhIf, Ipv6VpnMcastNetworkBlock, ItagIf, L2tpv2If, L2tpv3If, LispIf, MacBlock, MacsecIf, MplsIf, Pimv4JoinSrc, Pimv4PruneSrc, Pimv6JoinSrc, Pimv6PruneSrc, PppIf, PppoeIf, PppoeServerIpv4PeerPool, PppoxServerIpv4PeerPool, PppoxServerIpv6PeerPool, TrillIf, VbrasIf, VlanBlock, VlanIf, VxlanGpeIf, VxlanIf

Specifies an optionally-selected lower interface in the stack. Selection is controlled by protocol implementations which decide based on other criteria whether they should include the target interface in their stack.

OtvEdgeDeviceConfig
(OtvTopLevelIf)

OtvEdgeDeviceConfig

Otv top level private interface.

PrimaryIfSource
(PrimaryIf)

EmulatedDevice, ExternalDevice, ExternalDevicePort, Host, Port, Router, SUT

Specifies if a top-level interface is facing the DUT.

RelayBlockConfig
(RelayIf)

Dhcpv4BlockConfig, Dhcpv4BlockConfig

Config to relay agent interface.


(ResolvesInterface)

BgpRouterConfig, IsisRouterConfig, LdpRouterConfig, LispRouterConfig, Ospfv2RouterConfig, Ospfv3RouterConfig, RsvpIngressTunnelParams, RsvpRouterConfig

Use this to link the traffic binding interfaces and traffic binding resolver.

SrcBoundTo
(SrcBinding)

PathDescriptor, StreamBlock, TrafficDescriptor

Specifies the source endpoint bound to StreamBlock.

StackedOn
(StackedOnEndpoint)

Aal5If, Dhcpv4ServerDefaultPoolConfig, Dhcpv4ServerPoolConfig, Dhcpv6ServerAddrPoolConfig, Dhcpv6ServerDefaultAddrPoolConfig, Dhcpv6ServerDefaultPrefixPoolConfig, Dhcpv6ServerPrefixPoolConfig, EthIIIf, FcIf, GreIf, GroupIf, HdlcIf, Ipv4If, Ipv4NetworkBlock, Ipv4VpnMcastNetworkBlock, Ipv6If, Ipv6NetworkBlock, Ipv6SrhIf, Ipv6VpnMcastNetworkBlock, ItagIf, L2tpv2If, L2tpv3If, LispIf, MacBlock, MacsecIf, MplsIf, Pimv4JoinSrc, Pimv4PruneSrc, Pimv6JoinSrc, Pimv6PruneSrc, PppIf, PppoeIf, PppoeServerIpv4PeerPool, PppoxServerIpv4PeerPool, PppoxServerIpv6PeerPool, TrillIf, VbrasIf, VlanBlock, VlanIf, VxlanGpeIf, VxlanIf

Specifies network endpoint stacking.

TopLevelIfSource
(TopLevelIf)

EmulatedDevice, ExternalDevice, ExternalDevicePort, Host, Port, Router, SUT

Specifies the top-level interface in the interface stack.

L2tpv2UdpConfig
(UdpSrcCustomIf)

L2tpv2BlockConfig

Config to Udp source custom interface.

UnicastExpectedRxPorts
(UnicastExpectedRxPorts)

Port

Traffic sent to this end point is expected to be received as unicast traffic by any of the ports connected through this relation.

UsesIfSource
(UsesIf)

AncpAccessNodeConfig, AppPerfClientConfig, AppPerfServerConfig, AutosarTimeSyncConfig, BfdRouterConfig, BridgePortConfig, CifsClientProtocolConfig, CifsServerProtocolConfig, CoapServerConfig, CuspProtocolConfig, Dhcpv4BlockConfig, Dhcpv4ServerConfig, Dhcpv6BlockConfig, Dhcpv6PdBlockConfig, Dhcpv6ServerConfig, Dot1xSupplicantBlockConfig, DpgClientProtocolConfig, DpgServerProtocolConfig, DualStackLiteConfig, EcpriProtocolConfig, EoamNodeConfig, FcEPortConfig, FcFPortConfig, FcHostConfig, FcoeHostConfig, FcoeVePortConfig, FcoeVfPortConfig, FtpClientProtocolConfig, FtpServerProtocolConfig, HttpClientProtocolConfig, HttpServerProtocolConfig, Ieee1588v2ClockConfig, Ieee80211AccessPointConfig, Ieee80211ClientConfig, Ieee8021asClockConfig, IgmpHostConfig, IgmpRouterConfig, IperfClientProtocolConfig, IperfServerProtocolConfig, Ipv6RapidDeploymentConfig, L2tpv2BlockConfig, L2tpv3BlockConfig, LacpPortConfig, LagBfdPortConfig, LinkOamRouterConfig, LispRouterConfig, LldpNodeConfig, LspPingProtocolConfig, MacsecSupplicantBlockConfig, MldHostConfig, MldRouterConfig, MplsTpConfig, MplsTpOamNodeConfig, MsdpProtocolConfig, NetconfClientConfig, NetconfProtocolConfig, NtpClientConfig, OamFlexeClientConfig, OpenflowControllerProtocolConfig, OpflexDeviceConfig, OseSwitchConfig, Ospfv2RouterConfig, Ospfv3RouterConfig, OtvEdgeDeviceConfig, OtvSiteDeviceConfig, OvsdbServerConfig, PacketChannel, PcepProtocolConfig, PimRouterConfig, PppoaClientBlockConfig, PppoaServerBlockConfig, PppoeClientBlockConfig, PppoeServerBlockConfig, PppoL2tpv2ClientBlockConfig, PppoL2tpv2ServerBlockConfig, PppoL2tpv3ClientBlockConfig, PppoL2tpv3ServerBlockConfig, PppProtocolConfig, RawTcpClientProtocolConfig, RawTcpServerProtocolConfig, RipRouterConfig, RoEBlockConfig, SaaDeviceConfig, SipUaProtocolConfig, SrpConfig, Srv6OamProtocolConfig, StorageWorkerConfig, SyncEthDeviceConfig, TrillRbridgeConfig, TwampClientConfig, TwampServerConfig, VdpStationConfig, VicAdapterConfig, VideoClientProtocolConfig, VideoServerProtocolConfig, VifConfig, VsiBlockConfig, VxlanVtepConfig, XmppvJClientConfig

Specifies the interfaces used by the configuration object (configuration object examples: BgpRouterConfig, LdpRouterConfig, and so on).

Ipv4If Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
Address

IPv4 address. You can generate more than one address by using combinations of Address, AddrRepeatCount, AddrStep, AddrStepMask, and IfRecycleCount. If you do that, then Address is the starting address.

To use this attribute, the IsRange attribute must be TRUE.

Type: ip

Default: 192.85.1.3

AddrList

A Tcl list of IPv4 addresses. To use this attribute, the IsRange attribute must be FALSE.

Type: ip

Default: 0

AddrRepeatCount

How many times to repeat the same IPv4 address before incrementing it. See IsRange for more information.

Type: u32

Default: 0

AddrResolver

Address resolver identifier.

Type: string

Default: default

AddrStep

Step value for generated IPv4 addresses. See IsRange for more information.

Type: ip

Default: 0.0.0.1

AddrStepMask

IPv4 address step mask. Indicates which parts of the IPv4 address will change when incremented. See IsRange for more information.

Type: ip

Default: 255.255.255.255

EnableGatewayLearning

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Not used on this object.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable gateway learning.

FALSE

Disable gateway learning.

Gateway

IPv4 gateway address. You can generate more than one address by using combinations of Gateway, GatewayRepeatCount, GatewayStep, and GatewayRecycleCount. If you do that, then Gateway is the starting address.

To use this attribute, the IsRange attribute must be TRUE.

Type: ip

Default: 192.85.1.1

GatewayList

A Tcl list of IPv4 gateway addresses. To use this attribute, the IsRange attribute must be FALSE.

Type: ip

Default: 0

GatewayMac

Gateway MAC address.

Type: mac

Default: 00:00:01:00:00:01

GatewayMacResolver

Gateway MAC address resolver identifier.

Type: string

Default: default

GatewayRecycleCount

How many times to increment the IPv4 gateway address (Gateway attribute) before returning to the starting value.

Type: u32

Default: 0

GatewayRepeatCount

Gateway repeat count.

Type: u32

Default: 0

GatewayStep

Gateway step value.

Type: ip

Default: 0.0.0.0

IfCountPerLowerIf

Number of interfaces in this interface object.

Type: u32

Default: 1

IfRecycleCount

How many times to increment the IPv4 address (Address attribute) before returning to the starting value. See IsRange for more information.

Example: Address = 1.1.1.1, AddrRepeatCount = 0, AddrStep = 0.0.0.1, AddrStepMask = 0.0.0.255, IfRecycleCount = 3. The generated values for Address will be 1.1.1.1, 1.1.1.2, 1.1.1.3, 1.1.1.1, 1.1.1.2, 1.1.1.3, and so on.

Type: u32

Default: 0

IsLoopbackIf

Whether this is a loopback interface.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

This is a loopback interface.

FALSE

This is not a loopback interface.

IsRange

Whether to use a combination of attributes to generate a range of addresses, or to use a list attribute (AddrList or GatewayList) to specify the addresses.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Generate a range of items using a combination of attributes. These attributes are in 2 sets as follows:

Set 1: Address, AddrRepeatCount, AddrStep, AddrStepMask, IfRecycleCount.

Set 2: Gateway, GatewayRepeatCount, GatewayStep, GatewayRecycleCount.

FALSE

Use AddrList and GatewayList to specify the items.

NeedsAuthentication

Whether this interface needs authentication.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

This interface needs authentication.

FALSE

This interface does not need authentication.

PrefixLength

IPv4 address prefix length.

Type: u8

Default: 24

Range: 0 - 32

ResolveGatewayMac

Whether to resolve the gateway MAC address.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Resolve gateway MAC address.

FALSE

Do not resolve gateway MAC address.

SkipReserved

Whether to skip reserved addresses.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Skip reserved addresses.

FALSE

Do not skip reserved addresses.

Tos

IPv4 ToS value.

Type: u8

Default: 192

Range: 0 - 255

TosType

ToS type.

Type: enum

Default: TOS

Possible Values:

Value Description
TOS

ToS.

DIFFSERV

Diffserv.

Ttl

IPv4 TTL value.

Type: u8

Default: 255

Range: 0 - 255

UseIpAddrRangeSettingsForGateway

Use the same settings for Gateway as the IP Address Range parameters

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Use the same settings for Gateway as the IP Address Range parameters

FALSE

Do not use the same settings for Gateway as the IP Address Range parameters

UsePortDefaultIpv4Gateway

Whether to use the logical port's default IPv4 gateway.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Use default IPv4 gateway.

FALSE

Do not use default IPv4 gateway.

Ipv4If Read-Only Attributes

Read-Only Attribute Description
AddrResolveState

IPv4 address resolve state.

Type: enum

Default: RESOLVE_DONE

Possible Values:

Value Description
RESOLVE_DONE

Resolve is done.

RESOLVE_NEEDED

Resolve is needed.

RESOLVE_FAILED

Resolve failed.

RESOLVE_IN_PROGRESS

Resolve is in progress.

RESOLVE_PARTIALLY_DONE

Resolve is partially done.

EffectiveBlockCount

Block count for this interface.

Type: u32

Default: 1

GatewayLearningState

Not used on this object.

Type: enum

Default: RESOLVE_DONE

Possible Values:

Value Description
RESOLVE_DONE

Resolve done.

RESOLVE_IN_PROGRESS

Resolve in progress.

RETRYING_GATEWAY

Retrying gateway.

RESOLVE_NEEDED

Resolve needed.

RESOLVE_FAILED

Resolve failed.

FAILURE

Failure.

SUCCESS

Success.

GatewayMacResolveState

Gateway MAC address resolve state.

Type: enum

Default: RESOLVE_NEEDED

Possible Values:

Value Description
RESOLVE_DONE

Resolve is done.

RESOLVE_NEEDED

Resolve is needed.

RESOLVE_FAILED

Resolve failed.

RESOLVE_IN_PROGRESS

Resolve is in progress.

RESOLVE_PARTIALLY_DONE

Resolve is partially done.

IfState

State of this interface.

Type: enum

Default: DISABLED

Possible Values:

Value Description
READY

Ready.

DISABLED

Disabled.

DELETING

Deleting.

PARTIALLY_READY

Partially ready.