Port Object


Description:

Port.

Parents: Project

Children: Aal5If, AtmPhy, BfdStateSummary, BgpStateSummary, Dhcpv4ServerDefaultPoolConfig, Dhcpv4ServerPoolConfig, Dhcpv6ServerAddrPoolConfig, Dhcpv6ServerDefaultAddrPoolConfig, Dhcpv6ServerDefaultPrefixPoolConfig, Dhcpv6ServerPrefixPoolConfig, Dot1xPortConfig, Ethernet100GigFiber, Ethernet10GigCopper, Ethernet10GigFiber, Ethernet200GigFiber, Ethernet25GigFiber, Ethernet400GigFiber, Ethernet40GigFiber, Ethernet50GigFiber, Ethernet800GigFiber, EthernetCopper, EthernetFiber, EthernetPoECopper, EthIIIf, FcIf, FcPhy, FecModeObject, FlexEthernetClientConfig, FlexEthernetConfig, FlexEthernetPhyConfig, GreIf, GroupIf, HdlcIf, Ieee1588v2StateSummary, Ieee80211Phy, Ieee8021asStateSummary, Ipv4If, Ipv4NetworkBlock, Ipv4VpnMcastNetworkBlock, Ipv6If, Ipv6NetworkBlock, Ipv6SrhIf, Ipv6VpnMcastNetworkBlock, IsisStateSummary, ItagIf, L1ConfigGroup, L2tpv2If, L2tpv3If, LacpPortConfig, LacpStateSummary, LagBfdPortConfig, LdpStateSummary, LispIf, LispStateSummary, LldpStateSummary, LogicIlCore, LspPingStateSummary, MacBlock, MacsecIf, MplsIf, MplsTpStateSummary, NoiseGenerator, Ospfv2StateSummary, Ospfv3StateSummary, PcsErrorInsertionConfig, PfcMeasurementConfig, PimStateSummary, Pimv4JoinSrc, Pimv4PruneSrc, Pimv6JoinSrc, Pimv6PruneSrc, POSPhy, PppIf, PppoeIf, PppoeServerIpv4PeerPool, PppoxServerIpv4PeerPool, PppoxServerIpv6PeerPool, Probe, RadarEmulationConfig, RandomErrorInsertionConfig, RipngStateSummary, Ripv4StateSummary, Rocev2PortConfig, RsvpStateSummary, SrpStateSummary, StpStateSummary, StreamBlock, SyncEthPortConfig, SyncEthStateSummary, TrillIf, TwampStateSummary, VbrasIf, VdpPortConfig, VlanBlock, VlanIf, VqAnalyzerPortGenParams, VxlanGpeIf, VxlanIf

Automatically created from: BfdPortConfig, CoapPortConfig

Automatically-created children: Analyzer, AncpPortConfig, AppPerfPortConfig, ArpCache, ArpNdReport, AutosarTimeSyncPortConfig, BgpPortConfig, Capture, CuspPortConfig, Dhcpv4PortConfig, Dhcpv6PortConfig, EcpriPortConfig, EnhancedL47PortConfig, EoamPortConfig, Generator, Host, Ieee1588v2PortConfig, IgmpPortConfig, L2tpPortConfig, LldpPortConfig, MldPortConfig, OpflexPortConfig, OsePortConfig, OvsdbPortConfig, PingReport, PppoxPortConfig, PppProtocolConfig, QbvStreamConfig, RoEPortConfig, SaaPortConfig, StpPortConfig, SystemResourceManager, VqAnalyzer, VxlanPortConfig

Result children (automatically created): ArpCache, ArpNdReport, ArpNdResults, BfdStateSummary, BgpStateSummary, FcResults, GreIfPortResults, Ieee1588v2StateSummary, Ieee8021asStateSummary, IptvPortResults, IsisStateSummary, LacpStateSummary, LdpStateSummary, LispRouterResults, LispStateSummary, LldpStateSummary, LspPingStateSummary, MplsTpStateSummary, MsdpPortResults, OseControllerAggregateResults, Ospfv2StateSummary, Ospfv3StateSummary, PcepPortResults, PfcResults, PimStateSummary, PingReport, RipngStateSummary, Ripv4StateSummary, RsvpStateSummary, RxPortPairResults, SipPortResults, SonetAlarmsResults, SonetResults, SrpStateSummary, StoragePortResults, StpStateSummary, SyncEthStateSummary, TwampClientResults, TwampPortTestSessionResults, TwampServerResults, TwampStateSummary, TxPortPairResults, XmppvJPortResults

