Class vz:RsIf (CONCRETE)

Class ID:1309
Class Label: Contract
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Non-Regular MO, like stat/health...
Relationship Type: explicit
Relationship Cardinality: n-to-1
Relationship From: vz:CPIf
Relationship From Rel: vz:RsIf
Relationship To: vz:ACtrct
Relationship To Rel: vz:RtIf
Enforceable: true
Resolvable: true
Write Access: [admin, tenant-security]
Read Access: [admin, tenant-security]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: EPG
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

A source relation to an abstract resolvable contract. Note that this relation is an internal object.

Naming Rules
RN FORMAT: rsif

    [1] PREFIX=rsif


DN FORMAT: 

[1] uni/tn-{name}/cif-{name}/rsif

                


Diagram

Super Mo: vz:InterfaceToCollection,
Container Mos: vz:CPIf (deletable:yes),
Contained Mos: tag:Annotation, tag:Tag, vz:CollectionCont, vz:ConsLbl, vz:ConsSubjLbl,


Containers Hierarchies
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] fabric:Topology The root for IFC topology.
 
 ├
[V] fabric:Pod A pod.
 
 
 ├
[V] fabric:Node The root node for the APIC.
 
 
 
 ├
[V] ctx:Local The local Context.
 
 
 
 
 ├
[V] ctx:Application The context application.
 
 
 
 
 
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 
 
 
 
 
 ├
[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 
 
 
 
 
 
 ├
[V] vz:CPIf A contract interface is used as a contract consumption interface when a consumer consumes the contract by associating it to a consumption interface provided by the provider in the consumer's domain. A consumer can associate with the contract consumption interface when it is provided by the provider in the consumer's domain. Note that a contract consumption interface represents one or more subjects defined under the contract. By associating...
 
 
 
 
 
 
 
 
 ├
[V] vz:RsIf A source relation to an abstract resolvable contract. Note that this relation is an internal object.
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 ├
[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 
 ├
[V] vz:CPIf A contract interface is used as a contract consumption interface when a consumer consumes the contract by associating it to a consumption interface provided by the provider in the consumer's domain. A consumer can associate with the contract consumption interface when it is provided by the provider in the consumer's domain. Note that a contract consumption interface represents one or more subjects defined under the contract. By associating...
 
 
 
 ├
[V] vz:RsIf A source relation to an abstract resolvable contract. Note that this relation is an internal object.


Contained Hierarchy
[V] vz:RsIf A source relation to an abstract resolvable contract. Note that this relation is an internal object.
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 ├
[V] 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.
 
 ├
[V] tag:Annotation 
 
 ├
[V] tag:Tag 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] tag:Annotation 
 ├
[V] tag:Tag 
 ├
[V] vz:CollectionCont A collection container.
 
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 ├
[V] 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.
 
 
 ├
[V] tag:Annotation 
 
 
 ├
[V] tag:Tag 
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] vz:ConsLbl A label used by consumers to filter the providers. The label can be parented as follows: By the consumer endpoint group. By the relation between the consumer endpoint group and contract. By the relation between the contract interface and contract. By the relation between the consumer endpoint group and contract interface. A consumer with no label will consume from all the providers of the contract with no labels. A consumer with a specific label...
 
 ├
[V] 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.
 
 ├
[V] tag:Annotation 
 
 ├
[V] tag:Tag 
 ├
[V] vz:ConsSubjLbl A consumer subject label. In general, a subject label is used as a classification criteria for subjects being consumed/provided by the endpoint groups (EPGs) participating in the contract. The label identifies a subject being consumed by a consumer. It can be parented by 2 different methods. The first method is the relation between the consumer EPG and the contract that is used for filtering the subjects. A label should match either the subject n...
 
 ├
[V] 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.
 
 ├
[V] tag:Annotation 
 
 ├
[V] tag:Tag 


Inheritance
[V] reln:Inst This is generated and used only by internal processes.
 ├
[V] reln:To This is generated and used only by internal processes.
 
 ├
[V] vz:InterfaceToCollection 
 
 
 ├
[V] vz:RsIf A source relation to an abstract resolvable contract. Note that this relation is an internal object.


