Overview  Naming  Diagram  Containers  Contained  Inheritance  Stat Counters  Stats  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class hostprot:Pol (CONCRETE)

Class ID:9837
Class Label: Host Protection Domain Policy
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Logical Model - APIC NX Processing: Disabled
Write Access: [admin]
Read Access: [admin]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: EPG
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: true, HasFaults: true, HasHealth: true, HasEventRules: false ]

NO COMMENTS

Naming Rules 
RN FORMAT: pol-{name}

    [1] PREFIX=pol- PROPERTY = name




DN FORMAT: 

[1] uni/tn-{name}/pol-{name}


Diagram

Super Mo: hostprot:APol,
Container Mos: fv:Tenant (deletable:yes),
Contained Mos: aaa:RbacAnnotation, hostprot:Subj, tag:AInst, tag:Annotation, tag:Tag,
Relations From: opflex:IDEp,
Relations: hostprot:RtHpp,


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] ctx:Local The local Context.
 
 		 
 		 
 		 
 		 ├
 		[V] ctx:Application The context application.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] pol:Uni Represents policy definition/resolution universe.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] hostprot:Pol 
[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] pol:Uni Represents policy definition/resolution universe.
 
 		 ├
 		[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 		 
 		 ├
 		[V] hostprot:Pol 


Contained Hierarchy
[V] hostprot:Pol 
 ├
 		[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] 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] 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 
 ├
 		[V] health:Inst A base class for a health score instance.(Switch only)
 ├
 		[V] hostprot:RtHpp 
 ├
 		[V] hostprot:Subj 
 
 		 ├
 		[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] 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] 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 
 
 		 ├
 		[V] health:Inst A base class for a health score instance.(Switch only)
 
 		 ├
 		[V] hostprot: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] 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] 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 
 
 		 
 		 ├
 		[V] health:Inst A base class for a health score instance.(Switch only)
 
 		 
 		 ├
 		[V] hostprot:RemoteIp 
 
 		 
 		 
 		 ├
 		[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] 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] health:Inst A base class for a health score instance.(Switch only)
 
 		 
 		 
 		 ├
 		[V] tag:AInst The label instance, which is contained by the taggable object.
 
 		 
 		 
 		 
 		 ├
 		[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] tag:Annotation 
 
 		 
 		 
 		 ├
 		[V] tag:Tag 
 
 		 
 		 ├
 		[V] tag:AInst The label instance, which is contained by the taggable object.
 
 		 
 		 
 		 ├
 		[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] tag:Annotation 
 
 		 
 		 ├
 		[V] tag:Tag 
 
 		 ├
 		[V] tag:AInst The label instance, which is contained by the taggable object.
 
 		 
 		 ├
 		[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] tag:Annotation 
 
 		 ├
 		[V] tag:Tag 
 ├
 		[V] tag:AInst The label instance, which is contained by the taggable object.
 
 		 ├
 		[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] tag:Annotation 
 ├
 		[V] tag:Tag 


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:Def Represents self-contained policy document.
 
 		 
 		 ├
 		[V] hostprot:APol 
 
 		 
 		 
 		 ├
 		[V] hostprot:Pol 


Stat Counters
scalar:Uint64 COUNTER: opflex:OvsHpp:txBytes(bytes)
           transmitted bytes
          Comments: transmitted byte counter
scalar:Uint64 COUNTER: opflex:OvsHpp:rxBytes(bytes)
           received bytes
          Comments: received byte counter
scalar:Uint64 COUNTER: opflex:OvsHpp:txPkts(packets)
           transmitted packets
          Comments: transmitted packet counter
scalar:Uint64 COUNTER: opflex:OvsHpp:rxPkts(packets)
           received packets
          Comments: received packet counter


