Class fabric:ProtoInstPol (ABSTRACT)

Class ID:701
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: Disabled
Write Access: []
Read Access: [admin]
Creatable/Deletable: derived (see Container Mos for details)
Possible Semantic Scopes: EPG, Infra, Fabric,
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

A base class for instance-level protocol policies.

Naming Rules


DN FORMAT: 

                


Diagram

Super Mo: fabric:ProtoPol,
Sub Mos: dns:AProfile, dnsepg:ADomain, dnsepg:ZoneDB, dnsepg:ZoneEntry, fabric:L2InstPol, fabric:L3InstPol, fabric:UtilInstPol, fabric:VxlanInstPol, twamp:ResponderPol, twamp:ServerPol,


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] fabric:ProtoPol A base class for protocol policies.
 
 
 
 ├
[V] fabric:ProtoInstPol A base class for instance-level protocol policies.
 
 
 
 
 ├
[V] dns:AProfile The DNS Profile.
 
 
 
 
 
 ├
[V] dns:Prof The DNS instance information.
 
 
 
 
 
 ├
[V] dns:Profile The DNS profile defines a set of DNS providers and can be deployed to a switch for tenant contexts. To deploy a DNS profile on a switch, the appropriate label has to be defined for the context deployed on switch.
 
 
 
 
 ├
[V] dnsepg:ADomain  DNS Abstract Domain
 
 
 
 
 
 ├
[V] dnsepg:Domain  DNS Domain
 
 
 
 
 ├
[V] dnsepg:ZoneDB  DNS Zone DB
 
 
 
 
 ├
[V] dnsepg:ZoneEntry  DNS Zone Entry
 
 
 
 
 ├
[V] fabric:L2InstPol A base class for layer 2 interface-level policies.
 
 
 
 
 
 ├
[V] cdp:InstPol Specifies the node-level CDP policy.
 
 
 
 
 
 ├
[V] edr:ErrDisRecoverPol The error disabled recovery policy specifies the policy for re-enabling a port that was disabled due to one or more pre-defined error conditions.
 
 
 
 
 
 ├
[V] ep:ControlP  Endpoint Control Policy
 
 
 
 
 
 ├
[V] ep:IpAgingP 
 
 
 
 
 
 ├
[V] ep:LoopProtectP The endpoint loop protection policy specifies how loops detected by frequent mac moves are handled.
 
 
 
 
 
 ├
[V] fc:FabricPol 
 
 
 
 
 
 ├
[V] fc:InstPol 
 
 
 
 
 
 ├
[V] l2:AInstPol A fabric-wide L2 policy.
 
 
 
 
 
 
 ├
[V] l2:InstPol The Layer 2 instance policy is used for configuring fabric-wide layer 2 settings. Currently, this policy contains only fabric MTU and management MTU configuration.
 
 
 
 
 
 
 ├
[V] l2:InstPolDef A read-only copy of the fabric MTU policy.
 
 
 
 
 
 ├
[V] l2:NodeAuthPol 
 
 
 
 
 
 ├
[V] lldp:InstPol The node level LLDP policy.
 
 
 
 
 
 ├
[V] mcp:InstPol 
 
 
 
 
 
 ├
[V] poe:InstPol  Node level poe policy
 
 
 
 
 
 ├
[V] span:ADest The abstraction of an SPAN destination. The SPAN destination is where network traffic is sent for analysis by a network analyzer. A SPAN destination can be local or remote (ERSPAN). When you create a traffic monitoring session, you must select a SPAN source and a SPAN destination. The type of session (Tenant, Access, or Fabric) determines the allowed types of SPAN sources and destinations. The destination can be either a port or an endpoint group...
 
 
 
 
 
 
 ├
[V] span:AVDest The abstraction of a VSPAN destination. The VSPAN destination is where network traffic is sent for analysis by a network analyzer. A VSPAN destination can be local or remote (VERSPAN). When you create a traffic monitoring session, you must select a VSPAN source and a VSPAN destination. The type of session (Tenant, Access, or Fabric) determines the allowed types of VSPAN sources and destinations. The destination can be either a port or an endpoint...
 
 
 
 
 
 
 
 ├
[V] span:VDest The VSPAN destination is where network traffic is sent for analysis by a network analyzer. A VSPAN destination can be local or remote (VERSPAN). When you create a traffic monitoring session, you must select a VSPAN source and a VSPAN destination. The type of session (tenant, access, or fabric) determines the allowed types of VSPAN sources and destinations. The destination can be either a port or an endpoint group. If the destination is a port, it...
 
 
 
 
 
 
 
 ├
