Class nw:ProtInst (ABSTRACT)

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

A protocol instance abstraction.

Naming Rules


DN FORMAT: 

                


Diagram

Super Mo: nw:CpInst,
Sub Mos: l1:ProtInst, l2:ProtInst, l3:ProtInst,


Inheritance
[V] nw:Item Ignore.
 ├
[V] nw:Conn A connection abstraction.
 
 ├
[V] nw:GEp A group endpoint abstraction.
 
 
 ├
[V] nw:CpInst A control plane instance abstraction. This object represents an instance of the protocol. For example, the protocol instance of OSPF or ISIS.
 
 
 
 ├
[V] nw:ProtInst A protocol instance abstraction.
 
 
 
 
 ├
[V] l1:ProtInst A protocol instance abstraction.
 
 
 
 
 
 ├
[V] veth:Inst  This object represents whether the NIV feature is enabled/disabled on the node
 
 
 
 
 ├
[V] l2:ProtInst A protocol instance abstraction.
 
 
 
 
 
 ├
[V] cdp:Inst The object that represents the CDP instance information. Currently only one CDP instance is supported.
 
 
 
 
 
 ├
[V] dot1x:Inst  This objects hold per dot1x instance information. There is only one instance of dot1x running in the system today
 
 
 
 
 
 ├
[V] lacp:Inst The LACP instance information. Only one LACP instance is currently supported.
 
 
 
 
 
 ├
[V] lldp:Inst Link Layer Discovery Protocol (LLDP) supports a set of attributes that it uses to discover neighbor devices. These attributes contain type, length, and value descriptions and are referred to as TLVs. LLDP supported devices can use TLVs to receive and send information to their neighbors. Details such as configuration information, device capabilities, and device identity can be advertised using this protocol.
 
 
 
 
 
 ├
[V] macsec:Inst  This objects hold per macsec instance information. There is only one instance of macsec running in the system today
 
 
 
 
 
 ├
[V] mcp:Inst The MisCabling Protocol (MCP) instance information. In the current implementation, only one instance of MCP is running in the system.
 
 
 
 
 
 ├
[V] poe:Inst  This objects hold per Power over Ethernet instance information. There is only one instance of Power over Ethernet running in the system today
 
 
 
 
 
 ├
[V] stp:Inst A container for per spanning-tree protocol (STP) instance information. There is only one instance of STP running in the system.
 
 
 
 
 
 ├
[V] udld:Inst  This objects hold per udld instance information. There is only one instance of udld running in the system today
 
 
 
 
 ├
[V] l3:ProtInst A layer 3 protocol instance abstraction.
 
 
 
 
 
 ├
[V] arp:Inst Represents per-ARP instance information. In the current implementation, only one instance of ARP is running in the system.
 
 
 
 
 
 ├
[V] bfd:Inst  This objects hold per bfd instance information.
 
 
 
 
 
 ├
[V] bgp:Inst The per BGP instance information. There is only instance supported in BGP.
 
 
 
 
 
 ├
[V] cloudsec:Inst  This objects hold per cloudsec instance information. There is only one instance of cloudsec running in the system today
 
 
 
 
 
 ├
[V] coop:Inst The per-COOP instance information. There is only one instance of this object present in the system.
 
 
 
 
 
 ├
[V] dhcp:Inst The DHCP instance information. There is only one instance of DHCP relay currently running in the system.
 
 
 
 
 
 ├
[V] eigrp:Inst The EIGRP instance information.
 
 
 
 
 
 ├
[V] fabrgm:Inst  This objects hold per fabrgm instance information. There is only one instance of fabrgm running in the system today
 
 
 
 
 
 ├
[V] fhs:Inst  This objects hold per fhs instance information. There is only one instance of fhs running in the system today
 
 
 
 
 
 ├
[V] hcbgp:Inst  This objects hold per bgp instance information. There is only instance supported in bgp
 
 
 
 
 
 ├
[V] hcipsec:Inst 
 
 
 
 
 
 ├
[V] hcisakmp:Inst 
 
 
 
 
 
 ├
[V] hcospf:AInst  This objects hold per ospf instance information
 
 
 
 
 
 
 ├
[V] hcospf:Inst  This objects hold per ospf instance information
 
 
 
 
 
 ├
[V] hcurib:Inst  This objects hold per urib instance information. There is only one instance supported in urib
 
 
 
 
 
 ├
[V] hsrp:Inst  This objects holds HSRP instance information. There is
 
 
 
 
 
 ├
[V] icmp:Inst The per ICMP instance information. There is only one instance currently running in the system.
 
 
 
 
 
 
 ├
