Class hcloud:AwsVpnTunnelInfo (CONCRETE)

Class ID:14987
Class Label: VGWs VPN Connection Tunnel Info
Encrypted: false - Exportable: true - Persistent: false - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Logical Model - APIC NX Processing: Disabled
Write Access: [admin, tenant-connectivity]
Read Access: [admin, tenant-connectivity]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: None
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

NO COMMENTS

Naming Rules
RN FORMAT: tunnelinfo-{tunnelID}

    [1] PREFIX=tunnelinfo- PROPERTY = tunnelID




DN FORMAT: 

[0] cprov-{vendor}/provacc-{[name]}/acct-{[name]}/region-{[regionName]}/hubCtx-{[vrfGroupId]}-id-{[instId]}/vgw/rsvpnConnToCgw-{[tDn]}/tunnelinfo-{tunnelID}

[1] acct-{[name]}/region-{[regionName]}/hubCtx-{[vrfGroupId]}-id-{[instId]}/vgw/rsvpnConnToCgw-{[tDn]}/tunnelinfo-{tunnelID}

[2] cprov-{vendor}/provacc-{[name]}/acct-{[name]}/region-{[regionName]}/context-{[name]}-addr-{[primaryCidr]}/vgw/rsvpnConnToCgw-{[tDn]}/tunnelinfo-{tunnelID}

[3] acct-{[name]}/region-{[regionName]}/context-{[name]}-addr-{[primaryCidr]}/vgw/rsvpnConnToCgw-{[tDn]}/tunnelinfo-{tunnelID}

                


Diagram

Super Mo: pol:Def,
Container Mos: hcloud:RsVpnConnToCgw (deletable:yes),
Contained Mos: aaa:RbacAnnotation, tag:Annotation, tag:Tag,


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:HubCtx 
 
 
 
 
 
 ├
[V] hcloud:Vgw 
 
 
 
 
 
 
 ├
[V] hcloud:RsVpnConnToCgw 
 
 
 
 
 
 
 
 ├
