.. Class Doc file

class cobra.model.pki.KeyRing
=============================
.. class:: cobra.model.pki.KeyRing

A keyring to create and hold an SSL certificate. The SSL certificate contains the public RSA key and signed identity information of a PKI device. The PKI device holds a pair of RSA encryption keys, one kept private and one made public, stored in an internal key ring. The keyring certificate merges into the PKI device keyring to create a trusted relationship.

    Containers:
      * :class:`cobra.model.pki.Ep`

    Containment:
      * :class:`cobra.model.pki.RtKeyRing`
      * :class:`cobra.model.fault.Delegate`
      * :class:`cobra.model.pki.RtKeyringRef`
      * :class:`cobra.model.pki.CertReq`

    Properties:
      - adminState : The current administrative state of the certificate request process.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: True
          + isImplicit: False

      - cert : A certificate is a file containing a device's public key along with signed information verifying the identity of the device.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: True
          + isImplicit: False

      - certValidUntil : 

          + isNaming: False
          + isCreateOnly: False
          + isConfig: False
          + isImplicit: True

      - certificateDecodeInformation : 

          + isNaming: False
          + isCreateOnly: False
          + isConfig: False
          + isImplicit: True

      - childAction : Delete or ignore. For internal use only.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: False
          + isImplicit: True

      - descr : The description of the key ring.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: True
          + isImplicit: False

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

          + isNaming: False
          + isCreateOnly: True
          + isConfig: False
          + isImplicit: True

      - key : The private key of the certificate.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: True
          + isImplicit: False

      - lcOwn : Indicates how this object was created.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: False
          + isImplicit: True

      - modTs : The time when this object was last modified.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: False
          + isImplicit: True

      - modulus : The length of the encryption keys. A longer key length increases the difficulty of breaking the key.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: True
          + isImplicit: False

      - name : The name of the key ring.

          + isNaming: True
          + isCreateOnly: True
          + isConfig: True
          + isImplicit: False

      - ownerKey : The key for enabling clients to own their data for entity correlation.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: True
          + isImplicit: False

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

          + isNaming: False
          + isCreateOnly: False
          + isConfig: True
          + isImplicit: False

      - regen : Forces regeneration of the keypair. Each PKI device holds a pair of asymmetric Rivest-Shamir-Adleman (RSA) encryption keys, one kept private and one made public, stored in an internal key ring.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: True
          + isImplicit: False

      - rn : Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.

          + isNaming: False
          + isCreateOnly: True
          + isConfig: False
          + isImplicit: True

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

          + isNaming: False
          + isCreateOnly: False
          + isConfig: False
          + isImplicit: True

      - tp : A third-party certificate from a trusted source, or trusted point, that affirms the identity of your device. The third-party certificate is signed by the issuing certificate authority (CA or trustpoint), which can be a root CA, an intermediate CA, or a trust anchor that is part of a trust chain that leads to a root CA.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: True
          + isImplicit: False

      - uid : A unique identifier for this object.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: False
          + isImplicit: True