Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class cloudsec:SaKey (ABSTRACT)

Class ID:12258
Class Label: SA Key
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-connectivity, admin, fabric-connectivity]
Creatable/Deletable: derived (see Container Mos for details)
Possible Semantic Scopes: Infra, Fabric,
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

Peer SA Key

Naming Rules 


DN FORMAT:


Diagram

Sub Mos: cloudsec:SaRxKey, cloudsec:SaTxKey,


Inheritance
[V] cloudsec:SaKey  Peer SA Key
 ├
 		[V] cloudsec:SaRxKey  Peer SA RX Key
 ├
 		[V] cloudsec:SaTxKey  Peer SA TX Key


Events


Faults


Fsms


Properties Summary
Defined in: cloudsec:SaKey
cloudsec:SaKeyAssocNum
          scalar:Uint16 		assocNum  (cloudsec:SaKey:assocNum)
           Association Number Type
cloudsec:CipherSuite
          scalar:Enum8 		cipher  (cloudsec:SaKey:cipher)
           SA Key Cipher
cloudsec:HwIndex
          scalar:Uint32 		hwIndex  (cloudsec:SaKey:hwIndex)
           Hardware SA Index
cloudsec:SaKeyPassword
          string:Password 		key  (cloudsec:SaKey:key)
           The key or password used to uniquely identify this configuration object.
cloudsec:KeyControl
          scalar:Bitmask16 		keyControl  (cloudsec:SaKey:keyControl)
           SA Key Controls
cloudsec:KeyUpdTime
          scalar:Date 		keyUpdTime  (cloudsec:SaKey:keyUpdTime)
           Key Update Time
cloudsec:SaKeyRekeyNum
          scalar:Uint64 		operRekeyNum  (cloudsec:SaKey:operRekeyNum)
           Operational Rekey Number
cloudsec:OperSt
          scalar:Enum8 		operSt  (cloudsec:SaKey:operSt)
           The runtime state of the object or policy.
cloudsec:OperStQual
          scalar:Enum8 		operStQual  (cloudsec:SaKey:operStQual)
           The chassis operational status qualifier.
cloudsec:SaKeyRekeyNum
          scalar:Uint64 		rekeyNum  (cloudsec:SaKey:rekeyNum)
           SA Rekey Number
cloudsec:Sci
          scalar:Uint64 		sci  (cloudsec:SaKey:sci)
           SA Channel Identifier (8 bytes)
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

assocNum

Type: cloudsec:SaKeyAssocNum
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Association Number Type


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




cipher

Type: cloudsec:CipherSuite
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
SA Key Cipher
Constants
gcm-aes-xpn-256 0 256 bit GCM-AES Suite with Extended Packet Numbering gcm-aes-xpn-256, only supported suite for cloudsec
DEFAULT gcm-aes-xpn-256(0) 256 bit GCM-AES Suite with Extended Packet Numbering gcm-aes-xpn-256, only supported suite for cloudsec




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.


hwIndex

Type: cloudsec:HwIndex
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Hardware SA Index


key

Type: cloudsec:SaKeyPassword
Primitive Type: string:Password

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The key or password used to uniquely identify this configuration object.


keyControl

Type: cloudsec:KeyControl
Primitive Type: scalar:Bitmask16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
SA Key Controls
Constants
none 0 Key Control is not set Control is not set
markedForDelete 1 Key Marked For Delete Key Marked for Deleteion
DEFAULT none(0) Key Control is not set Control is not set




keyUpdTime

Type: cloudsec:KeyUpdTime
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Key Update Time


operRekeyNum

Type: cloudsec:SaKeyRekeyNum
Primitive Type: scalar:Uint64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Operational Rekey Number


operSt

Type: cloudsec:OperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The runtime state of the object or policy.
Constants
unknown 0 unknown The state is unknown
down 1 Down The state is down
hw-programming-in-progress 2 Hardware Programming in Progress The state is hw programming in progress
delete-success 3 Hardware Programming Delete Success The state is hw programming delete is success
up 4 Up The state is up
DEFAULT unknown(0) unknown The state is unknown




operStQual

Type: cloudsec:OperStQual
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The chassis operational status qualifier.
Constants
up 0 Up up
unsupported-platform 1 Unsupported Platform Unsupported Platform
unsupported-interface 2 Feature Unsupported on Interface Unsupported Interface
hw-programming-in-progress 3 Hardware Programming is in Progress HW Programming in Progress
hw-error 4 Error while programming in hardware HW Programming Error
if-vlan-encap-hw-error 5 Error while programming interface vlan encap in hardware Interface Vlan Encap HW Programming Error
peer-addr-hw-error 6 Error while programming peer address in hardware Peer Address HW Programming Error
sak-hw-error 7 Error while programming SAK in hardware SAK HW Programming Error
sak-an-hw-error 8 Error while programming SAK AN in hardware SAK Association Number HW Programming Error
sak-sci-hw-error 9 Error while programming SAK SCI in hardware SAK SCI HW Programming Error
hw-table-full-error 10 Error while programming due to table full in hardware HW Table Full Programming Error
delete-success 11 Success while deleting in hardware HW Programming Delete Success, similar to UP but for delete case
DEFAULT up(0) Up up




rekeyNum

Type: cloudsec:SaKeyRekeyNum
Primitive Type: scalar:Uint64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
SA Rekey Number


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.


sci

Type: cloudsec:Sci
Primitive Type: scalar:Uint64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
SA Channel Identifier (8 bytes)


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.







Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail