Class hcipsec:TransformSet (CONCRETE)

Class ID:14846
Class Label: Ipsec Transform-Set Policy
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-protocol-l3, admin, fabric-protocol-l3, tenant-connectivity-l3, tenant-ext-connectivity-l3, tenant-ext-protocol-l3, tenant-protocol-l3]
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 ]

Holds Ipsec Transform-Set Policy

Naming Rules
RN FORMAT: transformset-{name}

    [1] PREFIX=transformset- PROPERTY = name




DN FORMAT: 

[0] cprov-{vendor}/provacc-{[name]}/acct-{[name]}/region-{[regionName]}/context-{[name]}-addr-{[primaryCidr]}/csr-{[name]}/ipsec/inst/transformset-{name}

[1] acct-{[name]}/region-{[regionName]}/context-{[name]}-addr-{[primaryCidr]}/csr-{[name]}/ipsec/inst/transformset-{name}

                


Diagram

Super Mo: pol:Instr,
Container Mos: hcipsec:Inst (deletable:yes),
Relations From: hcipsec:Profile,
Relations: hcipsec:RtProfileToTransformSet,


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 
 
 
 
 ├
[V] hcloud:Region 
 
 
 
 
 ├
[V] hcloud:Ctx 
 
 
 
 
 
 ├
[V] hcloud:Csr 
 
 
 
 
 
 
 ├
[V] hcipsec:Entity 
 
 
 
 
 
 
 
 ├
[V] hcipsec:Inst 
 
 
 
 
 
 
 
 
 ├