Relations:

Side name
(Type)
Relative Description
ActivePhy
(ActivePhy)

AtmPhy, Ethernet100GigFiber, Ethernet10GigCopper, Ethernet10GigFiber, Ethernet200GigFiber, Ethernet25GigFiber, Ethernet400GigFiber, Ethernet40GigFiber, Ethernet50GigFiber, Ethernet800GigFiber, EthernetCopper, EthernetFiber, EthernetPoECopper, FcPhy, Ieee80211Phy, POSPhy

Identifies the currently active PHY object for this port. Use PortSetupSetActivePhyCommand and PortSetupGetActivePhyCommand instead of manipulating this relation directly.

AffiliatedPortSource
(AffiliationPort)

AccessTestGenPortParams, ConvergenceIpv4EgressPortParams, ConvergenceIpv4IngressPortParams, ConvergenceIpv6EgressPortParams, ConvergenceIpv6IngressPortParams, CpriOverRoeGenPortConfig, EmulatedDevice, EvpnMplsCustPortGenParams, EvpnMplsProviderPortGenParams, FcLeftSidePortParams, FcoeLeftSidePortParams, FcoeRightSidePortParams, FcRightSidePortParams, Host, McastDownstreamPortParams, McastPortParams, McastUpstreamPortParams, MplsLdpCustEdgePortParams, MplsLdpProviderPortParams, MplsRsvpLeftSidePortParams, MplsRsvpRightSidePortParams, OsePortConfigGenParams, PbbGenCustomerPortConfig, PbbGenProviderPortConfig, Rocev2GenPortParams, Rocev2PerfGenRxPortParams, Rocev2PerfGenTxPortParams, Router, RsvpFrrEgressSidePortParams, RsvpFrrIngressSidePortParams, RtgTestGenIpv4PortParams, RtgTestGenIpv6PortParams, SpbLeftSidePortParams, SpbRightSidePortParams, SrTeConvergenceBackupEgressPortParams, SrTeConvergenceIgpPortParams, SrTeConvergenceIngressPortParams, SrTeConvergencePcePortParams, SrTeConvergencePrimaryEgressPortParams, Srv6TiLfaIngressPortParams, Srv6TiLfaPortParams, Srv6TiLfaRepairPortParams, Srv6TiLfaShortestPortParams, Srv6VpnGenIpv4AndIpv6CustPortParams, VdpConfigGenPortParams, VpnBgpVplsGenCustPortParams, VpnEvpnGenCorePortParams, VpnEvpnGenCustPortParams, VpnLdpVplsGenCustPortParams, VpnMartiniGenCustPortParams, VpnMplsTpCustPortGenParams, VpnNextGenMvpnGenCorePortParams, VpnNextGenMvpnGenCustPortParams, VxlanEvpnOverlayBgpRouteReflectorParams, VxlanEvpnOverlayBgpUnderlayParams, VxlanEvpnOverlayGenL2VniHostPortParams, VxlanEvpnOverlayGenL3VniHostPortParams, VxlanEvpnOverlayGenVtepPortParams, VxlanGenHostPortParams, VxlanGenVtepPortParams, VxlanOvsdbHostPortGenParams, VxlanOvsdbVtepPortGenParams

Affiliation port.

ContainerResultChild
(ContainerResult)

RxPortPairResults, TxPortPairResults

General-purpose relation for result objects. For example, RxTrafficGroupResults objects are linked to the StreamBlock object with this relation.

DstBoundTo
(DstBinding)

TrafficDescriptor

Specifies destination endpoints bound to StreamBlock.

ExpectedRxSource
(ExpectedRx)

StreamBlock

Expected Rx port.

GroupSource
(GroupMembership)

PortGroup

Affiliation port group.

