Class pki:ExportEncryptionKey (CONCRETE)

Class ID:7286
Class Label: AES Encryption Passphrase and Keys for Config Export (and Import)
Encrypted: true - Exportable: false - Persistent: true - Configurable: true - Subject to Quota: Disabled
Write Access: [admin]
Read Access: [admin]
Creatable/Deletable: no (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

RN FORMAT: exportcryptkey

    [1] PREFIX=exportcryptkey


DN FORMAT: 

[1] uni/exportcryptkey

                

Diagram

Super Mo: pki:Definition, Container Mos: pol:Uni (deletable:no), Relations From: pki:ExportEncryptionKeyRelnHolder, Relations: pki:RtExportEncryptionKey,

Containers Hierarchies

top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.  ├ fabric:Topology The root for IFC topology.    ├ fabric:Pod A pod.      ├ fabric:Node The root node for the APIC.        ├ ctx:Local The local Context.          ├ ctx:Application The context application.            ├ pol:Uni Represents policy definition/resolution universe.              ├ pki:ExportEncryptionKey  Config Export Encryption Key policies top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.  ├ pol:Uni Represents policy definition/resolution universe.    ├ pki:ExportEncryptionKey  Config Export Encryption Key policies

Contained Hierarchy

pki:ExportEncryptionKey  Config Export Encryption Key policies  ├ 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.  ├ pki:RtExportEncryptionKey

Inheritance

naming:NamedObject An abstract base class for an object that contains a name.  ├ pol:Obj Represents a generic policy object.    ├ pol:Def Represents self-contained policy document.      ├ pki:Definition This is an abstract class and cannot be instantiated.        ├ pki:ExportEncryptionKey  Config Export Encryption Key policies

                pki:ExportEncryptionKey:creation__pki_ExportEncryptionKey

                pki:ExportEncryptionKey:modification__pki_ExportEncryptionKey

                pki:ExportEncryptionKey:deletion__pki_ExportEncryptionKey

                

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction

Delete or ignore. For internal use only.

clearEncryptionKey

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Setting this property to true will trigger the clearing of all fields in this mo, set the strongEncryptionEnabled policy to False and keyConfigured to False. There is no method to recover the previous passphrase before the clear operation.

cryptedPassphrase

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

We never allow the passphrase to be returned via REST or seen again but the *salted* hash can be returned via REST to the user so that they can check if their passphrase is the same as configured in the system.

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\\!#$%()*,-./:;@ _{|}~?&+]+

Specifies a description of the policy definition.

dn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn

A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.

encryptionKey

Type: pki:AES256Key
Primitive Type: string:Password

Units: null
Encrypted: true
Access: implicit
Category: TopLevelRegular

AES 256 Encryption Key

initializationVector

Type: pki:AES256IV
Primitive Type: string:Password

Units: null
Encrypted: true
Access: implicit
Category: TopLevelRegular

AES 256 Encryption Initialization Vector

keyConfigured

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Flag indicating if a passphrase/key is configured

lcOwn

Type: mo:Owner
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

A value that indicates how this object was created. For internal use only.

modTs

Type: mo:TStamp
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

The time when this object was last modified.

name

Type: naming:Name
Primitive Type: string:Basic

Overrides:pol:Obj:name  |  naming:NamedObject:name

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

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_.-]+

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\\!#$%()*,-./:;@ _{|}~?&+]+

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\\!#$%()*,-./:;@ _{|}~?&+]+

A tag for enabling clients to add their own data. For example, to indicate who created this object.

passphrase

Type: pki:exportPassphraseType
Primitive Type: string:Password

Units: null
Encrypted: true
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "32"

The encryption parameters cannot be modified by a client request - only via a passphrase change Setting this passphrase to blank/empty will trigger the clearing of all fields in this mo, set the strongEncryptionEnabled policy to False and keyConfigured to False. There is no method to recover the previous passphrase before the clear operation.

passphraseKeyDerivationVersion

Type: pki:passphraseKeyDerivationVersionType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Version of the algorithm used - used for forward compatibility

rn

Type: reference:BinRN

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn

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

The upgrade status. This property is for internal use only.

strongEncryptionEnabled

Type: pki:exportEncryptionPolicyType
Primitive Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Toggle to choose between weak and strong encryption - this flag can be set to True only when keyConfigured=True

timeGenerated

Type: scalar:Date

Units: date
Encrypted: false
Access: implicit
Category: TopLevelRegular

Ignore

uid

Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

A unique identifier for this object.