[V] hcipsec:TransformSet  Holds Ipsec Transform-Set Policy
[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 
 
 ├
[V] hcloud:Region 
 
 
 ├
[V] hcloud:Ctx 
 
 
 
 ├
[V] hcloud:Csr 
 
 
 
 
 ├
[V] hcipsec:Entity 
 
 
 
 
 
 ├
[V] hcipsec:Inst 
 
 
 
 
 
 
 ├
[V] hcipsec:TransformSet  Holds Ipsec Transform-Set Policy


Contained Hierarchy
[V] hcipsec:TransformSet  Holds Ipsec Transform-Set Policy
 ├
[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] hcipsec:RtProfileToTransformSet 


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:Instr Represents a policy control instrumentation object.
 
 
 ├
[V] hcipsec:TransformSet  Holds Ipsec Transform-Set Policy


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: hcipsec:TransformSet
hcipsec:EncapsulationMode
          scalar:Enum8
encapsulationMode  (hcipsec:TransformSet:encapsulationMode)
           Encapsulation Mode
naming:Name
          string:Basic
name  (hcipsec:TransformSet:name)
           Overrides:pol:Obj:name | naming:NamedObject:name
           The name of the object.
hcipsec:TransformType
          scalar:Enum32
secondaryTransformType  (hcipsec:TransformSet:secondaryTransformType)
           Ipsec Secondary Transform Type
hcipsec:TransformType
          scalar:Enum32
transformType  (hcipsec:TransformSet:transformType)
           Ipsec Transform Type
Defined in: pol:Instr
naming:Descr
          string:Basic
descr  (pol:Instr:descr)
           Specifies a control instrumentation description.
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           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.
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.
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





descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Specifies a control instrumentation description.



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.



encapsulationMode

Type: hcipsec:EncapsulationMode
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Encapsulation Mode
Constants
tunnel 0 tunnel (datagram encapsulation) mode NO COMMENTS
transport 1 transport (payload encapsulation) mode NO COMMENTS
DEFAULT tunnel(0) tunnel (datagram encapsulation) mode 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:pol:Obj:name  |  naming:NamedObject:name
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
The name of the object.



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
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.



secondaryTransformType

Type: hcipsec:TransformType
Primitive Type: scalar:Enum32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Ipsec Secondary Transform Type
Constants
ah-md5-hmac 0u AH-HMAC-MD5 transform AH-HMAC-MD5 transform
esp-gmac 10u ESP transform using GMAC cipher ESP transform using GMAC cipher
esp-md5-hmac 11u ESP transform using HMAC-MD5 auth ESP transform using HMAC-MD5 auth
esp-null 12u ESP transform w/o cipher ESP transform w/o cipher
esp-seal 13u ESP transform using SEAL cipher (160 bits) ESP transform using SEAL cipher (160 bits)
esp-sha-hmac 14u ESP transform using HMAC-SHA auth ESP transform using HMAC-SHA auth
esp-sha256-hmac 15u ESP transform using HMAC-SHA auth ESP transform using HMAC-SHA auth
esp-sha384-hmac 16u ESP transform using HMAC-SHA384 auth ESP transform using HMAC-SHA384 auth
esp-sha512-hmac 17u ESP transform using HMAC-SHA512 auth ESP transform using HMAC-SHA512 auth
ah-sha-hmac 1u AH-HMAC-SHA transform AH-HMAC-SHA transform
ah-sha256-hmac 2u AH-HMAC-SHA256 transform AH-HMAC-SHA256 transform
ah-sha384-hmac 3u AH-HMAC-SHA384 transform AH-HMAC-SHA384 transform
ah-sha512-hmac 4u AH-HMAC-SHA512 transform AH-HMAC-SHA512 transform
comp-lzs 5u IP Compression using the LZS compression algorithm IP Compression using the LZS compression algorithm
esp-3des 6u ESP transform using 3DES(EDE) cipher (168 bits) ESP transform using 3DES(EDE) cipher (168 bits)
esp-aes 7u ESP transform using AES cipher ESP transform using AES cipher
esp-des 8u ESP transform using DES cipher (56 bits) ESP transform using DES cipher (56 bits)
esp-gcm 9u ESP transform using GCM cipher ESP transform using GCM cipher
DEFAULT esp-aes(7u) ESP transform using AES cipher ESP transform using AES cipher





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.






transformType

Type: hcipsec:TransformType
Primitive Type: scalar:Enum32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Ipsec Transform Type
Constants
ah-md5-hmac 0u AH-HMAC-MD5 transform AH-HMAC-MD5 transform
esp-gmac 10u ESP transform using GMAC cipher ESP transform using GMAC cipher
esp-md5-hmac 11u ESP transform using HMAC-MD5 auth ESP transform using HMAC-MD5 auth
esp-null 12u ESP transform w/o cipher ESP transform w/o cipher
esp-seal 13u ESP transform using SEAL cipher (160 bits) ESP transform using SEAL cipher (160 bits)
esp-sha-hmac 14u ESP transform using HMAC-SHA auth ESP transform using HMAC-SHA auth
esp-sha256-hmac 15u ESP transform using HMAC-SHA auth ESP transform using HMAC-SHA auth
esp-sha384-hmac 16u ESP transform using HMAC-SHA384 auth ESP transform using HMAC-SHA384 auth
esp-sha512-hmac 17u ESP transform using HMAC-SHA512 auth ESP transform using HMAC-SHA512 auth
ah-sha-hmac 1u AH-HMAC-SHA transform AH-HMAC-SHA transform
ah-sha256-hmac 2u AH-HMAC-SHA256 transform AH-HMAC-SHA256 transform
ah-sha384-hmac 3u AH-HMAC-SHA384 transform AH-HMAC-SHA384 transform
ah-sha512-hmac 4u AH-HMAC-SHA512 transform AH-HMAC-SHA512 transform
comp-lzs 5u IP Compression using the LZS compression algorithm IP Compression using the LZS compression algorithm
esp-3des 6u ESP transform using 3DES(EDE) cipher (168 bits) ESP transform using 3DES(EDE) cipher (168 bits)
esp-aes 7u ESP transform using AES cipher ESP transform using AES cipher
esp-des 8u ESP transform using DES cipher (56 bits) ESP transform using DES cipher (56 bits)
esp-gcm 9u ESP transform using GCM cipher ESP transform using GCM cipher
DEFAULT esp-aes(7u) ESP transform using AES cipher ESP transform using AES cipher