Class hctunn:If (CONCRETE)

Class ID:15009
Class Label: Tunnel Interface
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Logical Model - APIC NX Processing: Enabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-connectivity, access-protocol, admin, fabric-connectivity, fabric-protocol, tenant-connectivity, tenant-ext-connectivity, tenant-ext-protocol, tenant-protocol, vmm-policy]
Creatable/Deletable: no (see Container Mos for details)
Semantic Scope: None
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: false, HasHealth: true, HasEventRules: false ]

NO COMMENTS

Naming Rules
RN FORMAT: tunn-{id}

    [1] PREFIX=tunn- PROPERTY = id




DN FORMAT: 

[0] cprov-{vendor}/provacc-{[name]}/acct-{[name]}/region-{[regionName]}/context-{[name]}-addr-{[primaryCidr]}/csr-{[name]}/tunn-{id}

[1] acct-{[name]}/region-{[regionName]}/context-{[name]}-addr-{[primaryCidr]}/csr-{[name]}/tunn-{id}

                


Diagram

Super Mo: nw:ConnEp,
Container Mos: hcloud:Csr (deletable:no),
Contained Mos: hctunn:IfOper, hctunn:TunnelIfStats,
Relations From: hcbgp:Peer, comp:Hv, hcospf:Dom,
Relations To: hcisakmp:Ikev2Profile, hcipsec:Profile, hcisakmp:Profile, hcl1:PhysicalIf,
Relations: hctunn:RsIkev2Profile, hctunn:RsIpsecProfile, hctunn:RsIsakmpProfile, hctunn:RsSourceIf, hctunn:RtBgpPeerTohctunnIf, hctunn:RtOverlayTunnel, hctunn:RtTunnIf,


Containers Hierarchies
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] hcloud:Prov  MOs Cloud Provider
 
 ├
[V] hcloud:ProvAccount  Cloud Provider Account
 
 
 ├
[V] hcloud:Account  Represents a cloud tenant, i.e. both owner and container of cloud resources. It maps 1:1 to fvTenant. Which means that for each fvTenant an hcloudAccount must be created. Depending on the cloud provider it implies different things, as detailed as follows. AWS: hcloudAccount stores cloud account's credentials or just the accoun...
 
 
 
 ├
[V] hcloud:Region  Represents a cloud region managed by CAPIC. Cloud resources will not be deployed in unmanaged regions.
 
 
 
 
 ├
[V] hcloud:Ctx 
 
 
 
 
 
 ├
[V] hcloud:Csr 
 
 
 
 
 
 
 ├
[V] hctunn:If 
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] hcloud:Account  Represents a cloud tenant, i.e. both owner and container of cloud resources. It maps 1:1 to fvTenant. Which means that for each fvTenant an hcloudAccount must be created. Depending on the cloud provider it implies different things, as detailed as follows. AWS: hcloudAccount stores cloud account's credentials or just the accoun...
 
 ├
[V] hcloud:Region  Represents a cloud region managed by CAPIC. Cloud resources will not be deployed in unmanaged regions.
 
 
 ├
[V] hcloud:Ctx 
 
 
 
 ├
[V] hcloud:Csr 
 
 
 
 
 ├
[V] hctunn:If 


Contained Hierarchy
[V] hctunn:If 
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 ├
[V] hctunn:IfOper 
 
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 ├
[V] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 
 
 ├
[V] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 
 ├
[V] tag:Annotation 
 
 
 ├
[V] tag:Tag 
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] hctunn:RsIkev2Profile 
 ├
[V] hctunn:RsIpsecProfile  IPSec Profile
 ├
[V] hctunn:RsIsakmpProfile  Isakmp Profile
 ├
[V] hctunn:RsSourceIf  Tunnel Source Interface
 ├
[V] hctunn:RtBgpPeerTohctunnIf 
 ├
[V] hctunn:RtOverlayTunnel 
 ├
[V] hctunn:RtTunnIf  associated Tunnel If
 ├
[V] hctunn:TunnelIfStats 
 
 ├
[V] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 ├
[V] tag:Annotation 
 
 ├
[V] tag:Tag 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)


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] hctunn:If 


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: hctunn:If
address:Ip addr  (hctunn:If:addr)
           The peer IP address.
hctunn:AdminSt
          scalar:Enum8
