Ipv6If Object

Description:

IPv6 interface object.

Writable Attributes
Read-Only Attributes

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

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.
ExternalInterfaceSource (ExternalInterface)	Ipv6SrhIf, Srv6TunnelingParams
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).

Ipv6If Writable Attributes

Attribute

Description

Common Writable Attributes

Active, Name

Address

IPv6 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: ipv6

Default: 2000::2

AddrList

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

Type: ipv6

Default: 0

AddrRepeatCount

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

Type: u32

Default: 0

AddrResolver

IPv6 address resolver identifier.

Type: string

Default: default

AddrStep

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

Type: ipv6

Default: 0000::1

AddrStepMask

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

Type: ipv6

Default: FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF

AllocateEui64LinkLocalAddress

Automatically assign EUI-64 link local address.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	True.
FALSE	False.

EnableGatewayLearning

Whether to enable IPv6 learning for the gateway IP and MAC addresses. Learning begins when the ARP/ND command is issued. If the learned value is not the same as the configured IPv6 gateway address, the learned value is used instead.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable gateway learning.
FALSE	Disable gateway learning.

ExtensionHeader

Extension header type in the IPv6 packet

Type: enum

Default: NONE

Possible Values:

Value	Description
NONE	No extension header
HOP_BY_HOP	Hop-by-Hop options header
DESTINATION	Destination options header
ROUTING	Routing header
FRAGMENT	Fragment header
AUTHENTICATION	Authentication header
ENCAP_SECURITY	Encapsulating security payload header

FlowLabel

Flow label.

Type: u32

Default: 7

Range: 0 - 1048575

Gateway

IPv6 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: ipv6

Default: ::0

GatewayList

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

Type: ipv6

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

Gateway recycle count.

Type: u32

Default: 0

GatewayRepeatCount

Gateway repeat count.

Type: u32

Default: 0

GatewayStep

Gateway step.

Type: ipv6

Default: 0000::0000

HopLimit

Hop limit.

Type: u8

Default: 255

Range: 0 - 255

IfCountPerLowerIf

Number of interfaces in this interface object.

Type: u32

Default: 1

IfRecycleCount

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

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. The beginning address attributes are Address and Gateway.

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.

LastEntry

The index of the last element of the segment list

Type: u8

Default: 0

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

IPv6 address prefix length.

Type: u8

Default: 64

Range: 0 - 128

ResolveGatewayMac

Whether to resolve gateway MAC address.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Resolve gateway MAC address.
FALSE	Do not resolve gateway MAC address.

SegmentList

List of IPv6 addresses representing the segments of a path

Type: ipv6

Default: 0

SegmentsLeft

The index of the next segment in the segment list to inspect

Type: u8

Default: 0

TrafficClass

Traffic class.

Type: u8

Default: 0

Range: 0 - 255

UseIpAddrRangeSettingsForGateway

Use Ip address range settings for gateway.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	True.
FALSE	False.

UsePortDefaultIpv6Gateway

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

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Use default IPv6 gateway.
FALSE	Do not use default IPv6 gateway.

Ipv6If Read-Only Attributes

Read-Only Attribute

Description

AddrResolveState

IPv6 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

Gateway IP learning resolution state.

Type: enum

Default: RESOLVE_DONE

Possible Values:

Value	Description
RESOLVE_DONE	Resolved.
RESOLVE_IN_PROGRESS	Resolve in progress.
RETRYING_GATEWAY	Retrying to resolved gateway.
RESOLVE_NEEDED	Resolved needed.
RESOLVE_FAILED	Failed to resolve gateway.
FAILURE	Resolve failed.
SUCCESS	Resolved.

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.