MemberOfVpn
(MemberOfVpn)

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

Do not use, to be removed

TrafficDescriptorMonitorPortSrc
(MonitorPortBinding)

TrafficDescriptor

Monitor binding port.

MulticastExpectedRxPortsSource
(MulticastExpectedRxPorts)

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

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

Config
(MulticastMonitorPortBinding)

Rfc3918Config, Rfc3918Config

Multicast monitor port binding.

OpenflowSwitchLinkedPortSource
(OpenflowSwitchLinkedPort)

OpenflowSwitchPortConfig

Openflow switch edge linked port.

PhysicalPort
(PhysicalLogical)

PhysicalPort

Physical port.

PrimaryIf
(PrimaryIf)

Aal5If, EthIIIf, FcIf, GreIf, GroupIf, HdlcIf, Ipv4If, Ipv6If, Ipv6SrhIf, ItagIf, L2tpv2If, L2tpv3If, LispIf, MacsecIf, MplsIf, PppIf, PppoeIf, TrillIf, VbrasIf, VlanIf, VxlanGpeIf, VxlanIf

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

ResultChild
(ResultChild)

ArpCache, ArpNdReport, ArpNdResults, BfdStateSummary, BgpStateSummary, FcResults, GreIfPortResults, Ieee1588v2StateSummary, Ieee8021asStateSummary, IptvPortResults, IsisStateSummary, LacpStateSummary, LdpStateSummary, LispRouterResults, LispStateSummary, LldpStateSummary, LspPingStateSummary, MplsTpStateSummary, MsdpPortResults, OseControllerAggregateResults, Ospfv2StateSummary, Ospfv3StateSummary, PcepPortResults, PfcResults, PimStateSummary, PingReport, RipngStateSummary, Ripv4StateSummary, RsvpStateSummary, RxPortPairResults, SipPortResults, SonetAlarmsResults, SonetResults, SrpStateSummary, StoragePortResults, StpStateSummary, SyncEthStateSummary, TwampClientResults, TwampPortTestSessionResults, TwampServerResults, TwampStateSummary, TxPortPairResults, XmppvJPortResults

Use this to connect a results object to an object.

DeviceGenParams
(SelectedPort)

EmulatedDeviceGenParams, EthernetVpnSiteGenParams, HostGenParams, MultiSegmentLeftSitePortParams, MultiSegmentRightSitePortParams, MvpnGenCorePortParams, MvpnGenCustPortParams, OpenflowFlowGenParams, RouterGenParams, Srv6VpnGenCorePortParams, Srv6VpnGenIpv4AndIpv6CustPortParams, Srv6VpnGenIpv4CustPortParams, Srv6VpnGenIpv6CustPortParams, Vpn6PeGenCorePortParams, Vpn6PeGenCustPortParams, Vpn6PeSiteGenParams, VpnBgpVplsGenCorePortParams, VpnBgpVplsGenCustPortParams, VpnBgpVplsSiteGenParams, VpnEvpnGenCorePortParams, VpnEvpnGenCustPortParams, VpnLdpVplsGenCorePortParams, VpnLdpVplsGenCustPortParams, VpnLdpVplsSiteGenParams, VpnMartiniGenCorePortParams, VpnMartiniGenCustPortParams, VpnMplsTpCorePortGenParams, VpnMplsTpCustPortGenParams, VpnMplsTpStaticSiteGenParams, VpnNextGenMvpnGenCorePortParams, VpnNextGenMvpnGenCustPortParams, VpnRfc2547GenCorePortParams, VpnRfc2547GenCustPortParams, VpnRfc2547SiteGenParams, VpnRfc4659SiteGenParams, VxlanVmGenParams

Port.

SrcBoundTo
(SrcBinding)

TrafficDescriptor

Specifies the source endpoint bound to StreamBlock.

TopLevelIf
(TopLevelIf)

Aal5If, EthIIIf, FcIf, GreIf, GroupIf, HdlcIf, Ipv4If, Ipv6If, Ipv6SrhIf, ItagIf, L2tpv2If, L2tpv3If, LispIf, MacsecIf, MplsIf, PppIf, PppoeIf, TrillIf, VbrasIf, VlanIf, VxlanGpeIf, VxlanIf