adminSt  (hctunn:If:adminSt)
           The administrative state of the object or policy.
address:Ip dest  (hctunn:If:dest)
           The ERSPAN destination of the span session setup on the vCenter.
scalar:Sint64 id  (hctunn:If:id)
           An object identifier.
hctunn:KeepAlvIntvl
          scalar:Uint32
keepAlvIntvl  (hctunn:If:keepAlvIntvl)
           Tunnel keep-alive period
reference:BinRef logicalDn  (hctunn:If:logicalDn)
           Logical Model Mo's DN
address:MAC mac  (hctunn:If:mac)
           The MAC address.
hctunn:Mss
          scalar:Uint32
mss  (hctunn:If:mss)
           Maximum Segment Size
hctunn:ConfMtu
          scalar:Uint32
mtu  (hctunn:If:mtu)
           The administrative MTU port on the aggregated interface.
address:Ip src  (hctunn:If:src)
           The source IP address.
hctunn:TunnelQual
          scalar:Enum8
tType  (hctunn:If:tType)
           The type of target.
string:Basic targetRegion  (hctunn:If:targetRegion)
           Tunnel's Target Region
hctunn:TunnelDestinationType
          scalar:Enum64
tunnelDestinationType  (hctunn:If:tunnelDestinationType)
           Tunnel's Target Region
l3:VrfName
          string:Basic
vrfName  (hctunn:If:vrfName)
           The VRF name. This name can be up to 64 alphanumeric characters.
Defined in: nw:Ep
naming:Name
          string:Basic
name  (nw:Ep:name)
           Overrides:nw:Conn:name
           The name of the object.
Defined in: mo:Resolvable
mo:Owner
          scalar:Enum8
lcOwn  (mo:Resolvable:lcOwn)
           A value that indicates how this object was created. For internal use only.
Defined in: mo:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
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

addr

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The peer IP address.



adminSt

Type: hctunn:AdminSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The administrative state of the object or policy.
Constants
up 1 up Administrative state is UP
down 2 down Administrative state is DOWN
DEFAULT up(1) up Administrative state is UP





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





dest

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The ERSPAN destination of the span session setup on the vCenter.



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.



id

Type: scalar:Sint64

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
An object identifier.



keepAlvIntvl

Type: hctunn:KeepAlvIntvl
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Tunnel keep-alive period
Constants
defaultValue 10u --- NO COMMENTS





lcOwn

Type: mo:Owner
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A value that indicates how this object was created. For internal use only.
Constants
local 0 Local NO COMMENTS
policy 1 Policy NO COMMENTS
replica 2 Replica NO COMMENTS
resolveOnBehalf 3 ResolvedOnBehalf NO COMMENTS
implicit 4 Implicit NO COMMENTS
DEFAULT local(0) Local NO COMMENTS





logicalDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Logical Model Mo's DN



mac

Type: address:MAC

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The MAC address.



modTs

Type: mo:TStamp
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The time when this object was last modified.
Constants
never 0ull never NO COMMENTS
DEFAULT never(0ull) never NO COMMENTS





mss

Type: hctunn:Mss
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Maximum Segment Size
Constants
defaultValue 1400u --- NO COMMENTS





mtu

Type: hctunn:ConfMtu
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The administrative MTU port on the aggregated interface.
Constants
defaultValue 1400u --- NO COMMENTS





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.



src

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The source IP address.



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.






tType

Type: hctunn:TunnelQual
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The type of target.
Constants
unknown 0 unknown Unknown
ivxlan 1 ivxlan iVXLAN tunnel
vxlan 2 vxlan VXLAN tunnel
ipsec 3 IPSec ipsec
gre 4 Generic Route Encapsulation protocol GRE
DEFAULT gre(4) Generic Route Encapsulation protocol GRE





targetRegion

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Tunnel's Target Region



tunnelDestinationType

Type: hctunn:TunnelDestinationType
Primitive Type: scalar:Enum64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Tunnel's Target Region
Constants
internal 0ull internal Internal
on-prem 1ull on-prem On-prem
cloud 2ull cloud-to-cloud Cloud
internal-eks 3ull Internal EKS Internal-EKS
DEFAULT internal(0ull) internal Internal





vrfName

Type: l3:VrfName
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The VRF name. This name can be up to 64 alphanumeric characters.