Class tunnel:Ep (ABSTRACT)

Class ID:3682
Class Label: Connection Endpoint
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-connectivity-l3, admin, fabric-connectivity-l3, tenant-connectivity-l3]
Creatable/Deletable: no (see Container Mos for details)
Possible Semantic Scopes: EPG, Fabric,
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

An abstraction of a tunnel endpoint.

Naming Rules


DN FORMAT: 

                


Diagram

Super Mo: nw:ConnEp,
Sub Mos: tunnel:DEp,


Inheritance
[V] nw:Item Ignore.
 ├
[V] nw:Conn A connection abstraction.
 
 ├
[V] nw:Ep A static endpoint.
 
 
 ├
[V] nw:ConnEp A connection endpoint abstraction.
 
 
 
 ├
[V] tunnel:Ep An abstraction of a tunnel endpoint.
 
 
 
 
 ├
[V] tunnel:DEp A discovered tunnel endpoint.
 
 
 
 
 
 ├
[V] bgp:DTEp  Tunnel endpoints discovered through bgp
 
 
 
 
 
 ├
[V] coop:DTEp  Tunnel endpoints discovered through coop
 
 
 
 
 
 ├
[V] epm:DTEp  Tunnel endpoints discovered through epm
 
 
 
 
 
 ├
[V] isis:DTEp The discovered IP security (IPsec) endpoints. The deployment of IPsec with Internet Key Exchange (IKE) requires the configuration of a crypto map for every peer which identifies the endpoint to which a secure tunnel is to be established.
 
 
 
 
 
 ├
[V] svccopy:DTEp  Tunnel endpoints learnt through svc dest


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: tunnel:Ep
tunnel:EncapT
          scalar:Enum8
encapt  (tunnel:Ep:encapt)
          
tunnel:EpId
          address:Ip
id  (tunnel:Ep:id)
           The routed VLAN interface identifier.
top:NodeRole
          scalar:Enum8
role  (tunnel:Ep:role)
           The remote end point role type.
tunnel:EpT
          scalar:Bitmask16
type  (tunnel:Ep:type)
           The specific type of the routed vlan interface.
Defined in: nw:Ep
naming:Name
          string:Basic
name  (nw:Ep:name)
           Overrides:nw:Conn:name
           The name of the object.
Defined in: mo:TopProps
mo:ModificationChildAction
          scalar:Bitmask32
childAction  (mo:TopProps:childAction)
           Delete or ignore. For internal use only.
reference:BinRef dn  (mo:TopProps:dn)
           A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
reference:BinRN rn  (mo:TopProps:rn)
           Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
mo:ModificationStatus
          scalar:Bitmask32
status  (mo:TopProps:status)
           The upgrade status. This property is for internal use only.
Properties Detail

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction
    Comments:
Delete or ignore. For internal use only.
Constants
deleteAll 16384u deleteAll NO COMMENTS
ignore 4096u ignore NO COMMENTS
deleteNonPresent 8192u deleteNonPresent NO COMMENTS
DEFAULT 0 --- This type is used to





dn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn
    Comments:
A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.



encapt

Type: tunnel:EncapT
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
unknown 0 unknown Unknown
vxlan 1 VXLAN encap vxlan
ivxlan 2 iVXLAN encap ivxlan
nvgre 3 NV-GRE encap nvgre
DEFAULT ivxlan(2) iVXLAN encap ivxlan





id

Type: tunnel:EpId
Primitive Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The routed VLAN interface identifier.



name

Type: naming:Name
Primitive Type: string:Basic

Overrides:nw:Conn:name
Units: null Encrypted: false Access: admin Category: TopLevelRegular
    Comments:
The name of the object.



rn

Type: reference:BinRN

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn
    Comments:
Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.



role

Type: top:NodeRole
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The remote end point role type.
Constants
unsupported 0 unknown NO COMMENTS
controller 1 controller Controller
leaf 2 leaf Leaf
spine 3 spine Spine
vleaf 4 vleaf vLeaf
vip 5 vip VPC IP address
protection-chain 6 protection-chain Protection chain IP
DEFAULT unsupported(0) unknown NO COMMENTS





status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus
    Comments:
The upgrade status. This property is for internal use only.
Constants
created 2u created In a setter method: specifies that an object should be created. An error is returned if the object already exists.
In the return value of a setter method: indicates that an object has been created.
modified 4u modified In a setter method: specifies that an object should be modified
In the return value of a setter method: indicates that an object has been modified.
deleted 8u deleted In a setter method: specifies that an object should be deleted.
In the return value of a setter method: indicates that an object has been deleted.
DEFAULT 0 --- This type controls the life cycle of objects passed in the XML API.

When used in a setter method (such as configConfMo), the ModificationStatus specifies whether an object should be created, modified, deleted or removed.
In the return value of a setter method, the ModificationStatus indicates the actual operation that was performed. For example, the ModificationStatus is set to "created" if the object was created. The ModificationStatus is not set if the object was neither created, modified, deleted or removed.

When invoking a setter method, the ModificationStatus is optional:
If a setter method such as configConfMo is invoked and the ModificationStatus is not set, the system automatically determines if the object should be created or modified.






type

Type: tunnel:EpT
Primitive Type: scalar:Bitmask16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The specific type of the routed vlan interface.
Constants
physical 1 Physical Ep Physical endpoint
virtual 2 Virtual Ep Virtual endpoint
proxy-acast-v4 4 Proxy Anycast IPv4 Ep Proxy anycast v4 tunnel endpoint
proxy-acast-v6 8 Proxy Anycast IPv6 Ep Proxy anycast v6 tunnel endpoint
proxy-acast-mac 16 Proxy Anycast MAC Ep Proxy anycast mac tunnel endpoint
fabric-ext 32 Fabric External Fabric external mode
non-fabric-untrusted 64 Non Fabric Untrusted Node Non Fabric Untrusted nodes
underlay-mcast 128 Underlay Multicast Underlay Muticast Interface used for multicast routing
dci-ucast 256 Remote Pod Dci Unicast Tunnel to remote pod's dci ucast tep
dci-mcast-hrep 512 Remote Site Dci Mcast Tunnel to remote site's dci mcast tep
learn-disabled 1024 Learn Disabled Learn Disabled
rl-wan 2048 Remote Site over WAN Tunnel to remote leaf's tep
non-fabric-golf 4096 Non Fabric Golf Non Fabric Golf
rl-ucast 8192 Remote Leaf Unicast RL ucast
rl-mcast-hrep 16384 Remote Leaf Multicast RL mcast
rl-vpc 32768 Remote Leaf VPC Tunnel to RL VPC peer
DEFAULT physical(1) Physical Ep Physical endpoint