Specifies the top-level interface in the interface stack.

UnicastExpectedRxPortsSource
(UnicastExpectedRxPorts)

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

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

Port Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
AppendLocationToPortName

Append location to port name.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

True.

FALSE

False.

Layer3Type

Layer 3 type.

Type: enum

Default: IPV4

Possible Values:

Value Description
IPV4

IPv4.

IPV6

IPv4.

IPV4V6

IPv4-v6

Location

Location of the physical port to bind with.

Type: csp

Default: //(Offline)/1/1

UseDefaultHost

Use default host.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

True.

FALSE

False.

Port Read-Only Attributes

Read-Only Attribute Description
IsFlexEthernetClient

Is current port a Flex-Ethernet Client

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

True, If port is of type.

FALSE

False, If port is not of type.

IsFlexEthernetPhy

Is current port a Flex-Ethernet Phy

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

True, If port is of type

FALSE

False, If port is not of type

IsFlexEthernetPort

Is current port a Flex-Ethernet

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

True, If port is of type

FALSE

False, If port is not of type

IsPgaPort

Is current port a PGA port

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

True, If port is of type

FALSE

False, If port is not of type

LicensedPhys

Type: enum

Default: ETHERNET_COPPER

Possible Values:

Value Description
ETHERNET_COPPER

Copper Ethernet.

ETHERNET_FIBER

Fiber Ethernet.

ETHERNET_10_GIG_FIBER

Fiber 10 gigabit Ethernet.

POS

Packet over SONET.

ETHERNET_10_GIG_COPPER

Copper 10 gigabit Ethernet.

ATM

ATM.

FC

Fiber channel.

ETHERNET_40_GIG_FIBER

Fiber 40 gigabit Ethernet.

ETHERNET_100_GIG_FIBER

Fiber 100 gigabit Ethernet.

IEEE_802_11

IEEE 802.11

ETHERNET_25_GIG_FIBER

Fiber 25 gigabit ethernet.

ETHERNET_50_GIG_FIBER

Fiber 50 gigabit ethernet.

ETHERNET_400_GIG_FIBER

Fiber 400 gigabit ethernet.

ETHERNET_200_GIG_FIBER

Fiber 200 gigabit ethernet.

ETHERNET_POE_COPPER

PoE Copper Ethernet.

FLEXE_5X100_GIG_FIBER

ETHERNET_800_GIG_FIBER

Online

Online status of the port.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Port is online.

FALSE

Port is offline.

PhyMediaType

Phy media type

Type: enum

Default: UNKNOWN

Possible Values:

Value Description
COPPER

Copper

FIBER

Fiber

IEEE802_11

Ieee802.11

UNKNOWN

Unknown

PortGroupSize

Port group size.

Type: u16

Default: 0

SupportedPhys

Supported physical layer interfaces under the port.

Type: enum

Default: ETHERNET_COPPER

Possible Values:

Value Description
ETHERNET_COPPER

Copper Ethernet.

ETHERNET_FIBER

Fiber Ethernet.

ETHERNET_10_GIG_FIBER

Fiber 10 gigabit Ethernet.

POS

Packet over SONET.

ETHERNET_10_GIG_COPPER

Copper 10 gigabit Ethernet.

ATM

ATM.

FC

Fiber channel.

ETHERNET_40_GIG_FIBER

Fiber 40 gigabit Ethernet.

ETHERNET_100_GIG_FIBER

Fiber 100 gigabit Ethernet.

IEEE_802_11

IEEE 802.11

ETHERNET_25_GIG_FIBER

Fiber 25 gigabit ethernet.

ETHERNET_50_GIG_FIBER

Fiber 50 gigabit ethernet.

ETHERNET_400_GIG_FIBER

Fiber 400 gigabit ethernet.

ETHERNET_200_GIG_FIBER

Fiber 200 gigabit ethernet.

ETHERNET_POE_COPPER

PoE Copper Ethernet.

FLEXE_5X100_GIG_FIBER

ETHERNET_800_GIG_FIBER

TestModuleProfile

Test module profile.

Type: string

Default: "" (empty string)