Events
                vz:RsIf:creation__vz_RsIf
vz:RsIf:modification__vz_RsIf
vz:RsIf:deletion__vz_RsIf


Faults
                vz:RsIf:ResolveFail


Fsms
                


Properties Summary
Defined in: vz:RsIf
mo:Annotation
          string:Basic
annotation  (vz:RsIf:annotation)
           NO COMMENTS
mo:ExtMngdByType
          scalar:Bitmask32
extMngdBy  (vz:RsIf:extMngdBy)
           NO COMMENTS
reference:BinRef monPolDn  (vz:RsIf:monPolDn)
          
qos:TenantPrio
          scalar:Enum8
prio  (vz:RsIf:prio)
           null
reln:ClassId
          scalar:Enum16
tCl  (vz:RsIf:tCl)
           Overrides:reln:Inst:tCl
           null
reln:Dn
          reference:BinRef
tDn  (vz:RsIf:tDn)
           Overrides:reln:Inst:tDn
           The distinguished name of a contract consumption interface. The maximum supported string length is 255 ASCII characters.
Defined in: vz:InterfaceToCollection
scalar:Bool updateCollection  (vz:InterfaceToCollection:updateCollection)
           NO COMMENTS
Defined in: reln:To
scalar:Bool forceResolve  (reln:To:forceResolve)
           Whether the relation should force pull the target.
reln:ResolverType
          scalar:Enum8
rType  (reln:To:rType)
           Represents the type of resolver.
reln:State
          scalar:Enum8
state  (reln:To:state)
           Represents the state of the relationship.
reln:StateQual
          scalar:Enum8
stateQual  (reln:To:stateQual)
           Represents the state qualifier of the relationship.
reln:TargetType
          scalar:Enum8
tType  (reln:To:tType)
           The type of target.
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

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





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





forceResolve

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Whether the relation should force pull the target.
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT yes(true) --- NO COMMENTS





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





monPolDn

Type: reference:BinRef

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



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





rType

Type: reln:ResolverType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Represents the type of resolver.
Constants
mo 1 mo NO COMMENTS
service 2 service NO COMMENTS
local 3 local NO COMMENTS
DEFAULT mo(1) mo 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.



state

Type: reln:State
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Represents the state of the relationship.
Constants
unformed 0 unformed the relationship is not formed
formed 1 formed the relationship is formed with the target object
missing-target 2 missing-target target does not exist
invalid-target 4 invalid-target invalid target DN
cardinality-violation 5 cardinality-violation cardinality violation - When relations are created such that they violate the cardinality, state of the relation would be set to this.
DEFAULT unformed(0) unformed the relationship is not formed





stateQual

Type: reln:StateQual
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Represents the state qualifier of the relationship.
Constants
none 0 none no issue
mismatch-target 1 mismatch-target target not found, using default
default-target 2 default-target target not specified, using default
DEFAULT none(0) none no issue





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.






tCl

Type: reln:ClassId
Primitive Type: scalar:Enum16

Overrides:reln:Inst:tCl
Units: null Encrypted: false Access: implicit Category: TopLevelRegular
    Comments:
null
Constants
unspecified 0 unspecified NO COMMENTS
vzACtrct 1298 --- NO COMMENTS
vzBrCP 1300 --- NO COMMENTS
vzOOBBrCP 1305 --- NO COMMENTS
vzTaboo 1306 --- NO COMMENTS
DEFAULT vzACtrct(1298) --- NO COMMENTS





tDn

Type: reln:Dn
Primitive Type: reference:BinRef

Overrides:reln:Inst:tDn
Units: null Encrypted: false Access: admin Category: TopLevelRegular Property Validators:
    Comments:
The distinguished name of a contract consumption interface. The maximum supported string length is 255 ASCII characters.



tType

Type: reln:TargetType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The type of target.
Constants
name 0 name NO COMMENTS
mo 1 mo NO COMMENTS
all 2 all NO COMMENTS
DEFAULT mo(1) mo NO COMMENTS





uid

Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A unique identifier for this object.



updateCollection

Type: scalar:Bool

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