Class dhcp:OptionPol (CONCRETE)

Class ID:1443
Class Label: DHCP Option Policy
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled
Write Access: [access-protocol-l3, admin]
Read Access: [access-protocol-l3, admin, tenant-protocol-l3]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: EPG
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

RN FORMAT: dhcpoptpol-{name}

    [1] PREFIX=dhcpoptpol- PROPERTY = name




DN FORMAT: 

[1] uni/tn-{name}/dhcpoptpol-{name}

                

Diagram

Super Mo: pol:Def, Container Mos: fv:Tenant (deletable:yes), Contained Mos: dhcp:Option, Relations From: dhcp:Lbl, Relations: dhcp:RtDhcpOptionPol,

Containers Hierarchies

top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.  ├ fabric:Topology The root for IFC topology.    ├ fabric:Pod A pod.      ├ fabric:Node The root node for the APIC.        ├ ctx:Local The local Context.          ├ ctx:Application The context application.            ├ pol:Uni Represents policy definition/resolution universe.              ├ 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.                ├ dhcp:OptionPol The DHCP option policy, which defines lease duration, gateway routers, and other configuration parameters in what are called DHCP options. Every DHCP server must have one or more policies defined for it. The policies are especially useful if you have multiple scopes because you only need to define a policy once and apply it to the multiple scopes. You can define named policies with specific option definitions or you can use system defaults. Note... top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.  ├ pol:Uni Represents policy definition/resolution universe.    ├ 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.      ├ dhcp:OptionPol The DHCP option policy, which defines lease duration, gateway routers, and other configuration parameters in what are called DHCP options. Every DHCP server must have one or more policies defined for it. The policies are especially useful if you have multiple scopes because you only need to define a policy once and apply it to the multiple scopes. You can define named policies with specific option definitions or you can use system defaults. Note...

Contained Hierarchy

dhcp:OptionPol The DHCP option policy, which defines lease duration, gateway routers, and other configuration parameters in what are called DHCP options. Every DHCP server must have one or more policies defined for it. The policies are especially useful if you have multiple scopes because you only need to define a policy once and apply it to the multiple scopes. You can define named policies with specific option definitions or you can use system defaults. Note...  ├ dhcp:Option The DHCP option is used to supply DHCP clients with configuration parameters such as a domain, name server, subnet, and network address. DHCP provides a framework for passing configuration information to clients on a TCP/IP network. The configuration parameters, and other control information, are carried in tagged data items that are stored in the options field of a DHCP message. The data items themselves are also called options. You can view, se...    ├ 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.  ├ dhcp:RtDhcpOptionPol A target relation to the DHCP option policy.  ├ 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.

Inheritance

naming:NamedObject An abstract base class for an object that contains a name.  ├ pol:Obj Represents a generic policy object.    ├ pol:Def Represents self-contained policy document.      ├ dhcp:OptionPol The DHCP option policy, which defines lease duration, gateway routers, and other configuration parameters in what are called DHCP options. Every DHCP server must have one or more policies defined for it. The policies are especially useful if you have multiple scopes because you only need to define a policy once and apply it to the multiple scopes. You can define named policies with specific option definitions or you can use system defaults. Note...

                dhcp:OptionPol:creation__dhcp_OptionPol

                dhcp:OptionPol:modification__dhcp_OptionPol

                dhcp:OptionPol:deletion__dhcp_OptionPol

                

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

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

Delete or ignore. For internal use only.

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\\!#$%()*,-./:;@ _{|}~?&+]+

Specifies a description of the policy definition.

dn

Type: reference:BinRef

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

A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.

lcOwn

Type: mo:Owner
Primitive Type: scalar:Enum8

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

A value that indicates how this object was created. For internal use only.

modTs

Type: mo:TStamp
Primitive Type: scalar:Date

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

The time when this object was last modified.

name

Type: naming:Name
Primitive Type: string:Basic

Overrides:pol:Obj:name  |  naming:NamedObject:name

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: "1"  max: "64"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+

The DHCP option policy name. This name can be up to 64 alphanumeric characters.

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_.-]+

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\\!#$%()*,-./:;@ _{|}~?&+]+

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\\!#$%()*,-./:;@ _{|}~?&+]+

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

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

The upgrade status. This property is for internal use only.

uid

Type: scalar:Uint16

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

A unique identifier for this object.