Class dbgac:TenantSpaceCmn (ABSTRACT)

Class ID:4008
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: Disabled
Write Access: [admin, tenant-connectivity]
Read Access: [admin, nw-svc-policy, tenant-connectivity, tenant-epg, tenant-ext-connectivity, tenant-ext-protocol, tenant-network-profile, tenant-qos, tenant-security]
Creatable/Deletable: derived (see Container Mos for details)
Semantic Scope: EPG
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

Tenant Space common policy definition.

Naming Rules


DN FORMAT: 

                


Diagram

Super Mo: pol:Def,
Sub Mos: dbgac:EpgCmn, dbgac:FromEpCmn, dbgac:IpToIp, dbgac:TenantSpaceCmnDef, dbgac:ToEpCmn,
Contained Mos: dbgac:CEpSummary, dbgac:Filter, dbgac:FromEpSummary, dbgac:FromEpgSummary, dbgac:L3OutCont, dbgac:ToEpSummary, dbgac:ToEpgSummary,
Relations To: fv:Ctx,
Relations: dbgac:RsAcExtPolToContext,


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] dbgac:TenantSpaceCmn Tenant Space common policy definition.
 
 
 
 ├
[V] dbgac:EpgCmn The endpoint group common.
 
 
 
 
 ├
[V] dbgac:FromEpgCmn The abstract object with the Source Endpoint Group.
 
 
 
 
 
 ├
[V] dbgac:EpgToEp The endpoint group-to-endpoint atomic counter policy detects drops and misrouting in the fabric to enable quick debugging and isolation of application connectivity issues.
 
 
 
 
 
 ├
[V] dbgac:EpgToEpg The endpoint group-to-endpoint group atomic counter policy detects drops and misrouting in the fabric to enable quick debugging and isolation of application connectivity issues.
 
 
 
 
 
 ├
[V] dbgac:EpgToIp The endpoint group-to-IP atomic counter policy detects drops and misrouting in the fabric to enable quick debugging and isolation of application connectivity issues
 
 
 
 
 ├
[V] dbgac:ToEpgCmn The abstract object with a destination endpoint group.
 
 
 
 
 
 ├
[V] dbgac:EpToEpg The endpoint-to-endpoint group atomic counter policy detects drops and misrouting in the fabric to enable quick debugging and isolation of application connectivity issues.
 
 
 
 
 
 ├
[V] dbgac:IpToEpg The IP-to-endpoint group atomic counter policy detects drops and misrouting in the fabric and enables quick debugging and isolation of application connectivity issues.
 
 
 
 ├
[V] dbgac:FromEpCmn From endpoint common.
 
 
 
 
 ├
[V] dbgac:EpToAny The endpoint-to-any atomic counter policy which detects drops and misrouting in the fabric to enable quick debugging and isolation of application connectivity issues.
 
 
 
 
 ├
[V] dbgac:EpToEp The endpoint-to-endpoint atomic counter policy detects drops and misrouting in the fabric to enable quick debugging and isolation of application connectivity issues.
 
 
 
 
 ├
[V] dbgac:EpToExt The endpoint-to-external IP address atomic counter policy detects drops and misrouting in the fabric to enable quick debugging and isolation of application connectivity issues.
 
 
 
 ├
[V] dbgac:IpToIp  IP Addr to IP policy Defn. Used for an external host identified by its IP address to another IP address
 
 
 
 ├
[V] dbgac:TenantSpaceCmnDef The tenant space common definition. This atomic counter managed object is used internally for managing Epg/Epp source and destination policies.
 
 
 
 ├
[V] dbgac:ToEpCmn The abstract object for atomic counter with a destination endpoint.
 
 
 
 
 ├
[V] dbgac:AnyToEp Atomic counters detect drops and misrouting in the fabric enables quick debugging and isolation of application connectivity issues.
 
 
 
 
 ├
[V] dbgac:ExtToEp The external host-to-endpoint atomic counter policy detects drops and misrouting in the fabric to enable quick debugging and isolation of application connectivity issues.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: dbgac:TenantSpaceCmn
nw:AdminSt
          scalar:Enum8
adminSt  (dbgac:TenantSpaceCmn:adminSt)
           Administrative state of the policy
base:Encap bdEncap  (dbgac:TenantSpaceCmn:bdEncap)
          
scalar:Bool countOnSpine  (dbgac:TenantSpaceCmn:countOnSpine)
          
base:Encap ctxEncap  (dbgac:TenantSpaceCmn:ctxEncap)
           ignore, not exposed
naming:Name
          string:Basic
ctxName  (dbgac:TenantSpaceCmn:ctxName)
           The L3 context name.
ac:LatencyCollect
          scalar:Enum8
latencyCollect  (dbgac:TenantSpaceCmn:latencyCollect)
           Latency Feature Action
ac:IpRuleUsage
          scalar:Bitmask32
usage  (dbgac:TenantSpaceCmn:usage)
           The usage of the port. This property shows how the port is used.
dbgac:EncapType
          scalar:Enum8
useEncap  (dbgac:TenantSpaceCmn:useEncap)
          
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

adminSt

Type: nw:AdminSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Administrative state of the policy
Constants
enabled 1 Enabled Enabled
disabled 2 Disabled Disabled
DEFAULT enabled(1) Enabled Enabled





bdEncap

Type: base:Encap

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    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





countOnSpine

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





ctxEncap

Type: base:Encap

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
ignore, not exposed



ctxName

Type: naming:Name
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The L3 context name.



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.



latencyCollect

Type: ac:LatencyCollect
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Latency Feature Action
Constants
avg 1 avg Latency Average
histogram 2 histogram Latency Histogram
DEFAULT avg(1) avg Latency Average





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.






usage

Type: ac:IpRuleUsage
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The usage of the port. This property shows how the port is used.
Constants
atomic-counter 1u Atomic Counter Enable Atomic Counters
latency-stats 2u Latency Statistics Enable Latency Statistics
DEFAULT atomic-counter(1u) Atomic Counter Enable Atomic Counters





useEncap

Type: dbgac:EncapType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
ctx 0 ctx NO COMMENTS
bd 1 bd NO COMMENTS
both 2 both NO COMMENTS
unspecified 3 unspecified NO COMMENTS
DEFAULT ctx(0) ctx NO COMMENTS