| Overview | Package | Class | Deprecated | Help |
| Properties | |
|---|---|
| administrativeState |
type=equipment.AdministrativeState default=noop |
| bgpAs |
type=long access=read-only default=-1 |
| bgpNextHopList |
type=string access=read-only default= minimum=0 maximum=1024 |
| bgpReachabilityCauseCode |
type=string access=read-only default=BGP State Unknown minimum=0 maximum=64 |
| bgpReachabilityState |
type=dctr.VPortReachabilityStateType access=read-only default=1 |
| confederationNumber |
type=long access=read-only default=-1 |
| containerPointer |
UNUSED in VPI
type=Pointer access=read-only |
| createTime |
type=Date access=read-only |
| dataPathId |
type=string access=read-create default= minimum=0 maximum=32 Mandatory on create |
| dcEventState |
type=dctr.HistEventBitMask access=read-only default=0 |
| defaultFlowDstPort |
Default Flow Application Destination Port.
type=int default=0 minimum=0 maximum=65535 |
| defaultFlowSrcPort |
Default Flow Application Source Port.
type=int default=0 minimum=0 maximum=65535 |
| defaultProtocol |
Default Transport Protocol For a Flow. It can be either TCP or UDP.
type=acl.Protocol default=0 |
| displayedName |
type=string access=read-only default= maximum=252 Displayed(tab/group)=Port Name |
| encapValue |
type=long access=read-only minimum=0 maximum=32 |
| enterprise |
type=string access=read-only default= minimum=0 maximum=64 |
| evpnServiceSitePointer |
type=Pointer access=read-only default= |
| floatingIpAddress |
The value of tmNgDCvPFloatingIPAddr indicates the IP address that
is used as the source IP for all the traffic coming in on this
virtual port and destined for a destination that is not routable
in the VPRN context that this virtual port belongs to.
type=InetAddress access=read-only Displayed(tab/group)=Floating IP Address |
| floatingIpType |
The value of tmNgDCvPFloatingIPType indicates the address type
of tmNgDCvPFloatingIPAddr address.
type=rtr.InetAddressType access=read-only |
| gwPortName |
type=string access=read-create default= minimum=0 maximum=64 Mandatory on create |
| isActive |
type=boolean access=read-only |
| isRedundant |
type=boolean access=read-only Displayed(tab/group)=Redundant Port |
| l2ExportRt |
type=long access=read-only default=-1 |
| l2RouteDistinguisher |
type=long access=read-only default=-1 |
| l2ServiceId |
This is the service ID for the EVPN service.
type=long access=read-only Displayed(tab/group)=VPLS Service Id |
| l3ExportRt |
type=long access=read-only default=-1 |
| l3RouteDistinguisher |
type=long access=read-only default=-1 |
| l3ServiceId |
This is the service ID for the DVRS service.
type=long access=read-only Displayed(tab/group)=VPRN Service Id |
| lastActive |
type=Date access=read-only |
| lastChanged |
type=Date access=read-only |
| lastValidVpAddress |
type=InetAddress access=read-only |
| lastValidVpV6Address |
type=InetAddress access=read-only |
| learnTime |
type=Date access=read-only |
| macAddress |
type=MacAddress access=read-only Displayed(tab/group)=MAC Address |
| mirrorDestIpAddress |
The value of tmnxDCvPMirrorDestIPAddress indicates the IP address of
the mirror destination
type=InetAddress access=read-only Displayed(tab/group)=Destination Address (/Mirroring) |
| mirrorDestIpType |
The value of tmnxDCvPMirrorDestIPAddressType indicates the IP address type
of tmnxDCvPMirrorDestIPAddress address
type=rtr.InetAddressType access=read-only Displayed(tab/group)=Destination Address Type (/Mirroring) |
| mirrorDirection |
The value of tmnxDCvPMirrorDirection indicates the direction for which
Mirroring is enabled for this virtual port.
The value of 'none (0)' indicates mirroring is not enabled on this vport.
The value of 'ingress (1)' indicates ingress traffic is mirrored. The value
Of 'egress (2)' indicated egress traffic is mirrored. The value of 'both (3)'
Indicated that both ingress and egress traffic is mirrored
type=dctr.MirrorDirections access=read-only Displayed(tab/group)=Direction (/Mirroring) |
| mirrorSvcId |
The value of tmnxDCvPMirrorID indicates the service ID associated with
The mirror destination tmnxDCvPMirrorDestIPAddress
type=int access=read-only Displayed(tab/group)=Service ID (/Mirroring) |
| numOfDSCPToFCMapping |
The value of tmnxDCvPQosNumOfDSCP2FcMapping indicates the number of
DSCP mapping entries existing for this virtual port
type=int access=read-only Displayed(tab/group)=DSCP Mapping Count (/QoS) |
| operationalFlags |
Specifies all the conditions that affect the
operating status of this virtual port.
type=dctr.VportOperFlags access=read-only |
| operationalState |
type=equipment.OperationalState access=read-only default=unknown Displayed(tab/group)=Operational State (/Equipment) |
| portId |
type=long access=read-only Displayed(tab/group)=Virtual SAP Port ID (/Virtual SAP) |
| qosRewriteDSCP |
The value of tmnxDCvPQosRewriteInnerFc indicates if the outer tunnel
DSCP bits are to be copied to the original customer's DSCP bits in case
of IP traffic
type=boolean access=read-only Displayed(tab/group)=Rewrite DSCP (/QoS) |
| qosTrusted |
The value of tmnxDCvPQosTrustedFC indicates if the virtual port is
marked trusted. If the value is 'true', the virtual port is implicitly
associated with a trusted ingress network Qos policy and a trusted
egress Qos policy
type=boolean access=read-only Displayed(tab/group)=Trusted (/QoS) |
| resolvedState |
type=boolean access=read-only Displayed(tab/group)=Resolved State |
| resolvedTime |
The value of tmNgDCvPLastChanged indicates the the time when this
Virtual Port's networking information was resolved.
type=Date access=read-only |
| sasEntityName |
type=string access=read-only minimum=0 maximum=252 |
| sasTestSuiteCount |
type=int access=read-only default=0 minimum=0 |
| sharedEvpnSvcId |
The value of tmNgDCvPSharedEvpnSvcID indicates the shared L2
service id that corresponds to the EVPN service the floating IP
belongs to. A value of 0 indicates that the value of the object
tmNgDCvPFloatingIPAddr is 0.0.0.0 .
type=int access=read-only |
| sharedVprnSvcId |
The value of tmNgDCvPSharedVprnSvcID indicates the L3 service id
that corresponds to the VPRN service the floating IP belongs to.
A value of 0 indicates that the value of the object
tmNgDCvPFloatingIPAddr is 0.0.0.0.
type=int access=read-only |
| siteId |
type=string access=read-only minimum=0 maximum=64 Displayed(tab/group)=Site ID (/Equipment) |
| state |
type=equipment.PortState access=read-only default=1 |
| switchType |
type=dctr.VSwitchIndexType access=read-create default=0 |
| vPDomain |
Specifies the 'domain' tag in the XML definition of the virtual machine that
corresponds to the virtual NIC attached to this virtual port.
type=string access=read-only default= minimum=0 maximum=64 Displayed(tab/group)=Domain Name (/Network Domain) |
| vPEgressAclCount |
Number of Egress Security Policy entries associated with this virtual port
type=int access=read-only |
| vPEgressDscp |
The egress DSCP value to be applied for traffic received on this virtual port and egressing
the hypervisor. This value is determined from the forwarding class
mapping as defined in the QoS network policy on the controller.
type=int access=read-only Displayed(tab/group)=Egress DSCP (/QoS) |
| vPEgressFc |
The egress forwarding class value as derived from the forwarding class name as defined in the
QoS network policy on the controller for the traffic received on
this virtual port and egressing the hypervisor.
type=int access=read-only Displayed(tab/group)=Egress FC (/QoS) |
| vPEgressFcStr |
Indicates the egress forwarding class name that corresponds to the forwarding class to be applied
for traffic received on this virtual port and egressing the hypervisor.
type=string access=read-only default= minimum=0 maximum=32 Displayed(tab/group)=Egress FC Name (/QoS) |
| vPEncryptionPGID |
This value indicates the encryption policy group ID.
type=int access=read-only Displayed(tab/group)=Encryption PGID |
| vPIngressAclCount |
Number of Ingress Security Policy entries associated with this virtual port.
type=int access=read-only |
| vPIngressAvgRate |
Indicates the ingress average rate of traffic received in Mbps on this virtual port.
type=long access=read-only units=mbps Displayed(tab/group)=Ingress Average Rate (/Ingress Traffic) |
| vPIngressBumBurstSize |
The value of tmnxDCvPIngressBumPbs indicates peak burst of traffic for
the broadcast, unknown unicast and multicast traffic received on this
virtual port
type=long access=read-only units=kb Displayed(tab/group)=BUM Burst Size (/QoS) |
| vPIngressBumCommittedBurstSize |
The value of tmnxDCvPIngressBumCbs indicates committed burst of traffic for
the broadcast, unknown unicast and multicast traffic received on this
virtual port
type=long access=read-only units=kb Displayed(tab/group)=BUM Committed Burst Size (/QoS) |
| vPIngressBumCommittedRate |
The value of tmnxDCvPIngressBumCir indicates the committed rate of traffic
for the broadcast, unknown unicast and multicast traffic received in
Mbps on this virtual port
type=long access=read-only units=mbps Displayed(tab/group)=BUM Committed Rate (/QoS) |
| vPIngressBumPeakRate |
The value of tmnxDCvPIngressBumPir indicates the peak rate of traffic
for the broadcast, unknown unicast and multicast traffic received in
Mbps on this virtual port
type=long access=read-only units=mbps Displayed(tab/group)=BUM Peak Rate (/QoS) |
| vPIngressBurstSize |
Indicates amount of buffer space available for traffic spikes on this virtual port.
type=long access=read-only units=kbps Displayed(tab/group)=Ingress Burst Size (/QoS) |
| vPIngressCommittedBurstSize |
The value of tmnxDCvPIngressCommittedBurst indicates the ingress committed
burst of traffic received on this virtual port
type=long access=read-only units=kb Displayed(tab/group)=Committed Burst Size (/QoS) |
| vPIngressCommittedRate |
The value of tmnxDCvPIngressCommittedRate indicates the ingress
committed rate of traffic received in Mbps on this virtual port
type=long access=read-only units=mbps Displayed(tab/group)=Committed Rate (/QoS) |
| vPIngressFipBurstSize |
Indicates peak burst of traffic for the floating IP traffic received on this virtual port.
type=long access=read-only units=kb Displayed(tab/group)=FIP Peak Burst Size (/QoS) |
| vPIngressFipCommittedBurstSize |
Indicates committed burst of traffic for the floating IP traffic received on this virtual port.
type=long access=read-only units=kb Displayed(tab/group)=FIP Committed Burst Size (/QoS) |
| vPIngressFipCommittedRate |
Indicates the committed rate of traffic for the floating IP traffic received in Mbps on this virtual port.
type=long access=read-only units=mbps Displayed(tab/group)=FIP Committed Rate (/QoS) |
| vPIngressFipPeakRate |
Indicates the peak rate of traffic for the floating IP received in Mbps on this virtual port.
type=long access=read-only units=mbps Displayed(tab/group)=FIP Peak Rate (/QoS) |
| vPIngressPeakRate |
Indicates the ingress peak rate of traffic received in Mbps on this virtual port.
type=long access=read-only units=mbps Displayed(tab/group)=Ingress Peak Rate (/QoS) |
| vPNetworkName |
Specifies the 'network name' tag in the XML definition of the virtual machine that
corresponds to the virtual NIC attached to this virtual port.
type=string access=read-only default= minimum=0 maximum=64 Displayed(tab/group)=Network Name (/Network Domain) |
| vPNumOfACL |
DEPRECATED: 2.0.0 -- Replace with vPIngressAclCount and vPEgressAclCount type=int access=read-only |
| vPNumOfDHCP |
The number of DHCP options that are associated with this virtual port. These options are passed
to the Virtual Machine as part of the DHCP response sent in response
to the DHCP request from the virtual machine on this vport.
type=int access=read-only |
| vPSubnet |
DEPRECATED: 13.0 R7 - this field is deprecated type=string access=read-only default= minimum=0 maximum=64 |
| vPZone |
Specifies the 'zone' tag in the XML definition of the virtual machine that
corresponds to the virtual NIC attached to this virtual port.
type=string access=read-only default= minimum=0 maximum=64 Displayed(tab/group)=Zone Name (/Network Domain) |
| vPortGroupTag |
type=string access=read-only Displayed(tab/group)=EVPN Community Tag |
| virtualMachinePointer |
UNUSED in VPI
type=Pointer access=read-only |
| virtualSwitchPointer |
UNUSED in VPI
type=Pointer access=read-only Displayed(tab/group)=Virtual Switch |
| vlanId |
type=int access=read-create default=0 |
| vmId |
type=string access=read-only minimum=0 maximum=128 Displayed(tab/group)=UUID |
| vpAddrType |
type=rtr.InetAddressType access=read-only default=1 |
| vpAddress |
type=InetAddress access=read-only Displayed(tab/group)=IP Address |
| vpGateWayAddrType |
type=rtr.InetAddressType access=read-only default=1 |
| vpGateWayAddress |
type=InetAddress access=read-only Displayed(tab/group)=Gateway IP Address |
| vpName |
type=MacAddress access=read-create default=00-00-00-00-00-00 |
| vpPrefixLength |
type=int access=read-only minimum=0 maximum=32 Displayed(tab/group)=IP Netmask |
| vpSapId |
type=string access=read-only minimum=0 maximum=32 Displayed(tab/group)=Virtual SAP ID (/Virtual SAP) |
| vpType |
type=dctr.VPType access=read-only default=0 Displayed(tab/group)=Port Type |
| vpV6AddrType |
type=rtr.InetAddressType access=read-only default=2 |
| vpV6Address |
type=InetAddress access=read-only Displayed(tab/group)=IPV6 Address |
| vpV6GateWayAddrType |
type=rtr.InetAddressType access=read-only default=2 |
| vpV6GateWayAddress |
type=InetAddress access=read-only Displayed(tab/group)=Gateway IPV6 Address |
| vpV6PrefixLength |
type=int access=read-only minimum=0 maximum=64 Displayed(tab/group)=IPV6 Netmask |
| vplsServicePointer |
type=Pointer access=read-only default= |
| vplsVSwitchSitePointer |
type=Pointer access=read-only default= Displayed(tab/group)=VPLS Service |
| vportConfiguredName |
The value of this NFM-P field is the name given to the vport which is
MAC address for a vport of type VM and Vsd Vport name for a gateway port.
type=string access=read-only default= minimum=0 maximum=255 |
| vprnServicePointer |
type=Pointer access=read-only default= |
| vprnServiceSitePointer |
type=Pointer access=read-only default= |
| vprnVSwitchSitePointer |
type=Pointer access=read-only default= Displayed(tab/group)=VPRN Service |
| vsAddrType |
type=rtr.InetAddressType access=read-only default=1 |
| vsAddress |
type=InetAddress access=read-only |
| vsdVportName |
The value of tmNgDCvPVsdVportName specifies a name string assigned
by the Virtualized Services Directory (VSD).
type=string access=read-only minimum=0 maximum=255 |
| vsdVportUuid |
The value of tmNgDCvPVsdVportUUID specifies the 128 bit UUID for this
Virtual Port by the Virtualized Services Directory (VSD).
type=string access=read-only minimum=0 maximum=64 Displayed(tab/group)=VSD VP UUID |
| vswId |
type=long access=read-only |
| Properties inherited from ManagedObject |
|---|
| actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed |
| Methods |
|---|
deployer
: Deployer - the deployment state
synchronousDeploy
: boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure
: boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries
: int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval
: long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription
: string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName
: string - the full name of the object.
srcPort
: int - (Optional) Default Flow Source Protocol
dstPort
: int - (Optional) Default Flow Destination Protocol
transProtocol
: acl.Protocol - (Optional) Default Flow matching the TransPort Protocol
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false| Supported Network Elements | |
|---|---|
| DC VSC | |
| DC 7850 | |
| DC 210 | |
| DC VSA8 | |
| Product Specifics | |
| DC 210 20.5 | |
| DC 210 5.0 | |
| DC 210 6.0 | |
| DC 7850 20.0 | |
| DC 7850 5.0 | |
| DC 7850 6.0 | |
| DC VSA8 5.0 | |
| DC VSA8 6.0 | |
| DC VSC 20.0 | |
| DC VSC 5.0 | |
| DC VSC 6.0 | |