Cisco System Model: Classl3ext:Exception

Overview

Naming

Diagram

Containers

Contained

Inheritance

Events

Faults

FSMs

Properties Summary

Properties Detail

Class l3ext:Exception (CONCRETE)

Class ID:1803
Class Label: Subnet Exception
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Concrete Model
Write Access: [admin, tenant-ext-connectivity-l3]
Read Access: [admin, tenant-ext-connectivity-l3]
Creatable/Deletable: derived (see Container Mos for details)
Semantic Scope: None
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: false, HasHealth: true, HasEventRules: false ]

The exception from the external subnet.

Naming Rules
RN FORMAT: excp-{[ip]} [1] PREFIX=excp- PROPERTY = ip DN FORMAT:

Diagram
Super Mo: l3ext:AInstPSubnet, Contained Mos: tag:Annotation, tag:Tag, Relations To: rtctrl:Profile, Relations: l3ext:RsSubnetToProfile,

Containers Hierarchies

Contained Hierarchy

l3ext:Exception The exception from the external subnet.

├

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)

├

l3ext:RsSubnetToProfile The source relation to the route control profile.

├

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: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.

├

tag:Annotation

├

tag:Tag

├

health:Inst A base class for a health score instance.(Switch only)

├

tag:Annotation

├

tag:Tag

├

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:Comp Represents a policy component. This object is part of the policy definition.

├

fabric:ProtoComp A base class for protocol policies.

├

fabric:L3ProtoComp A base class for layer 3 protocol policies.

├

rtctrl:ASubnet The abstraction of the external subnet.

├

extnw:AInstPSubnet An abstraction of the instance profile subnet.

├

l3ext:AInstPSubnet An abstract logical node profile. This defines the characteristics to be applied to resources that match with the profile name.

├

l3ext:Exception The exception from the external subnet.

Events
l3ext:Exception:creation__l3ext_Exception l3ext:Exception:modification__l3ext_Exception l3ext:Exception:deletion__l3ext_Exception

Faults

Fsms

Properties Summary

Defined in: l3ext:Exception
mo:Annotation string:Basic	annotation (l3ext:Exception:annotation) NO COMMENTS
mo:ExtMngdByType scalar:Bitmask32	extMngdBy (l3ext:Exception:extMngdBy) NO COMMENTS
address:Ip	ip (l3ext:Exception:ip) Overrides:rtctrl:ASubnet:ip null

Defined in: l3ext:AInstPSubnet
l3ext:RouteAggType scalar:Bitmask8	aggregate (l3ext:AInstPSubnet:aggregate) Aggregate Routes for Subnet
l3ext:RouteScp scalar:Bitmask8	scope (l3ext:AInstPSubnet:scope) The domain applicable to the capability.

Defined in: pol:Comp
naming:Descr string:Basic	descr (pol:Comp:descr) Specifies the description of a policy component.

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:Modifiable
mo:TStamp scalar:Date	modTs (mo:Modifiable:modTs) The time when this object was last modified.

Defined in: mo:Ownable
scalar:Uint16	uid (mo:Ownable:uid) A unique identifier for this object.

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

aggregate

Type: l3ext:RouteAggType
Primitive Type: scalar:Bitmask8

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

Comments:

Aggregate Routes for Subnet

Constants
import-rtctrl	1	Aggregate Import	Aggregate Import Routes
export-rtctrl	2	Aggregate Export	Aggregate Export Routes
shared-rtctrl	4	Aggregate Shared	Aggregate Shared Routes
defaultValue	0	---	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

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 the description of a policy component.

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.

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

ip

Type: address:Ip

Overrides:rtctrl:ASubnet:ip

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:

Comments:

null

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

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

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.

scope

Type: l3ext:RouteScp
Primitive Type: scalar:Bitmask8

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

Comments:

The domain applicable to the capability.

Constants
import-rtctrl	1	Import Route Control Subnet	Route is for Import Route Control Policy
export-rtctrl	2	Export Route Control Subnet	Route is for Export Route Control Policy
import-security	4	External Subnets for the External EPG	Route is for Import Security Policy
shared-security	8	Shared Security Import Subnet	Route is for applying security on it in the Ctx/VRF into which it is shared
shared-rtctrl	16	Shared Route Control Subnet	Route is for leaking into consumers Ctx/VRF in case of Shared Service
DEFAULT	import-security(4)	External Subnets for the External EPG	Route is for Import Security Policy

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.

uid

Type: scalar:Uint16

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

Comments:

A unique identifier for this object.

Overview

Naming

Diagram

Containers

Contained

Inheritance

Events

Faults

FSMs

Properties Summary

Properties Detail