[V] icmpv4:Inst Per Internet Control Message Protocol (ICMPv4) instance information. There is only one instance of icmpv4 currently running in the system.
 
 
 
 
 
 
 ├
[V] icmpv6:Inst Per Internet Control Message Protocol (ICMPv6) instance information. There is only one instance currently running in the system.
 
 
 
 
 
 ├
[V] ip:Inst Per IP instance information. There is only one instance of IP currently running in the system.
 
 
 
 
 
 ├
[V] ipmc:AInst  This objects hold per IPMC instance information
 
 
 
 
 
 
 ├
[V] igmp:Inst  This objects hold per igmp instance information. There is only one instance of igmp running in the system today
 
 
 
 
 
 
 ├
[V] mld:Inst  This objects hold per mld instance information. There is only one instance of mld running in the system today
 
 
 
 
 
 ├
[V] ipmcsnoop:Inst  This objects hold per IPMC snooping instance information. There is only one instance of IPMC snooping running in the system today
 
 
 
 
 
 
 ├
[V] igmpsnoop:Inst Holds per IGMP instance information. There is only one instance of IGMP running in the system today.
 
 
 
 
 
 
 ├
[V] mldsnoop:Inst  This objects hold per mld instance information. There is only one instance of mld running in the system today
 
 
 
 
 
 ├
[V] ipsec:Inst  This objects holds IPSEC instance information. There is only one instance of IPSEC supported currently
 
 
 
 
 
 ├
[V] ipv4:Inst A container for IPV4 instance information.
 
 
 
 
 
 ├
[V] ipv6:Inst The IPv6 information. In the current implementation, only one instance of IPv6 is running in the system.
 
 
 
 
 
 ├
[V] isis:Inst Per- IS-IS instance information.
 
 
 
 
 
 ├
[V] mrib:Inst  These objects hold per routed multicast instance information
 
 
 
 
 
 ├
[V] nd:Inst The per neighbor discovery instance information. In the current implementation, only one instance of ND is running in the system.
 
 
 
 
 
 ├
[V] ospf:AInst An abstraction of an OSPF instance.
 
 
 
 
 
 
 ├
[V] ospf:Inst The per OSPF instance information.
 
 
 
 
 
 
 ├
[V] ospfv3:Inst The per OSPF instance information.
 
 
 
 
 
 ├
[V] ptp:Inst  This object holds PTP instance information.
 
 
 
 
 
 ├
[V] rtdmc:AInst  This objects hold per routed multicast instance information
 
 
 
 
 
 
 ├
[V] pim6:Inst  This objects hold per pim instance information
 
 
 
 
 
 
 ├
[V] pim:Inst PIM instance information.
 
 
 
 
 
 ├
[V] sla:Inst  This objects hold per IP SLA instance information. There is only one instance of IP SLA running in the system today
 
 
 
 
 
 ├
[V] track:Inst  This objects holds OTM instance information.
 
 
 
 
 
 ├
[V] twamp:ResponderInst  This object holds TWAMP Responder Configuration
 
 
 
 
 
 ├
[V] twamp:ServerInst  This object holds TWAMP Server Configuration


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: nw:CpInst
nw:AdminSt
          scalar:Enum8
adminSt  (nw:CpInst:adminSt)
           The administrative state of the object or policy.
nw:InstCtrl
          scalar:Bitmask64
ctrl  (nw:CpInst:ctrl)
           The control state.
naming:Name
          string:Basic
name  (nw:CpInst:name)
           Overrides:nw:Conn:name
           The name of the object.
nw:OperErrQual
          scalar:Bitmask64
operErr  (nw:CpInst:operErr)
          
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

adminSt

Type: nw:AdminSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The administrative state of the object or policy.
Constants
enabled 1 Enabled Enabled
disabled 2 Disabled Disabled
DEFAULT enabled(1) Enabled Enabled





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: nw:InstCtrl
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The control state.
Constants
stateful-ha 1ull stateful-ha Enable stateful HA
DEFAULT 0 --- Instance 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.



name

Type: naming:Name
Primitive Type: string:Basic

Overrides:nw:Conn:name
Units: null Encrypted: false Access: create Category: TopLevelRegular
    Comments:
The name of the object.



operErr

Type: nw:OperErrQual
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Constants
sock-err 16ull Socket error Socket errors
init-err 1ull Initialization error Initialization errors
mem-err 2ull Memory error Memory errors
proto-err 32ull Protocol error Protocol errors
ipc-err 4ull IPC error IPC errors
feature-unsupported 64ull Feature Unsupported Feature Unsupported
int-err 8ull Internal error Internal errors
DEFAULT 0 --- Operational error qualifier





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.