Class dhcp:RelayAddr (CONCRETE)

Class ID:2677
Class Label: Relay Address
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: Disabled
Write Access: [access-protocol, admin, fabric-protocol, tenant-ext-protocol, tenant-protocol]
Read Access: [access-protocol, admin, fabric-protocol, tenant-ext-protocol, tenant-protocol]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

The DHCP relay address.

Naming Rules
RN FORMAT: addr-{[vrf]}-{[address]}

    [1] PREFIX=addr- PROPERTY = vrf


    [2] PREFIX=- PROPERTY = address




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/dhcp/inst/relayif-{[id]}/addr-{[vrf]}-{[address]}

[1] sys/dhcp/inst/relayif-{[id]}/addr-{[vrf]}-{[address]}

                


Diagram

Super Mo: dhcp:Addr,
Container Mos: dhcp:RelayIf (deletable:yes),
Contained Mos: aaa:RbacAnnotation, dhcp:RelayAddrStats, dhcp:RelayGw, tag:Annotation, tag:Tag,
Relations To: dhcp:ProvDhcp,
Relations: dhcp:RsRelayAddrToProv,


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] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 
 
 
 ├
[V] dhcp:Entity Holds DHCP control plane entity information.
 
 
 
 
 
 ├
[V] dhcp:Inst The DHCP instance information. There is only one instance of DHCP relay currently running in the system.
 
 
 
 
 
 
 ├
[V] dhcp:RelayIf DHCP relay if used for representing relay functionality on the interface.
 
 
 
 
 
 
 
 ├
[V] dhcp:RelayAddr The DHCP relay address.
[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] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 ├
[V] dhcp:Entity Holds DHCP control plane entity information.
 
 
 ├
[V] dhcp:Inst The DHCP instance information. There is only one instance of DHCP relay currently running in the system.
 
 
 
 ├
[V] dhcp:RelayIf DHCP relay if used for representing relay functionality on the interface.
 
 
 
 
 ├
[V] dhcp:RelayAddr The DHCP relay address.


Contained Hierarchy
[V] dhcp:RelayAddr The DHCP relay address.
 ├
[V] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 ├
[V] dhcp:RelayAddrStats The relay address statistics
 
 ├
[V] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 ├
[V] tag:Annotation 
 
 ├
[V] tag:Tag 
 ├
[V] dhcp:RelayGw 
 ├
[V] dhcp:RsRelayAddrToProv 
 ├
[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] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 ├
[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 


Inheritance
[V] dhcp:Addr The DHCP address.
 ├
[V] dhcp:RelayAddr The DHCP relay address.


Events
                dhcp:RelayAddr:creation__dhcp_RelayAddr
dhcp:RelayAddr:modification__dhcp_RelayAddr
dhcp:RelayAddr:deletion__dhcp_RelayAddr


Faults
                dhcp:RelayAddr:dhcpCfgCtrl


Fsms
                


Properties Summary
Defined in: dhcp:RelayAddr
address:Ip address  (dhcp:RelayAddr:address)
           Overrides:dhcp:Addr:address
           null
mo:Annotation
          string:Basic
annotation  (dhcp:RelayAddr:annotation)
           NO COMMENTS
scalar:Bitmask64 dhcpCfgFailedBmp  (dhcp:RelayAddr:dhcpCfgFailedBmp)
           NO COMMENTS
scalar:Time dhcpCfgFailedTs  (dhcp:RelayAddr:dhcpCfgFailedTs)
           NO COMMENTS
scalar:UByte dhcpCfgState  (dhcp:RelayAddr:dhcpCfgState)
           NO COMMENTS
mo:ExtMngdByType
          scalar:Bitmask32
extMngdBy  (dhcp:RelayAddr:extMngdBy)
           NO COMMENTS
address:Ip gw  (dhcp:RelayAddr:gw)
           Gateway IP address, valid only when we are crossing vrfs. Should always be present when client is crossing vrf to get its ip address
dhcp:RelayVisibility
          scalar:Enum8
mode  (dhcp:RelayAddr:mode)
           The BGP Domain mode.
reference:BinRef monPolDn  (dhcp:RelayAddr:monPolDn)
           The monitoring policy attached to this observable object.
l3:VrfName
          string:Basic
vrf  (dhcp:RelayAddr:vrf)
           vrf in which the dhcp server is present. Valid only when the client is in a different vrf from the server vrf
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:Ownable
scalar:Uint16 uid  (mo:Ownable:uid)
           A unique identifier for this object.
mo:UserDomType
          string:Basic
userdom  (mo:Ownable:userdom)
           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: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

address

Type: address:Ip

Overrides:dhcp:Addr:address
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular Property Validators:
    Comments:
null



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





dhcpCfgFailedBmp

Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS
Constants
dhcp:RelayAddrlcOwn_failed_flag -9223372036854775808ull --- NO COMMENTS
dhcp:RelayAddrmodTs_failed_flag 1152921504606846976ull --- NO COMMENTS
dhcp:RelayAddrmode_failed_flag 128ull --- NO COMMENTS
dhcp:RelayAddraddress_failed_flag 1ull --- NO COMMENTS
dhcp:RelayAddruserdom_failed_flag 2305843009213693952ull --- NO COMMENTS
dhcp:RelayAddrmonPolDn_failed_flag 256ull --- NO COMMENTS
dhcp:RelayAddrannotation_failed_flag 2ull --- NO COMMENTS
dhcp:RelayAddrextMngdBy_failed_flag 32ull --- NO COMMENTS
dhcp:RelayAddruid_failed_flag 4611686018427387904ull --- NO COMMENTS
dhcp:RelayAddrvrf_failed_flag 512ull --- NO COMMENTS
dhcp:RelayAddrgw_failed_flag 64ull --- NO COMMENTS
DEFAULT 0 --- NO COMMENTS





dhcpCfgFailedTs

Type: scalar:Time

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS



dhcpCfgState

Type: scalar:UByte

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS



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





gw

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Gateway IP address, valid only when we are crossing vrfs. Should always be present when client is crossing vrf to get its ip address



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





mode

Type: dhcp:RelayVisibility
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The BGP Domain mode.
Constants
visible 0 visible The dhcp provider is sitting in a diffenet private network. The ip address of the provider will get leaked into the consumers private network
not-visible 1 not-visible The dhcp provider may or may not be sitting in a diffenet private network but the ip address of the provider will not get leaked into the consumers private network
DEFAULT not-visible(1) not-visible The dhcp provider may or may not be sitting in a diffenet private network but the ip address of the provider will not get leaked into the consumers private network





monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The monitoring policy attached to this observable 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.






uid

Type: scalar:Uint16

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



userdom

Type: mo:UserDomType
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "256"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
    Comments:
NO COMMENTS
Constants
defaultValue "all" --- NO COMMENTS





vrf

Type: l3:VrfName
Primitive Type: string:Basic

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: "1"  max: "512"
    Comments:
vrf in which the dhcp server is present. Valid only when the client is in a different vrf from the server vrf