Class snmp:UserSecP (CONCRETE)

Class ID:2531
Class Label: User Security Policy
Encrypted: true - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-protocol-l3, access-protocol-mgmt, admin, fabric-protocol-l3, fabric-protocol-mgmt, tenant-ext-protocol-l3, tenant-protocol-l3]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

An authentication profile using user names.

Naming Rules
RN FORMAT: user-{name}

    [1] PREFIX=user- PROPERTY = name




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/snmp/inst/user-{name}

[1] sys/snmp/inst/user-{name}

                


Diagram

Super Mo: snmp:AUserP,
Container Mos: snmp:Inst (deletable:yes),


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] fabric:Topology The root for IFC topology.
 
 ├
[V] fabric:Pod A pod.
 
 
 ├
[V] fabric:Node The root node for the APIC.
 
 
 
 ├
[V] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 
 
 
 ├
[V] snmp:Entity SNMP control plane entity information.
 
 
 
 
 
 ├
[V] snmp:Inst A container for each SNMP instance.
 
 
 
 
 
 
 ├
[V] snmp:UserSecP An authentication profile using user names.
[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] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 ├
[V] snmp:Entity SNMP control plane entity information.
 
 
 ├
[V] snmp:Inst A container for each SNMP instance.
 
 
 
 ├
[V] snmp:UserSecP An authentication profile using user names.


Contained Hierarchy
[V] snmp:UserSecP An authentication profile using user names.
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 ├
[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] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 ├
[V] health:Inst A base class for a health score instance.(Switch only)


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:Comp Represents a policy component. This object is part of the policy definition.
 
 
 ├
[V] snmp:AUserP An abstract representation of a user profile.
 
 
 
 ├
[V] snmp:UserSecP An authentication profile using user names.


Events
                


Faults
                snmp:UserSecP:configFailed


Fsms
                


Properties Summary
Defined in: snmp:UserSecP
reference:BinRef monPolDn  (snmp:UserSecP:monPolDn)
           The monitoring policy attached to this observable object.
naming:Name
          string:Basic
name  (snmp:UserSecP:name)
           Overrides:snmp:AUserP:name | pol:Obj:name | naming:NamedObject:name
           Specifies a name for the user security profile.
nw:OSSum
          scalar:Enum8
operSt  (snmp:UserSecP:operSt)
           The runtime state of the object or policy.
nw:OSSumQual
          string:Basic
operStQual  (snmp:UserSecP:operStQual)
           The chassis operational status qualifier.
Defined in: snmp:AUserP
snmp:AuthKey
          string:Password
authKey  (snmp:AUserP:authKey)
           The authentication key for the user profile. The key can be any case-sensitive alphanumeric string up to 64 chars.
snmp:AuthType
          scalar:Enum8
authType  (snmp:AUserP:authType)
           The authentication type for the user profile. The authentication type is a message authentication code (MAC) that is used between two parties sharing a secret key to validate information transmitted between them. HMAC (Hash MAC) is based on cryptographic hash functions. It can be used in combination with any iterated cryptographic hash function. HMAC MD5 and HMAC SHA1 are two constructs of the HMAC using the MD5 hash function and the SHA1 hash function. HMAC also uses a secret key for calculation and verification of the message authentication values.
snmp:PrivKey
          string:Password
privKey  (snmp:AUserP:privKey)
           The privacy key for the user profile.
snmp:PrivType
          scalar:Enum8
privType  (snmp:AUserP:privType)
           The encryption type for the user profile.
Defined in: pol:Comp
naming:Descr
          string:Basic
descr  (pol:Comp:descr)
           Specifies the description of a policy component.
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
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.
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:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
Properties Detail

authKey

Type: snmp:AuthKey
Primitive Type: string:Password

Units: null
Encrypted: true
Access: create
Category: TopLevelRegular
    Comments:
The authentication key for the user profile. The key can be any case-sensitive alphanumeric string up to 64 chars.



authType

Type: snmp:AuthType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: create
Category: TopLevelRegular
    Comments:
The authentication type for the user profile. The authentication type is a message authentication code (MAC) that is used between two parties sharing a secret key to validate information transmitted between them. HMAC (Hash MAC) is based on cryptographic hash functions. It can be used in combination with any iterated cryptographic hash function. HMAC MD5 and HMAC SHA1 are two constructs of the HMAC using the MD5 hash function and the SHA1 hash function. HMAC also uses a secret key for calculation and verification of the message authentication values.
Constants
hmac-md5-96 1 HMAC-MD5-96 md5
hmac-sha1-96 2 HMAC-SHA1-96 sha1
DEFAULT hmac-md5-96(1) HMAC-MD5-96 md5





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 the description of a policy component.



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.



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





monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The monitoring policy attached to this observable object.



name

Type: naming:Name
Primitive Type: string:Basic

Overrides:snmp:AUserP:name  |  pol:Obj:name  |  naming:NamedObject:name
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
Specifies a name for the user security profile.



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
NO COMMENTS



operSt

Type: nw:OSSum
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The runtime state of the object or policy.
Constants
failed 0 Failed Failed
initializing 1 Initializing Initializing
resetting 2 Resetting Resetting
degraded 3 Degraded Degraded
ok 4 Ok Ok
DEFAULT ok(4) Ok Ok





operStQual

Type: nw:OSSumQual
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The chassis operational status qualifier.



privKey

Type: snmp:PrivKey
Primitive Type: string:Password

Units: null
Encrypted: true
Access: create
Category: TopLevelRegular
    Comments:
The privacy key for the user profile.



privType

Type: snmp:PrivType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: create
Category: TopLevelRegular
    Comments:
The encryption type for the user profile.
Constants
none 0 None None
des 1 DES des
aes-128 2 AES-128 AES-128
DEFAULT none(0) None None





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.



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.