Overview  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail  Naming 

Class pki:CertReq (CONCRETE)

Class ID:263
Encrypted: false - Exportable: false - Persistent: true
Privileges: [aaa, admin]
SNMP OID: .1.3.6.1.4.1.9.9.719.1.92.1

NO COMMENTS

Naming Rules 
RN FORMAT: certreq

    [1] PREFIX=certreq


DN FORMAT: 

[0] sys/pki-ext/keyring-[name]/certreq


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.
 ├
 		top:System Provides general information about this system, such as the name, IP address and current time.
 
 		 ├
 		pki:Ep PKI config: keyrings and CA certs
 
 		 
 		 ├
 		pki:KeyRing
 
 		 
 		 
 		 ├
 		pki:CertReq


Contained Hierarchy
pki:CertReq
Inheritance
pki:CertReq
Events


Faults


Fsms


Properties Summary
Defined in: pki:CertReq
naming:Name
          string:Basic 		country  (pki:CertReq:country)
           NO COMMENTS
naming:Name
          string:Basic 		dns  (pki:CertReq:dns)
           NO COMMENTS
naming:Name
          string:Basic 		email  (pki:CertReq:email)
           NO COMMENTS
address:IPv4 ip  (pki:CertReq:ip)
           NO COMMENTS
address:IPv4 ipA  (pki:CertReq:ipA)
           This property used to get the FI A's IP address while creating cert-req.
address:IPv4 ipB  (pki:CertReq:ipB)
           This property used to get the FI B's IP address while creating cert-req.
address:IPv6 ipv6  (pki:CertReq:ipv6)
           This property is used to get the VIP address while creating cert-req.
address:IPv6 ipv6A  (pki:CertReq:ipv6A)
           This property used to get the FI A's IPv6 address while creating cert-req.
address:IPv6 ipv6B  (pki:CertReq:ipv6B)
           This property used to get the FI B's IPv6 address while creating cert-req.
naming:Name
          string:Basic 		locality  (pki:CertReq:locality)
           NO COMMENTS
naming:Name
          string:Basic 		orgName  (pki:CertReq:orgName)
           NO COMMENTS
naming:Name
          string:Basic 		orgUnitName  (pki:CertReq:orgUnitName)
           NO COMMENTS
string:Password pwd  (pki:CertReq:pwd)
           Challenge password, must be zeroed after generating request
pki:Cert
          string:CharBuffer 		req  (pki:CertReq:req)
           PEM encoded certificate request
naming:Name
          string:Basic 		state  (pki:CertReq:state)
           NO COMMENTS
naming:Name
          string:Basic 		subjName  (pki:CertReq:subjName)
           TODO how to set this value to hostname by default
Defined in: mo:TopProps
mo:ModificationChildAction
          scalar:Bitmask32 		childAction  (mo:TopProps:childAction)
          
reference:Object dn  (mo:TopProps:dn)
           The Distinguished Name (dn) unambiguously identifies an object in the system.
The dn provides a fully qualified path from the top of the object tree, all the way to the object. It is built as a sequence of relative names separated by the "/" character.
For example:
< ... dn = "sys/chassis-5/blade-2/adaptor-1" />
reference:RN rn  (mo:TopProps:rn)
           The Relative Name (rn) uniquely identifies an object within a given context.
Note that a dn is comprised of a sequence of relative names. For example, the context "sys/chassis-1/blade-1/adaptor-1/host-eth-2" can be thought of as the following expression:
dn = <root object>/{rn}/{rn}/{rn}/{rn}/{rn}.
The rn can then be used to identify the object (for instance, "adaptor-1") within the context:
<... rn ="../" />
mo:InstSaclType
          scalar:Bitmask8 		sacl  (mo:TopProps:sacl)
           The system acl property for each Managed Object. br/> This property is a 8 bit mask and supports the following values :-
a: del
b: mod
c: addchild
d: cascade

By default all Managed Objects have the following permissions
a: del
b: mod
c: addchild
This property is persisted in the db. If this property has a value none
it means, the user has read only permissions on this object.
mo:ModificationStatus
          scalar:Bitmask32 		status  (mo:TopProps:status)
           This property controls the life cycle of a managed object