Stats
[V] hostprot:Pol 
 ├
 		[V] opflex:OvsHppAg15min A class that represents the most current aggregated statistics for ovs host protection stats in a 15 minute sampling interval. This class updates every 5 minutes.
 ├
 		[V] opflex:OvsHppAg1d A class that represents the most current aggregated statistics for ovs host protection stats in a 1 day sampling interval. This class updates every hour.
 ├
 		[V] opflex:OvsHppAg1h A class that represents the most current aggregated statistics for ovs host protection stats in a 1 hour sampling interval. This class updates every 15 minutes.
 ├
 		[V] opflex:OvsHppAg1mo A class that represents the most current aggregated statistics for ovs host protection stats in a 1 month sampling interval. This class updates every day.
 ├
 		[V] opflex:OvsHppAg1qtr A class that represents the most current aggregated statistics for ovs host protection stats in a 1 quarter sampling interval. This class updates every day.
 ├
 		[V] opflex:OvsHppAg1w A class that represents the most current aggregated statistics for ovs host protection stats in a 1 week sampling interval. This class updates every day.
 ├
 		[V] opflex:OvsHppAg1year A class that represents the most current aggregated statistics for ovs host protection stats in a 1 year sampling interval. This class updates every day.
 ├
 		[V] opflex:OvsHppAgHist15min A class that represents historical aggregated statistics for ovs host protection stats in a 15 minute sampling interval. This class updates every 5 minutes.
 ├
 		[V] opflex:OvsHppAgHist1d A class that represents historical aggregated statistics for ovs host protection stats in a 1 day sampling interval. This class updates every hour.
 ├
 		[V] opflex:OvsHppAgHist1h A class that represents historical aggregated statistics for ovs host protection stats in a 1 hour sampling interval. This class updates every 15 minutes.
 ├
 		[V] opflex:OvsHppAgHist1mo A class that represents historical aggregated statistics for ovs host protection stats in a 1 month sampling interval. This class updates every day.
 ├
 		[V] opflex:OvsHppAgHist1qtr A class that represents historical aggregated statistics for ovs host protection stats in a 1 quarter sampling interval. This class updates every day.
 ├
 		[V] opflex:OvsHppAgHist1w A class that represents historical aggregated statistics for ovs host protection stats in a 1 week sampling interval. This class updates every day.
 ├
 		[V] opflex:OvsHppAgHist1year A class that represents historical aggregated statistics for ovs host protection stats in a 1 year sampling interval. This class updates every day.
 ├
 		[V] opflex:OvsHppPart15min A class that represents the most current portion of the statistics for ovs host protection stats in a 15 minute sampling interval. This class updates every 5 minutes.
 ├
 		[V] opflex:OvsHppPart1d A class that represents the most current portion of the statistics for ovs host protection stats in a 1 day sampling interval. This class updates every hour.
 ├
 		[V] opflex:OvsHppPart1h A class that represents the most current portion of the statistics for ovs host protection stats in a 1 hour sampling interval. This class updates every 15 minutes.
 ├
 		[V] opflex:OvsHppPart1mo A class that represents the most current portion of the statistics for ovs host protection stats in a 1 month sampling interval. This class updates every day.
 ├
 		[V] opflex:OvsHppPart1qtr A class that represents the most current portion of the statistics for ovs host protection stats in a 1 quarter sampling interval. This class updates every day.
 ├
 		[V] opflex:OvsHppPart1w A class that represents the most current portion of the statistics for ovs host protection stats in a 1 week sampling interval. This class updates every day.
 ├
 		[V] opflex:OvsHppPart1year A class that represents the most current portion of the statistics for ovs host protection stats in a 1 year sampling interval. This class updates every day.
 ├
 		[V] opflex:OvsHppPart5min A class that represents the most current portion of the statistics for ovs host protection stats in a 5 minute sampling interval. This class updates every 10 seconds.
 ├
 		[V] opflex:OvsHppPartHist15min A class that represents historical portion of the statistics for ovs host protection stats in a 15 minute sampling interval. This class updates every 5 minutes.
 ├
 		[V] opflex:OvsHppPartHist1d A class that represents historical portion of the statistics for ovs host protection stats in a 1 day sampling interval. This class updates every hour.
 ├
 		[V] opflex:OvsHppPartHist1h A class that represents historical portion of the statistics for ovs host protection stats in a 1 hour sampling interval. This class updates every 15 minutes.
 ├
 		[V] opflex:OvsHppPartHist1mo A class that represents historical portion of the statistics for ovs host protection stats in a 1 month sampling interval. This class updates every day.
 ├
 		[V] opflex:OvsHppPartHist1qtr A class that represents historical portion of the statistics for ovs host protection stats in a 1 quarter sampling interval. This class updates every day.
 ├
 		[V] opflex:OvsHppPartHist1w A class that represents historical portion of the statistics for ovs host protection stats in a 1 week sampling interval. This class updates every day.
 ├
 		[V] opflex:OvsHppPartHist1year A class that represents historical portion of the statistics for ovs host protection stats in a 1 year sampling interval. This class updates every day.
 ├
 		[V] opflex:OvsHppPartHist5min A class that represents historical portion of the statistics for ovs host protection stats in a 5 minute sampling interval. This class updates every 10 seconds.


Events 
                hostprot:Pol:creation__hostprot_Pol

                hostprot:Pol:modification__hostprot_Pol

                hostprot:Pol:deletion__hostprot_Pol


Faults


Fsms


Properties Summary
Defined in: hostprot:Pol
mo:Annotation
          string:Basic 		annotation  (hostprot:Pol:annotation)
           NO COMMENTS
mo:ExtMngdByType
          scalar:Bitmask32 		extMngdBy  (hostprot:Pol:extMngdBy)
           NO COMMENTS
reference:BinRef monPolDn  (hostprot:Pol:monPolDn)
           The monitoring policy attached to this observable object.
naming:Name
          string:Basic 		name  (hostprot:Pol:name)
           Overrides:pol:Obj:name | naming:NamedObject:name
           The name of the object.
Defined in: pol:Def
naming:Descr
          string:Basic 		descr  (pol:Def:descr)
           Specifies a description of the policy definition.
naming:Descr
          string:Basic 		ownerKey  (pol:Def:ownerKey)
           The key for enabling clients to own their data for entity correlation.
naming:Descr
          string:Basic 		ownerTag  (pol:Def:ownerTag)
           A tag for enabling clients to add their own data. For example, to indicate who created this object.
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic 		nameAlias  (naming:NamedObject:nameAlias)
           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.
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.
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




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 the policy definition.


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




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:pol:Obj:name  |  naming:NamedObject:name

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: "1"  max: "64"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
    Comments:
The name of the object.


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_.-]+
    Comments:
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\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
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\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
A tag for enabling clients to add their own data. For example, to indicate who created this object.


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.





uid

Type: scalar:Uint16

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




Overview  Naming  Diagram  Containers  Contained  Inheritance  Stat Counters  Stats  Events  Faults  FSMs  Properties Summary  Properties Detail