Class vz:ABrCP (ABSTRACT)

Class ID:1299
Class Label: Abstracton of Binary Contract Profile
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled
Write Access: [admin]
Read Access: [admin, tenant-security]
Creatable/Deletable: yes (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 ]

An abstraction of a binary contract profile.

Naming Rules


DN FORMAT: 

[1] uni/tn-{name}/

                


Diagram

Super Mo: vz:ACtrct,
Sub Mos: vz:BrCP, vz:OOBBrCP,
Container Mos: fv:Tenant (deletable:yes),
Contained Mos: vz:DirAssDef, vz:GraphCont, vz:InheritedDef, vz:Subj, vz:TrigCollectionCont,
Relations From: vz:CPIf,
Relations: vz:RtIf,


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] vz:ACollection The abstraction of a contract collection. A collection can be a single contract, a collection of all contracts associated with a bundle, or a collection of all contracts associated with a group.
 
 
 
 ├
[V] vz:ACtrct An abstraction of a resolvable contract.
 
 
 
 
 ├
[V] vz:ABrCP An abstraction of a binary contract profile.
 
 
 
 
 
 ├
[V] vz:BrCP A contract is a logical container for the subjects which relate to the filters that govern the rules for communication between endpoint groups (EPGs). Without a contract, the default forwarding policy is to not allow any communication between EPGs but all communication within an EPG is allowed.
 
 
 
 
 
 ├
[V] vz:OOBBrCP An out-of-band binary contract profile can only be provided by an out-of-band endpoint group and can only be consumed by the external prefix set. A regular endpoint group cannot provide or consume an out-of-band contract profile.


Events
                


Faults
                vz:ABrCP:configurationFailed


Fsms
                


Properties Summary
Defined in: vz:ABrCP
qos:TenantPrio
          scalar:Enum8
prio  (vz:ABrCP:prio)
           null
qosp:Dscp
          scalar:UByte
targetDscp  (vz:ABrCP:targetDscp)
           The target differentiated services code point (DSCP) of the path attached to the layer 3 outside profile.
Defined in: vz:ACtrct
vz:Scope
          scalar:Enum8
scope  (vz:ACtrct:scope)
           Represents the scope of this contract. If the scope is set as application-profile, the epg can only communicate with epgs in the same application-profile
Defined in: vz:ACollection
vz:ConfigIssues
          scalar:Bitmask64
configIssues  (vz:ACollection:configIssues)
           Bitmask representation of the configuration issues found during the endpoint group deployment.
scalar:Bool reevaluateAll  (vz:ACollection:reevaluateAll)
          
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





configIssues

Type: vz:ConfigIssues
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Bitmask representation of the configuration issues found during the endpoint group deployment.
Constants
none 0ull none NO COMMENTS
filter-not-present 1ull Filter Not Present NO COMMENTS
taboo-has-no-filter 2ull Taboo Not associated to Any Filter NO COMMENTS
subject-not-in-use-due-to-label 4ull No EPG Has Label For This Subject NO COMMENTS
any-to-prov-shared-service 8ull Private Network Cannot be a Provider for a Contract that is Imported in Another Tenant NO COMMENTS
DEFAULT none(0ull) none NO COMMENTS





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.



prio

Type: qos:TenantPrio
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (byte)0  max: (byte)3
    Comments:
null
Constants
unspecified 0 Unspecified NO COMMENTS
level3 1 Level3 User configurable classes
level2 2 Level2 NO COMMENTS
level1 3 Level1 NO COMMENTS
DEFAULT unspecified(0) Unspecified NO COMMENTS





reevaluateAll

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





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: vz:Scope
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Represents the scope of this contract. If the scope is set as application-profile, the epg can only communicate with epgs in the same application-profile
Constants
application-profile 1 Application Profile NO COMMENTS
tenant 2 Tenant NO COMMENTS
context 3 VRF NO COMMENTS
global 4 Global NO COMMENTS
DEFAULT context(3) VRF NO COMMENTS





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.






targetDscp

Type: qosp:Dscp
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (short)0  max: (short)64
    Comments:
The target differentiated services code point (DSCP) of the path attached to the layer 3 outside profile.
Constants
CS0 0 CS0 CS0
CS1 8 CS1 CS1
AF11 10 AF11 low drop AF11 low drop
AF12 12 AF12 medium drop AF12 medium drop
AF13 14 AF13 high drop AF13 high drop
CS2 16 CS2 CS2
AF21 18 AF21 low drop AF21 low drop
AF22 20 AF22 medium drop AF22 medium drop
AF23 22 AF23 high drop AF22 high drop
CS3 24 CS3 CS3
AF31 26 AF31 low drop AF31 low drop
AF32 28 AF32 medium drop AF32 medium drop
AF33 30 AF33 high drop AF33 high drop
CS4 32 CS4 CS4
AF41 34 AF41 low drop AF41 low drop
AF42 36 AF42 medium drop AF42 medium drop
AF43 38 AF43 high drop AF42 high drop
CS5 40 CS5 CS5
VA 44 Voice Admit VA
EF 46 Expedited Forwarding EF
CS6 48 CS6 CS6
CS7 56 CS7 CS7
unspecified 64 Unspecified Unspecified
DEFAULT unspecified(64) Unspecified Unspecified