Class fhs:IpInspectProto (CONCRETE)

Class ID:9255
Class Label: Inspection Protocol Policy
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Concrete Model
Write Access: [NON CONFIGURABLE]
Read Access: [access-connectivity-l3, access-protocol-l2, access-protocol-l3, admin, fabric-connectivity-l3, fabric-protocol-l3, tenant-connectivity-l3, tenant-ext-connectivity-l3, 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: true ]

Inspect Protocol Policy information

Naming Rules
RN FORMAT: proto-{type}

    [1] PREFIX=proto- PROPERTY = type




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/fhs/inst/dom-{[encap]}/bd-{[encap]}/ipinspect-{af}/proto-{type}

[1] sys/fhs/inst/dom-{[encap]}/bd-{[encap]}/ipinspect-{af}/proto-{type}

                


Diagram

Container Mos: fhs:IpInspect (deletable:yes),
Contained Mos: fhs:BtEntryArp, fhs:BtEntryData, fhs:BtEntryDhcp, fhs:BtEntryLocal, fhs:BtEntryNd, fhs:BtEntryStatic,


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] fhs:Entity  Holds FHS control plane entity information
 
 
 
 
 
 ├
[V] fhs:Inst  This objects hold per fhs instance information. There is only one instance of fhs running in the system today
 
 
 
 
 
 
 ├
[V] fhs:Dom  FHS Enabled Domain (vrf) Information
 
 
 
 
 
 
 
 ├
[V] fhs:BD  FHS Layer 2 Bridge Domain (bd) information
 
 
 
 
 
 
 
 
 ├
[V] fhs:IpInspect  IP Inspect Policy information
 
 
 
 
 
 
 
 
 
 ├
[V] fhs:IpInspectProto  Inspect Protocol Policy information
[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] fhs:Entity  Holds FHS control plane entity information
 
 
 ├
[V] fhs:Inst  This objects hold per fhs instance information. There is only one instance of fhs running in the system today
 
 
 
 ├
[V] fhs:Dom  FHS Enabled Domain (vrf) Information
 
 
 
 
 ├
[V] fhs:BD  FHS Layer 2 Bridge Domain (bd) information
 
 
 
 
 
 ├
[V] fhs:IpInspect  IP Inspect Policy information
 
 
 
 
 
 
 ├
[V] fhs:IpInspectProto  Inspect Protocol Policy information


Contained Hierarchy
[V] fhs:IpInspectProto  Inspect Protocol Policy information
 ├
[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: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] tag:Annotation 
 
 ├
[V] tag:Tag 
 ├
[V] fhs:BtEntryArp  EP binding entry learnt from ARP
 ├
[V] fhs:BtEntryData  EP binding entry learnt from data packets
 ├
[V] fhs:BtEntryDhcp  EP binding entry learnt from DHCP
 ├
[V] fhs:BtEntryLocal  Binding entry learnt from switch local addresses
 ├
[V] fhs:BtEntryNd  EP binding entry learnt from ND
 ├
[V] fhs:BtEntryStatic  EP binding entry learnt from static configuration
 ├
[V] health:Inst A base class for a health score instance.(Switch only)


Inheritance
[V] fhs:IpInspectProto  Inspect Protocol Policy information


Events
                fhs:IpInspectProto:fhs_IpInspectProto_operStChange


Faults
                fhs:IpInspectProto:operStDown


Fsms
                


Properties Summary
Defined in: fhs:IpInspectProto
fhs:IpInspectProtoCtrl
          scalar:Bitmask16
ctrl  (fhs:IpInspectProto:ctrl)
           The control state.
reference:BinRef monPolDn  (fhs:IpInspectProto:monPolDn)
           The monitoring policy attached to this observable object.
fhs:OperSt
          scalar:Enum8
operSt  (fhs:IpInspectProto:operSt)
           The runtime state of the object or policy.
fhs:IpInspectProtoOperStQual
          scalar:Enum8
operStQual  (fhs:IpInspectProto:operStQual)
           The chassis operational status qualifier.
fhs:IpInspectProtoType
          scalar:Enum8
type  (fhs:IpInspectProto:type)
           The specific type of the object or component.
Defined in: mo:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
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.
Properties Detail

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





ctrl

Type: fhs:IpInspectProtoCtrl
Primitive Type: scalar:Bitmask16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The control state.
Constants
src-mac 1 Source Mac Validation Enabled Enable ethernet source mac and protocol sender mac validations
dst-mac 2 Destination Mac Validation Enabled Enable ethernet dest mac and protocol target mac validations
ip 4 Sender and Target IP Validation Enabled Enable sender and target ip validations
DEFAULT 0 --- Ip Inspect Protocol Controls





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.



operSt

Type: fhs:OperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The runtime state of the object or policy.
Constants
down 0 Down The state is down
up 1 Up The state is up
DEFAULT down(0) Down The state is down





operStQual

Type: fhs:IpInspectProtoOperStQual
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The chassis operational status qualifier.
Constants
up 0 Up Up
bd-vlan-down 1 BD Vlan Down BD Vlan Down
cfg-error 2 Configuration Error Protocol config error
inv-proto 3 Invalid Protocol Invalid Protocol Type
v4-cfg-missing 4 IPv4 Configuration Missing v4 config missing
v6-cfg-missing 5 IPv6 Configuration Missing v6 config missing
cfg-not-supported 6 Configuration Not Supported Protocol config not supported
DEFAULT up(0) Up Up





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.






type

Type: fhs:IpInspectProtoType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
The specific type of the object or component.
Constants
arp 0 Arp Arp
nd 1 ND ND
dhcp 2 DHCP Dhcp
local 3 Local Local
static 4 Static Static
data 5 Data Data
DEFAULT arp(0) Arp Arp