Properties Detail

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction
Property Validators:

Comments:
Constants
deleteAll 16384u NO COMMENTS
ignore 4096u NO COMMENTS
deleteNonPresent 8192u NO COMMENTS
DEFAULT 0 This type is used to

country

Type: naming:Name
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Regex: ˆ([A-Z]{2})?$

Comments:
NO COMMENTS

dn

Type: reference:Object
Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn
Property Validators:

Comments:
The Distinguished Name (dn) unambiguously identifies an object in the system.
The dn provides a fully qualified path from the top of the object tree, all the way to the object. It is built as a sequence of relative names separated by the "/" character.
For example:
< ... dn = "sys/chassis-5/blade-2/adaptor-1" />

dns

Type: naming:Name
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "255"
        Allowed Chars:
            Regex: [a-zA-Z0-9()+,-./:@_ˆ\s]+

Comments:
NO COMMENTS

email

Type: naming:Name
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "40"
        Allowed Chars:
            Regex: [a-zA-Z0-9()+,-./:@_ˆ\s]+

Comments:
NO COMMENTS

ip

Type: address:IPv4
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
defaultValue 0u NO COMMENTS

ipA

Type: address:IPv4
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Comments:
This property used to get the FI A's IP address while creating cert-req.
Constants
defaultValue 0u NO COMMENTS

ipB

Type: address:IPv4
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Comments:
This property used to get the FI B's IP address while creating cert-req.
Constants
defaultValue 0u NO COMMENTS

ipv6

Type: address:IPv6
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Comments:
This property is used to get the VIP address while creating cert-req.
Constants
defaultValue "::" NO COMMENTS

ipv6A

Type: address:IPv6
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Comments:
This property used to get the FI A's IPv6 address while creating cert-req.
Constants
defaultValue "::" NO COMMENTS

ipv6B

Type: address:IPv6
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Comments:
This property used to get the FI B's IPv6 address while creating cert-req.
Constants
defaultValue "::" NO COMMENTS

locality

Type: naming:Name
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()+,-./:@_ˆ\s]+

Comments:
NO COMMENTS

orgName

Type: naming:Name
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()+,-./:@_ˆ\s]+

Comments:
NO COMMENTS

orgUnitName

Type: naming:Name
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()+,-./:@_ˆ\s]+

Comments:
NO COMMENTS

pwd

Type: string:Password
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Comments:
Challenge password, must be zeroed after generating request

req

Type: pki:Cert
Primitive Type: string:CharBuffer
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
PEM encoded certificate request

rn

Type: reference:RN
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn
Property Validators:

Comments:
The Relative Name (rn) uniquely identifies an object within a given context.
Note that a dn is comprised of a sequence of relative names. For example, the context "sys/chassis-1/blade-1/adaptor-1/host-eth-2" can be thought of as the following expression:
dn = <root object>/{rn}/{rn}/{rn}/{rn}/{rn}.
The rn can then be used to identify the object (for instance, "adaptor-1") within the context:
<... rn ="../" />

sacl

Type: mo:InstSaclType
Primitive Type: scalar:Bitmask8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelSacl
Property Validators:

Comments:
The system acl property for each Managed Object. br/> This property is a 8 bit mask and supports the following values :-
a: del
b: mod
c: addchild
d: cascade

By default all Managed Objects have the following permissions
a: del
b: mod
c: addchild
This property is persisted in the db. If this property has a value none
it means, the user has read only permissions on this object.
Constants
none 0 NO COMMENTS
del 1 NO COMMENTS
mod 2 NO COMMENTS
addchild 4 NO COMMENTS
cascade 8 NO COMMENTS
DEFAULT 0 NO COMMENTS

state

Type: naming:Name
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()+,-./:@_ˆ\s]+

Comments:
NO COMMENTS

status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus
Property Validators:

Comments:
This property controls the life cycle of a managed object
Constants
removed 16u In a setter method: specifies that an object should be removed.
In the return value of a setter method: indicates that an object has been removed.
created 2u 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 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 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.

subjName

Type: naming:Name
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "64"

Comments:
TODO how to set this value to hostname by default
Overview  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail  Naming