[V] hcloud:AwsVpnTunnelInfo 
[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:HubCtx 
 
 
 
 ├
[V] hcloud:Vgw 
 
 
 
 
 ├
[V] hcloud:RsVpnConnToCgw 
 
 
 
 
 
 ├
[V] hcloud:AwsVpnTunnelInfo 
[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:Vgw 
 
 
 
 
 
 
 ├
[V] hcloud:RsVpnConnToCgw 
 
 
 
 
 
 
 
 ├
[V] hcloud:AwsVpnTunnelInfo 
[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:Vgw 
 
 
 
 
 ├
[V] hcloud:RsVpnConnToCgw 
 
 
 
 
 
 ├
[V] hcloud:AwsVpnTunnelInfo 


Contained Hierarchy
[V] hcloud:AwsVpnTunnelInfo 
 ├
[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] fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.
 ├
[V] tag:Annotation 
 ├
[V] tag:Tag 


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] pol:Obj Represents a generic policy object.
 
 ├
[V] pol:Def Represents self-contained policy document.
 
 
 ├
[V] hcloud:AwsVpnTunnelInfo 


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: hcloud:AwsVpnTunnelInfo
mo:Annotation
          string:Basic
annotation  (hcloud:AwsVpnTunnelInfo:annotation)
           NO COMMENTS
rtcom:AS
          scalar:Uint32
asn  (hcloud:AwsVpnTunnelInfo:asn)
           A number that uniquely identifies an autonomous system.
address:Ip destInnerAddress  (hcloud:AwsVpnTunnelInfo:destInnerAddress)
           NO COMMENTS
address:Ip destOuterAddress  (hcloud:AwsVpnTunnelInfo:destOuterAddress)
           NO COMMENTS
scalar:Uint32 dpdInterval  (hcloud:AwsVpnTunnelInfo:dpdInterval)
           NO COMMENTS
scalar:Uint32 dpdRetries  (hcloud:AwsVpnTunnelInfo:dpdRetries)
           NO COMMENTS
mo:ExtMngdByType
          scalar:Bitmask32
extMngdBy  (hcloud:AwsVpnTunnelInfo:extMngdBy)
           NO COMMENTS
scalar:Bool fragmentationBeforeEncryption  (hcloud:AwsVpnTunnelInfo:fragmentationBeforeEncryption)
           NO COMMENTS
scalar:Uint32 holdTime  (hcloud:AwsVpnTunnelInfo:holdTime)
           NO COMMENTS
string:Basic ikeAuthenticationProtocol  (hcloud:AwsVpnTunnelInfo:ikeAuthenticationProtocol)
           NO COMMENTS
string:Basic ikeEncryptionProtocol  (hcloud:AwsVpnTunnelInfo:ikeEncryptionProtocol)
           NO COMMENTS
string:Basic ikeForwardSecrecy  (hcloud:AwsVpnTunnelInfo:ikeForwardSecrecy)
           NO COMMENTS
hcisakmp:LifeTime
          scalar:Uint32
ikeLifetime  (hcloud:AwsVpnTunnelInfo:ikeLifetime)
           NO COMMENTS
string:Basic ikeMode  (hcloud:AwsVpnTunnelInfo:ikeMode)
           NO COMMENTS
hcisakmp:IkeVersion
          scalar:Enum8
ikeVersion  (hcloud:AwsVpnTunnelInfo:ikeVersion)
           NO COMMENTS
address:Ip innerAddress  (hcloud:AwsVpnTunnelInfo:innerAddress)
           NO COMMENTS
string:Basic ipsecAuthenticationProtocol  (hcloud:AwsVpnTunnelInfo:ipsecAuthenticationProtocol)
           NO COMMENTS
scalar:Bool ipsecClearDFBit  (hcloud:AwsVpnTunnelInfo:ipsecClearDFBit)
           NO COMMENTS
string:Basic ipsecEncryptionProtocol  (hcloud:AwsVpnTunnelInfo:ipsecEncryptionProtocol)
           NO COMMENTS
string:Basic ipsecForwardSecrecy  (hcloud:AwsVpnTunnelInfo:ipsecForwardSecrecy)
           NO COMMENTS
scalar:Uint32 ipsecLifetime  (hcloud:AwsVpnTunnelInfo:ipsecLifetime)
           NO COMMENTS
string:Basic ipsecMode  (hcloud:AwsVpnTunnelInfo:ipsecMode)
           NO COMMENTS
string:Basic ipsecProtocol  (hcloud:AwsVpnTunnelInfo:ipsecProtocol)
           NO COMMENTS
scalar:Bool isReady  (hcloud:AwsVpnTunnelInfo:isReady)
           NO COMMENTS
address:Ip outerAddress  (hcloud:AwsVpnTunnelInfo:outerAddress)
           NO COMMENTS
string:Basic preSharedKey  (hcloud:AwsVpnTunnelInfo:preSharedKey)
           NO COMMENTS
rtcom:AS
          scalar:Uint32
remoteAsn  (hcloud:AwsVpnTunnelInfo:remoteAsn)
           NO COMMENTS
scalar:Uint32 remoteHoldTime  (hcloud:AwsVpnTunnelInfo:remoteHoldTime)
           NO COMMENTS
scalar:Uint32 tcpMSS  (hcloud:AwsVpnTunnelInfo:tcpMSS)
           NO COMMENTS
hcbgp:TtlVal
          scalar:Uint16
ttl  (hcloud:AwsVpnTunnelInfo:ttl)
           Specifies time to live (TTL).
scalar:UByte tunnelID  (hcloud:AwsVpnTunnelInfo:tunnelID)
           NO COMMENTS
Defined in: pol:Def
naming:Descr
          string:Basic
descr  (pol:Def:descr)
           Specifies a description of the policy definition.
naming:Descr
          string:Basic
ownerKey  (pol:Def:ownerKey)
           The key for enabling clients to own their data for entity correlation.
naming:Descr
          string:Basic
ownerTag  (pol:Def:ownerTag)
           A tag for enabling clients to add their own data. For example, to indicate who created this object.
Defined in: pol:Obj
naming:Name
          string:Basic
name  (pol:Obj:name)
           Overrides:naming:NamedObject:name
           null
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
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:Ownable
scalar:Uint16 uid  (mo:Ownable:uid)
           A unique identifier for this object.
mo:UserDomType
          string:Basic
userdom  (mo:Ownable:userdom)
           NO COMMENTS
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

annotation

Type: mo:Annotation
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
    Comments:
NO COMMENTS



asn

Type: rtcom:AS
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A number that uniquely identifies an autonomous system.



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





descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
Specifies a description of the policy definition.



destInnerAddress

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS



destOuterAddress

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS



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.



dpdInterval

Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS



dpdRetries

Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS



extMngdBy

Type: mo:ExtMngdByType
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
undefined 0u undefined NO COMMENTS
msc 1u msc NO COMMENTS
DEFAULT undefined(0u) undefined NO COMMENTS





fragmentationBeforeEncryption

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





holdTime

Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS



ikeAuthenticationProtocol

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS



ikeEncryptionProtocol

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS



ikeForwardSecrecy

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS



ikeLifetime

Type: hcisakmp:LifeTime
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
defaultValue 28000u --- NO COMMENTS





ikeMode

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS



ikeVersion

Type: hcisakmp:IkeVersion
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
ikev1 0 use isakmp version 1 NO COMMENTS
ikev2 1 use isakmp version 2 NO COMMENTS
DEFAULT ikev1(0) use isakmp version 1 NO COMMENTS





innerAddress

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS



ipsecAuthenticationProtocol

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS



ipsecClearDFBit

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





ipsecEncryptionProtocol

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS



ipsecForwardSecrecy

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS



ipsecLifetime

Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS



ipsecMode

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS



ipsecProtocol

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS



isReady

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- 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





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





name

Type: naming:Name
Primitive Type: string:Basic

Overrides:naming:NamedObject:name
Units: null Encrypted: false Access: admin Category: TopLevelRegular Property Validators: Range: min: "0" max: "64" Allowed Chars: Regex: [a-zA-Z0-9_.:-]+
    Comments:
null



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "63"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.-]+
    Comments:
NO COMMENTS



outerAddress

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS



ownerKey

Type: naming:Descr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
The key for enabling clients to own their data for entity correlation.



ownerTag

Type: naming:Descr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "64"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
A tag for enabling clients to add their own data. For example, to indicate who created this object.



preSharedKey

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS



remoteAsn

Type: rtcom:AS
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS



remoteHoldTime

Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS



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.



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.






tcpMSS

Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS



ttl

Type: hcbgp:TtlVal
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies time to live (TTL).
Constants
defaultValue 1 --- NO COMMENTS





tunnelID

Type: scalar:UByte

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: (short)1  max: (short)2
    Comments:
NO COMMENTS



uid

Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A unique identifier for this object.



userdom

Type: mo:UserDomType
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "256"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
    Comments:
NO COMMENTS
Constants
defaultValue "all" --- NO COMMENTS