Class hostprot:Rule (CONCRETE)

Class ID:9843
Class Label: Host Protection Domain Rule
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 ]

RN FORMAT: rule-{name}

    [1] PREFIX=rule- PROPERTY = name




DN FORMAT: 

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

                

Diagram

Super Mo: hostprot:ARule, Container Mos: hostprot:Subj (deletable:yes), Contained Mos: aaa:RbacAnnotation, hostprot:RemoteIp, tag:AInst, tag:Annotation, tag:Tag,

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.  ├ fabric:Topology The root for IFC topology.    ├ fabric:Pod A pod.      ├ fabric:Node The root node for the APIC.        ├ ctx:Local The local Context.          ├ ctx:Application The context application.            ├ pol:Uni Represents policy definition/resolution universe.              ├ 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.                ├ hostprot:Pol                   ├ hostprot:Subj                     ├ hostprot:Rule  top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.  ├ pol:Uni Represents policy definition/resolution universe.    ├ 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.      ├ hostprot:Pol         ├ hostprot:Subj           ├ hostprot:Rule

Contained Hierarchy

hostprot:Rule   ├ 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  ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.  ├ 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.  ├ 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.    ├ 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    ├ tag:Annotation     ├ tag:Tag   ├ health:Inst A base class for a health score instance.(Switch only)  ├ hostprot:RemoteIp     ├ 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    ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.    ├ 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.    ├ health:Inst A base class for a health score instance.(Switch only)    ├ tag:AInst The label instance, which is contained by the taggable object.      ├ 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.    ├ tag:Annotation     ├ tag:Tag   ├ tag:AInst The label instance, which is contained by the taggable object.    ├ 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.  ├ tag:Annotation   ├ tag:Tag

Inheritance

naming:NamedObject An abstract base class for an object that contains a name.  ├ pol:Obj Represents a generic policy object.    ├ pol:Def Represents self-contained policy document.      ├ hostprot:ARule         ├ hostprot:Rule

Stats

hostprot:Rule   ├ opflex:OvsHpp15min A class that represents the most current statistics for ovs host protection stats in a 15 minute sampling interval. This class updates every 5 minutes.  ├ opflex:OvsHpp1d A class that represents the most current statistics for ovs host protection stats in a 1 day sampling interval. This class updates every hour.  ├ opflex:OvsHpp1h A class that represents the most current statistics for ovs host protection stats in a 1 hour sampling interval. This class updates every 15 minutes.  ├ opflex:OvsHpp1mo A class that represents the most current statistics for ovs host protection stats in a 1 month sampling interval. This class updates every day.  ├ opflex:OvsHpp1qtr A class that represents the most current statistics for ovs host protection stats in a 1 quarter sampling interval. This class updates every day.  ├ opflex:OvsHpp1w A class that represents the most current statistics for ovs host protection stats in a 1 week sampling interval. This class updates every day.  ├ opflex:OvsHpp1year A class that represents the most current statistics for ovs host protection stats in a 1 year sampling interval. This class updates every day.  ├ opflex:OvsHpp5min A class that represents the most current statistics for ovs host protection stats in a 5 minute sampling interval. This class updates every 10 seconds.  ├ opflex:OvsHppHist15min A class that represents historical statistics for ovs host protection stats in a 15 minute sampling interval. This class updates every 5 minutes.  ├ opflex:OvsHppHist1d A class that represents historical statistics for ovs host protection stats in a 1 day sampling interval. This class updates every hour.  ├ opflex:OvsHppHist1h A class that represents historical statistics for ovs host protection stats in a 1 hour sampling interval. This class updates every 15 minutes.  ├ opflex:OvsHppHist1mo A class that represents historical statistics for ovs host protection stats in a 1 month sampling interval. This class updates every day.  ├ opflex:OvsHppHist1qtr A class that represents historical statistics for ovs host protection stats in a 1 quarter sampling interval. This class updates every day.  ├ opflex:OvsHppHist1w A class that represents historical statistics for ovs host protection stats in a 1 week sampling interval. This class updates every day.  ├ opflex:OvsHppHist1year A class that represents historical statistics for ovs host protection stats in a 1 year sampling interval. This class updates every day.  ├ opflex:OvsHppHist5min A class that represents historical statistics for ovs host protection stats in a 5 minute sampling interval. This class updates every 10 seconds.

                hostprot:Rule:creation__hostprot_Rule

                hostprot:Rule:modification__hostprot_Rule

                hostprot:Rule:deletion__hostprot_Rule

                

action

Type: hostprot:Action
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

The action required when the condition is met.

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_.:-]+

NO COMMENTS

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction

Delete or ignore. For internal use only.

connTrack

Type: hostprot:ConnTrack
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

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\\!#$%()*,-./:;@ _{|}~?&+]+

Specifies a description of the policy definition.

direction

Type: network:Direction
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

The connector direction.

dn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn

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

ethertype

Type: hostprot:EtypeMatch
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

NO COMMENTS

extMngdBy

Type: mo:ExtMngdByType
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

NO COMMENTS

fromPort

Type: l4:Port
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 0xffff

The port block from port.

icmpCode

Type: icmp:Code
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 255

The ICMP code.

icmpType

Type: icmp:Type
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (short)0  max: (short)255

The ICMP type.

lcOwn

Type: mo:Owner
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

A value that indicates how this object was created. For internal use only.

modTs

Type: mo:TStamp
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

The time when this object was last modified.

monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

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_.:-]+

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_.-]+

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\\!#$%()*,-./:;@ _{|}~?&+]+

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\\!#$%()*,-./:;@ _{|}~?&+]+

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

protocol

Type: l3:IpProt
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (short)0  max: (short)255

The transfer protocol to be used for data export.

rn

Type: reference:BinRN

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn

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

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

toPort

Type: l4:Port
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 0xffff

The fabric card's port.

uid

Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

A unique identifier for this object.

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_.:-]+

NO COMMENTS