Overview Package Class Deprecated Help

dhcp
LocalDhcp6Server

A Local DHCPv6 server instance running within a routing instance or VPRN site.

public class LocalDhcp6Server

Stats:
dhcp.LocalDhcp6ServerStats

Properties
creationOrigin

type=svt.L2RouteOriginType
access=read-create
default=manual
dhcp.Address6Pool-Set type=Children-Set
dhcp.LeaseNotOwnerLog-Set type=Children-Set
dhcp.LocalDhcpSFoPeer-Set type=Children-Set
dhcp.LocalDhcpServerFailover-Set type=Children-Set
dhcp.PoolUnknownLog-Set type=Children-Set
dhcpOptionType Specifies the type of dhcpUniqueIdentifier.

type=dhcp.DHCPValueType
default=ascii
Displayed(tab/group)=ID Type (/DHCP Unique Identifier (DUID))
dhcpUniqueIdentifier Specifies the variable length identifier following the type code and enterprise-number.

type=string
minimum=0
maximum=116
Displayed(tab/group)=Value (/DHCP Unique Identifier (DUID))
dhcpUniqueIdentifierType Specifies the type code of the server DUID.

type=dhcp.DHCPUniqueIdentifierType
default=duidLinkLocal
Displayed(tab/group)=Server ID Type (/DHCP Unique Identifier (DUID))
enterpriseNumber Indicates the enterprise-number. The enterprise-number is the vendor's registered. Private Enterprise Number as maintained by IANA.

type=long
access=read-only
Displayed(tab/group)=Enterprise Number (/DHCP Unique Identifier (DUID))
interfaceIdMapping Specifies whether the DHCPv6 server uses a unique /64 prefix per interface-ID options combination.

type=boolean
default=false
Displayed(tab/group)=Interface ID Mapping
leaseQuery Specifies whether the DHCPv6 server will handle Lease Query messages by client id.

type=boolean
default=false
Displayed(tab/group)=Lease Query
linkAddressScope Specifies which method is used by the local DHCP server to uniquely identify a user.

type=dhcp.Dhcp6LinkAddressScope
default=subnet
Displayed(tab/group)=Link Address Scope
rapidCommit Specifies whether the Rapid Commit Option sent by the DHCPv6 client is processed.

type=boolean
default=false
Displayed(tab/group)=Ignore Rapid Commit
useLinkAddress

type=boolean
default=false
Displayed(tab/group)=Use Link Address
userIdent Specifies which method is used by the local DHCP server to uniquely identify a user.

type=dhcp.Dhcp6UserIdentMethod
default=duid
Displayed(tab/group)=User Identification Method
  
Properties inherited from dhcp.AbstractDhcpServer
administrativeState, createOrigin, description, displayedName, leaseHoldTimeDay, leaseHoldTimeFor, leaseHoldTimeHour, leaseHoldTimeMinute, leaseHoldTimeSecond, nodeId, operationalState, poolNameDelimiter, routerId, serviceId, templateVersionPointer, usePoolFromClient
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

showDhcp6Leases

This method retrieves from the network the leases for a local DHCPv6 server, by sending the CLI command show router [routerId] dhcp6 local-dhcp-server [serverName] leases [ip-address/prefix] detail. Method call example: 

<dhcp.LocalDhcp6Server.showDhcp6Leases xmlns="xmlapi_1.0">
<isSynchronized>true<<isSynchronized>
<clientId>user@1</clientId>
<systemScriptTargetConfigInfo>
<script.TargetScript>
<actionMask>
<bit>create</bit>
</actionMask>
<targetObjectFullName>network:38.120.169.240>/targetObjectFullName>
<script.TargetParameter-Set>
<script.TargetParameter>
<actionMask>
<bit>create</bit>
</actionMask>
<value>Base>/value>
<parameterName>>routerId</parameterName>
</script.TargetParameter>
<script.TargetParameter>
<actionMask>
<bit>create</bit>
</actionMask>
<value>server6>/value>
<parameterName>>serverName</parameterName>
</script.TargetParameter>
<script.TargetParameter>
<actionMask>
<bit>create</bit>
</actionMask>
<value>2011:1:31:10::/60</value>
<parameterName>ipAddress</parameterName>
</script.TargetParameter>
<script.TargetParameter>
<actionMask>
<bit>create</bit>
</actionMask>
<value>true</value>
<parameterName>detail</parameterName>
</script.TargetParameter>
</script.TargetParameter-Set>
</script.TargetScript>
</systemScriptTargetConfigInfo>
</script.ScriptManager.executeCLITargetScripts>
RouterId and serverName are required to be specified in the Target Parameter list.
Input Parameters:
isSynchronized : boolean - Identifies if the call to execute the script should wait until all scripts have been executed. True to wait, false otherwise.
clientId : string - Identifies the client Id that is requesting the execution (used for sending an event to the specific client when execution is complete).
systemScriptTargetConfigInfo : generic.CommonManagedContainmentEntityConfigurationInformation - The list of configuration info for input target parameters required by the script.
resultFilter : ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
infoList : List (generic.CommonManagedEntityInformation) - The list of TargetScriptResultInfo objects identifying the status of the executed target scripts.
Exceptions:
dhcp.LocalDhcp6Server.showDhcp6LeasesException
Supported Network Elements
7750 SR
7705 SAR Gen 2
7705 SAR Hm
7705 SAR Supported from 7.0.R4
7705 SAR H Supported from 7.0.R4
7450 ESS Supported from 10.0.R1
  • Excluded chassis types: 7450-ESS1
  • Required Capabilities: MixedMode
Product Specifics
7450 ESS 20.0
7450 ESS 21.0
7450 ESS 22.0
7450 ESS 23.0
7450 ESS 24.0
7450 ESS 25.0
7705 SAR H 20.0
7705 SAR H 21.0
7705 SAR H 22.0
7705 SAR H 23.0
7705 SAR H 24.0
7705 SAR H 25.0
7705 SAR H 9.0
7705 SAR 20.0
7705 SAR 21.0
7705 SAR 22.0
7705 SAR 23.0
7705 SAR 24.0
7705 SAR 25.0