[V] span:VDestDef The VLAN-based SPAN (VSPAN) destination definition.
 
 
 
 
 
 
 ├
[V] span:Dest The SPAN destination is where network traffic is sent for analysis by a network analyzer. A SPAN destination can be local or remote (ERSPAN). When you create a traffic monitoring session, you must select a SPAN source and a SPAN destination. The type of session (Tenant, Access, or Fabric) determines the allowed types of SPAN sources and destinations. The destination can be either a port or an endpoint group. If the destination is a port, it shoul...
 
 
 
 
 
 ├
[V] span:ASrcGrp The abstraction of a SPAN source group. The SPAN source group can contain a group of SPAN sources, which is where network traffic is sampled. A SPAN source can be an endpoint group (EPG), one or more ports, or port traffic filtered by an EPG (Access SPAN), a Layer 2 bridge domain, or a Layer 3 context (Fabric SPAN). When you create a traffic monitoring session, you must select a SPAN source group and a SPAN destination. The type of session (Tenan...
 
 
 
 
 
 
 ├
[V] span:SrcGrp The SPAN source group can contain a group of SPAN sources. A SPAN source is where network traffic is sampled. A SPAN source can be an endpoint group (EPG), one or more ports, or port traffic filtered by an EPG (access SPAN), a Layer 2 bridge domain, or a Layer 3 context (Fabric SPAN). When you create a traffic monitoring session, you must select a SPAN source group and a SPAN destination. The type of session (Tenant, Access, or Fabric) determines...
 
 
 
 
 
 
 ├
[V] span:SrcGrpDef The SPAN source group definitions. The SPAN source is where traffic is sampled. A SPAN source can be an endpoint group (EPG), one or more ports, or port traffic filtered by an EPG (access SPAN), a Layer 2 bridge domain, or a Layer 3 context (fabric SPAN). When you create a traffic monitoring session, you must select a SPAN source and a SPAN destination. The type of session (Tenant, Access or fabric) determines the allowed types of SPAN sources an...
 
 
 
 
 
 ├
[V] span:AVDestGrp The abstraction of a VSPAN destination group. The VSPAN destination group can contain a group of VSPAN destinations. A VSPAN destination is where network traffic is sent for analysis by a network analyzer. A VSPAN destination can be local or remote (VERSPAN). When you create a traffic monitoring session, you must select a VSPAN source and a VSPAN destination. The type of session (Tenant, Access, or Fabric) determines the allowed types of VSPAN so...
 
 
 
 
 
 
 ├
[V] span:VDestGrp The VSPAN destination group contains a group of VSPAN destinations. A VSPAN destination is where network traffic is sent for analysis by a network analyzer. A VSPAN destination can be local or remote (VERSPAN). When you create a traffic monitoring session, you must select a VSPAN source and a VSPAN destination. The type of session (tenant, access, or fabric) determines the allowed types of VSPAN sources and destinations. The destination can be ei...
 
 
 
 
 
 
 ├
[V] span:VDestGrpDef VSPAN destination group used for configuring VSPAN source group definitions.
 
 
 
 
 
 ├
[V] span:AVSrcGrp The abstraction of a VSPAN source group. The VSPAN source group can contain a group of VSPAN sources. A VSPAN source is where network traffic is sampled. A VSPAN source can be an endpoint group (EPG), one or more ports, or port traffic filtered by an EPG (Access VSPAN), a Layer 2 bridge domain, or a Layer 3 context (Fabric VSPAN). When you create a traffic monitoring session, you must select a VSPAN source group and a VSPAN destination. The type ...
 
 
 
 
 
 
 ├
[V] span:VSrcGrp The VSPAN source group can contain a group of VSPAN sources. A VSPAN source is where network traffic is sampled. A VSPAN source can be an endpoint group (EPG), one or more ports; or port traffic filtered by an EPG (access VSPAN), a Layer 2 bridge domain, or a Layer 3 context (fabric VSPAN). When you create a traffic monitoring session, you must select a VSPAN source group and a VSPAN destination. The type of session (tenant, access, or fabric) de...
 
 
 
 
 
 
 ├
[V] span:VSrcGrpDef The VSPAN source group definition.
 
 
 
 
 
 ├
[V] span:DestGrp The SPAN destination group contains a group of SPAN destinations. A SPAN destination is where network traffic is sent for analysis by a network analyzer. A SPAN destination can be local or remote (ERSPAN). When you create a traffic monitoring session, you must select a SPAN source and a SPAN destination. The type of session (Tenant, Access, or Fabric) determines the allowed types of SPAN sources and destinations. The destination can be either a p...
 
 
 
 
 
 ├
[V] span:SpanProv The SPAN destination provider is used for configuring SPAN destination provider parameters.
 
 
 
 
 
 ├
[V] span:SrcTargetShadow The SPAN source to EPG information.
 
 
 
 
 
 ├
[V] span:SrcTargetShadowBD The SPAN source to bridge domain (BD) information.
 
 
 
 
 
 ├
[V] span:SrcTargetShadowCtx The SPAN source to Ctx information.
 
 
 
 
 
 ├
[V] span:SrcTargetShadowL3If  Holds span src to l3 itnerface related information
 
 
 
 
 
 ├
[V] span:TaskParam The SPAN source to EPG task information.
 
 
 
 
 
 ├
[V] span:VSpanProv The VSPAN destination provider is used for configuring VSPAN destination provider parameters.
 
 
 
 
 
 ├
[V] stp:InstPol The spanning Tree Protocol (STP) instance policy, which enables you to set the bridge protocol data unit (BPDU) guard policy or filter. BDPUs are packets that run the STP protocol. The specification for STP is IEEE 802.1D. The main purpose of STP is to ensure that you do not create loops when you have redundant paths in your network. Loops are deadly to a network.
 
 
 
 
 
 ├
[V] vpc:InstPol The node-level vPC domain policy, which is used to specify a vPC domain and is applied to both vPC peer devices, the vPC peer keepalive link, the vPC peer link, and all the PortChannels in the vPC domain connected to the downstream device. You can have only one vPC domain ID on each device.
 
 
 
 
 ├
[V] fabric:L3InstPol A base class for layer 3 instance-level policies.
 
 
 
 
 
 ├
[V] bfd:AInstPol  Global BFD policy
 
 
 
 
 
 
 ├
[V] bfd:Ipv4InstPol 
 
 
 
 
 
 
 ├
[V] bfd:Ipv6InstPol 
 
 
 
 
 
 ├
[V] bfd:AMhInstPol  Global MH BFD policy
 
 
 
 
 
 
 ├
[V] bfd:MhIpv4InstPol 
 
 
 
 
 
 
 ├
[V] bfd:MhIpv6InstPol 
 
 
 
 
 
 ├
[V] bgp:InstPol The BGP Instance level policy is used to configure MP-BGP policies inside the fabric.
 
 
 
 
 
 ├
[V] dhcp:ARelayP The abstract DHCP Relay profile, which is used for configuring relay parameters per bridge domain (BD).
 
 
 
 
 
 
 ├
[V] dhcp:RelayP The DHCP relay profile, with one or more helper addresses in it, configures a DHCP relay agent for forwarding DHCP packets to a remote server.
 
 
 
 
 
 ├
[V] mpls:ALabelPol  Mpls Global configuration
 
 
 
 
 
 
 ├
[V] mpls:LabelPol 
 
 
 
 
 
 
 ├
[V] mpls:LabelPolDef 
 
 
 
 
 
 ├
[V] mpls:ASrgbLabelPol  Mpls SRGB Global configuration
 
 
 
 
 
 
 ├
[V] mpls:SrgbLabelPol 
 
 
 
 
 
 
 ├
[V] mpls:SrgbLabelPolDef 
 
 
 
 
 ├
[V] fabric:UtilInstPol A base class for policies.
 
 
 
 
 
 ├
[V] psu:InstPol The power redundancy policy is for all power supply units on the fabric nodes (leaves and spines) that are consuming the power supply policy through their respective selector profile policy.
 
 
 
 
 
 ├
[V] wwn:InstPol WWN Instance policy
 
 
 
 
 ├
[V] fabric:VxlanInstPol 
 
 
 
 
 
 ├
[V] l4:AVxlanInstPol 
 
 
 
 
 
 
 ├
[V] l4:VxlanInstPol 
 
 
 
 
 
 
 ├
[V] l4:VxlanInstPolDef 
 
 
 
 
 ├
[V] twamp:ResponderPol TWAMP Responder Policy.
 
 
 
 
 ├
[V] twamp:ServerPol  Node level TWAMP policy


Events
                


Faults
                


Fsms
                


Properties Summary
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: pol:Obj
naming:Name
          string:Basic
name  (pol:Obj:name)
           Overrides:naming:NamedObject:name
           null
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
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





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.



name

Type: naming:Name
Primitive Type: string:Basic

Overrides:naming:NamedObject:name
Units: null Encrypted: false Access: admin Category: TopLevelRegular Property Validators: Range: min: "0" max: "64" Allowed Chars: Regex: [a-zA-Z0-9_.:-]+
    Comments:
null



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.