Class fvcap:NSRule (CONCRETE)

Class ID:17729
Class Label: Fv NameSpace Capability Rule
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Ambiguous Placement in the Model - APIC NX Processing: 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 ]

Generic namespace Rule

Naming Rules
RN FORMAT: fvcapnsrule-{[subj]}-scope-{scope}-type-{type}

    [1] PREFIX=fvcapnsrule- PROPERTY = subj


    [2] PREFIX=-scope- PROPERTY = scope


    [3] PREFIX=-type- PROPERTY = type




DN FORMAT: 

        Too Many Containers: 110
                


Containers Hierarchies
Too Many containers: 110


Contained Hierarchy
[V] fvcap:NSRule  Generic namespace Rule
 ├
[V] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 ├
[V] tag:Annotation 
 ├
[V] tag:Tag 


Inheritance
[V] cap:Rule Represents a capability or capacity provider rule. Every Rule has a subject that represents the entity which consumes the capability. Namespaces that have concrete rules define the subject property and its types.
 ├
[V] fvcap:NSRule  Generic namespace Rule


Events
                fvcap:NSRule:creation__fvcap_NSRule
fvcap:NSRule:modification__fvcap_NSRule
fvcap:NSRule:deletion__fvcap_NSRule


Faults
                


Fsms
                


Properties Summary
Defined in: fvcap:NSRule
mo:Annotation
          string:Basic
annotation  (fvcap:NSRule:annotation)
           NO COMMENTS
mo:ExtMngdByType
          scalar:Bitmask32
extMngdBy  (fvcap:NSRule:extMngdBy)
           NO COMMENTS
cap:RaiseFaultState
          scalar:Enum8
faultState  (fvcap:NSRule:faultState)
           A placeholder for tracking if capability limits have been exceeded.
cap:Scope
          scalar:Enum8
scope  (fvcap:NSRule:scope)
           Overrides:cap:Rule:scope
           The domain applicable to the capability.
fvcap:Subj
          scalar:Enum16
subj  (fvcap:NSRule:subj)
           The subject consuming the capability.
cap:RuleT
          scalar:Enum8
type  (fvcap:NSRule:type)
           Overrides:cap:Rule:type
           The specific type of the object or component.
cap:Constraint
          scalar:Uint32
userConstraint  (fvcap:NSRule:userConstraint)
           User defined Constraints of the capability.
Defined in: cap:Rule
cap:Constraint
          scalar:Uint32
constraint  (cap:Rule:constraint)
           Specifies a constraint of a capability provider rule.
naming:Descr
          string:Basic
descr  (cap:Rule:descr)
           Specifies a description of a capability provider rule.
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:Ownable
scalar:Uint16 uid  (mo:Ownable:uid)
           A unique identifier for this object.
mo:UserDomType
          string:Basic
userdom  (mo:Ownable:userdom)
           NO COMMENTS
Defined in: mo:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
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

annotation

Type: mo:Annotation
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_.:-]+
    Comments:
NO COMMENTS



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





constraint

Type: cap:Constraint
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies a constraint of a capability provider rule.
Constants
feature-unavailable 0u feature-unavailable NO COMMENTS
DEFAULT 0 --- NO COMMENTS





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\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
Specifies a description of a capability provider rule.



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.



extMngdBy

Type: mo:ExtMngdByType
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
undefined 0u undefined NO COMMENTS
msc 1u msc NO COMMENTS
DEFAULT undefined(0u) undefined NO COMMENTS





faultState

Type: cap:RaiseFaultState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A placeholder for tracking if capability limits have been exceeded.
Constants
nominal 0 nominal NO COMMENTS
ruleHasLess 1 ruleHasLess NO COMMENTS
ruleHasMore 2 ruleHasMore NO COMMENTS
DEFAULT nominal(0) nominal NO COMMENTS





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





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.



scope

Type: cap:Scope
Primitive Type: scalar:Enum8

Overrides:cap:Rule:scope
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular Property Validators:
    Comments:
The domain applicable to the capability.
Constants
node 0 node NO COMMENTS
policy-domain 1 policy-domain NO COMMENTS
fabric 2 fabric NO COMMENTS
DEFAULT node(0) node NO COMMENTS





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.






subj

Type: fvcap:Subj
Primitive Type: scalar:Enum16

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Comments:
The subject consuming the capability.
Constants
unknown 0 Unknown Unknown
global-pctag-namespace 1 Global pcTag Global pcTag
DEFAULT unknown(0) Unknown Unknown





type

Type: cap:RuleT
Primitive Type: scalar:Enum8

Overrides:cap:Rule:type
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular Property Validators:
    Comments:
The specific type of the object or component.
Constants
limit 1 limit NO COMMENTS
DEFAULT limit(1) limit NO COMMENTS





uid

Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A unique identifier for this object.



userConstraint

Type: cap:Constraint
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
User defined Constraints of the capability.
Constants
feature-unavailable 0u feature-unavailable NO COMMENTS
DEFAULT 0 --- NO COMMENTS





userdom

Type: mo:UserDomType
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "256"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
    Comments:
NO COMMENTS
Constants
defaultValue "all" --- NO COMMENTS