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 ]

NO COMMENTS

Naming Rules
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
[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] hostprot:Subj 
 
 
 
 
 
 
 
 
 
 ├
[V] hostprot:Rule 
[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 
 
 
 
 ├
[V] hostprot:Subj 
 
 
 
 
 ├
[V] hostprot:Rule 


Contained Hierarchy
[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 


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:ARule 
 
 
 
 ├
[V] hostprot:Rule 


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:Rule 
 ├
[V] 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.
 ├
[V] 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.
 ├
[V] 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.
 ├
[V] 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.
 ├
[V] 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.
 ├
[V] 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.
 ├
[V] 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.
 ├
[V] 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.
 ├
[V] 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.
 ├
[V] opflex:OvsHppHist1d A class that represents historical statistics for ovs host protection stats in a 1 day sampling interval. This class updates every hour.
 ├
[V] 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.
 ├
[V] opflex:OvsHppHist1mo A class that represents historical statistics for ovs host protection stats in a 1 month sampling interval. This class updates every day.
 ├
[V] opflex:OvsHppHist1qtr A class that represents historical statistics for ovs host protection stats in a 1 quarter sampling interval. This class updates every day.
 ├
[V] opflex:OvsHppHist1w A class that represents historical statistics for ovs host protection stats in a 1 week sampling interval. This class updates every day.
 ├
[V] opflex:OvsHppHist1year A class that represents historical statistics for ovs host protection stats in a 1 year sampling interval. This class updates every day.
 ├
[V] 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.


Events
                hostprot:Rule:creation__hostprot_Rule
hostprot:Rule:modification__hostprot_Rule
hostprot:Rule:deletion__hostprot_Rule


Faults
                


Fsms
                


Properties Summary
Defined in: hostprot:Rule
mo:Annotation
          string:Basic
annotation  (hostprot:Rule:annotation)
           NO COMMENTS
mo:ExtMngdByType
          scalar:Bitmask32
extMngdBy  (hostprot:Rule:extMngdBy)
           NO COMMENTS
reference:BinRef monPolDn  (hostprot:Rule:monPolDn)
           The monitoring policy attached to this observable object.
naming:Name
          string:Basic
name  (hostprot:Rule:name)
           Overrides:pol:Obj:name | naming:NamedObject:name
           The name of the object.
Defined in: hostprot:ARule
hostprot:Action
          scalar:Bitmask32
action  (hostprot:ARule:action)
           The action required when the condition is met.
hostprot:ConnTrack
          scalar:Enum8
connTrack  (hostprot:ARule:connTrack)
           NO COMMENTS
network:Direction
          scalar:Enum8
direction  (hostprot:ARule:direction)
           The connector direction.
hostprot:EtypeMatch
          scalar:Enum8
ethertype  (hostprot:ARule:ethertype)
           NO COMMENTS
l4:Port
          scalar:Uint16
fromPort  (hostprot:ARule:fromPort)
           The port block from port.
icmp:Code
          scalar:Uint16
icmpCode  (hostprot:ARule:icmpCode)
           The ICMP code.
icmp:Type
          scalar:UByte
icmpType  (hostprot:ARule:icmpType)
           The ICMP type.
l3:IpProt
          scalar:UByte
protocol  (hostprot:ARule:protocol)
           The transfer protocol to be used for data export.
l4:Port
          scalar:Uint16
toPort  (hostprot:ARule:toPort)
           The fabric card's port.
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: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

action

Type: hostprot:Action
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The action required when the condition is met.
Constants
log 1u log NO COMMENTS
permit 2u permit NO COMMENTS
deny 4u Deny NO COMMENTS
DEFAULT permit(2u) permit NO COMMENTS





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





connTrack

Type: hostprot:ConnTrack
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS
Constants
normal 1 normal NO COMMENTS
reflexive 2 reflexive NO COMMENTS
DEFAULT reflexive(2) reflexive 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 the policy definition.



direction

Type: network:Direction
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The connector direction.
Constants
egress 1 egress NO COMMENTS
ingress 2 ingress NO COMMENTS
DEFAULT ingress(2) ingress NO COMMENTS





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.



ethertype

Type: hostprot:EtypeMatch
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS
Constants
undefined 0 undefined NO COMMENTS
ipv4 1 ipv4 NO COMMENTS
ipv6 2 ipv6 NO COMMENTS
trill 3 trill NO COMMENTS
arp 4 arp NO COMMENTS
mpls_ucast 5 mpls_ucast NO COMMENTS
mac_security 6 mac_security NO COMMENTS
fcoe 7 fcoe NO COMMENTS
DEFAULT undefined(0) undefined NO COMMENTS





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





fromPort

Type: l4:Port
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 0xffff
    Comments:
The port block from port.
Constants
unspecified 0 Unspecified NO COMMENTS
ftpData 20 FTP data NO COMMENTS
smtp 25 SMTP NO COMMENTS
dns 53 DNS NO COMMENTS
http 80 HTTP NO COMMENTS
pop3 110 POP3 NO COMMENTS
https 443 HTTPS NO COMMENTS
rtsp 554 RTSP NO COMMENTS
DEFAULT unspecified(0) Unspecified NO COMMENTS





icmpCode

Type: icmp:Code
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 255
    Comments:
The ICMP code.
Constants
unspecified 0xffff Unspecified NO COMMENTS
DEFAULT unspecified(0xffff) Unspecified NO COMMENTS





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
    Comments:
The ICMP type.
Constants
unspecified 255 Unspecified NO COMMENTS
DEFAULT unspecified(255) Unspecified 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.



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
    Comments:
The transfer protocol to be used for data export.
Constants
unspecified 0 Unspecified Unspecified
icmp 1 icmp NO COMMENTS
igmp 2 igmp NO COMMENTS
tcp 6 tcp NO COMMENTS
egp 8 egp NO COMMENTS
igp 9 igp NO COMMENTS
udp 17 udp NO COMMENTS
icmpv6 58 icmpv6 NO COMMENTS
eigrp 88 eigrp NO COMMENTS
ospfigp 89 ospf NO COMMENTS
pim 103 pim NO COMMENTS
l2tp 115 l2tp NO COMMENTS
DEFAULT unspecified(0) Unspecified Unspecified





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.






toPort

Type: l4:Port
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 0xffff
    Comments:
The fabric card's port.
Constants
unspecified 0 Unspecified NO COMMENTS
ftpData 20 FTP data NO COMMENTS
smtp 25 SMTP NO COMMENTS
dns 53 DNS NO COMMENTS
http 80 HTTP NO COMMENTS
pop3 110 POP3 NO COMMENTS
https 443 HTTPS NO COMMENTS
rtsp 554 RTSP NO COMMENTS
DEFAULT unspecified(0) Unspecified NO COMMENTS





uid

Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
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_.:-]+
    Comments:
NO COMMENTS
Constants
defaultValue "all" --- NO COMMENTS