For feedback and comments:
documentation.feedback@alcatel-lucent.com

Table of Contents Previous Next PDF


Triple Play DHCP Command Reference
Configuration Commands
 
Global DHCP Commands
config
adv-noaddrs-global [esm-proxy] [esm-relay] [relay] [server]
 
 
Router DHCP Commands
config
local-dhcp-server server-name [create]
description description-string
maximum-client-lead-time [hrs hours] [min minutes] [sec seconds]
partner-down-delay [hrs hours] [min minutes] [sec seconds]
peer ip-address tag sync-tag
[no] startup-wait-time [min minutes] [sec seconds] [days days] [hrs hours] [min minutes] [sec seconds]
lease-hold-time [days days] [hrs hours] [min minutes] [sec seconds]
pool pool-name [create]
no pool pool-name
description description-string
[no] exclude-prefix ipv6-prefix/prefix-length
maximum-client-lead-time [hrs hours] [min minutes] [sec seconds]
partner-down-delay [hrs hours] [min minutes] [sec seconds]
peer ip-address tag sync-tag
[no] startup-wait-time [min minutes] [sec seconds] [days days] [hrs hours] [min minutes] [sec seconds]
max-lease-time [days days] [hrs hours] [min minutes] [sec seconds]
min-lease-time [days days] [hrs hours] [min minutes] [sec seconds]
minimum-free minimum-free [percent] [event-when-depleted]
offer-time [min minutes] [sec seconds]
custom-option option-number address [ip-address...(up to 4 max)]
custom-option option-number hex hex-string
custom-option option-number string ascii-string
no custom-option option-number
dns-server [ip-address...(up to 4 max)]
domain-name domain-name
lease-rebind-time [days days] [hrs hours] [min minutes] [sec seconds]
lease-renew-time [days days] [hrs hours] [min minutes] [sec seconds]
lease-time [days days] [hrs hours] [min minutes] [sec seconds]
netbios-name-server ip-address [ip-address...(up to 4 max)]
netbios-node-type netbios-node-type
prefix ipv6-addr/prefix-len [failover {local | remote}] [pd] [wan-host] [create]
no prefix ipv6-addr/prefix-len
 
[no] minimum-free prefix-length [1..128]
[no] depleted-event
minimum percent [0..100]
no minimum
subnet {ip-address/mask|ip-address netmask} [create]
no subnet {ip-address/mask|ip-address netmask}
[no] address-range start-ip-address end-ip-address
[no] drain
[no] exclude-addresses start-ip-address [end-ip-address]
maximum-declined maximum-declined
minimum-free minimum-free [percent] [event-when-depleted]
custom-option option-number address [ip-address...(upto 4 max)]
custom-option option-number hex hex-string
custom-option option-number string ascii-string
no custom-option option-number
default-router ip-address [ip-address...(up to 4 max)]
no default-router
subnet-mask ip-address
no subnet-mask
subnet-binding key [sys-id-svc-id | sys-id | string] unbind-delay [hrs hours] [min mins] [sec secs]
use-gi-address [scope scope]
use-pool-from-client delimiter delimiter
use-link-address [scope scope]
user-db local-user-db-name
user-ident user-ident
 
VPLS DHCP Commands
config
[no] vpls service-id [customer customer-id] [vpn vpn-id] [m-vpls]
sap sap-id [split-horizon-group group-name] [capture-sap]
description description-string
lease-populate [nbr-of-entries]
action {dhcp-action}
[no] circuit-id [ascii-tuple | vlan-ascii-tuple]
remote-id [mac | string string]
[no] client-mac-address
[no] sap-id
[no] service-id
string text
no string
[no] system-id
[no] snoop
dhcp-user-db local-user-db-name
dhcp-python-policy policy-name
dhcp6-user-db local-user-db-name
description description-string
interface-id ascii-tuple
interface-id vlan-ascii-tuple
remote-id string [32 chars max]
[no] snoop
dhcp-python-policy policy-name
dhcp6-user-db local-user-db-name
description description-string
user-db local-user-db-name
mesh-sdp sdp-id[:vc-id] [vc-type {ether | vlan}]
description description-string
[no] snoop
ppp-user-db local-user-db-name
pppoe-user-db local-user-db-name
spoke-sdp sdp-id[:vc-id] [vc-type {ether | vlan}] [split-horizon-group group-name]
description description-string
[no] snoop
 
IES DHCP Commands
config
ies service-id [customer customer-id] [vpn vpn-id]
Global Commands
[no] interface ip-int-name
Interface Commands
description description-string
gi-address ip-address [src-ip-addr]
lease-populate nbr-of-leases
action {replace | drop | keep}
circuit-id [ascii-tuple | ifindex | sap-id |vlan-ascii-tuple]
remote-id [mac | string string]
[no] client-mac-address
[no] pool-name
[no] sap-id
[no] service-id
string text
no string
[no] system-id
emulated-server ip-address
lease-time [days days] [hrs hours] [min minutes] [sec seconds] [override]
relay-unicast-msg [release-update-src-ip]
python-policy policy-name
server server1 [server2...(up to 8 max)]
[no] ipv6
address ipv6-address/prefix-length [eui-64]
no address ipv6-address/prefix-length
description description-string
lease-populate [nbr-of-leases]
lease-populate [nbr-of-leases] route-populate [pd] na [ta]
lease-populate [nbr-of-leases] route-populate pd [na] [ta] [exclude]
lease-populate [nbr-of-leases] route-populate [pd] [na] ta
interface-id
interface-id ascii-tuple
interface-id ifindex
interface-id sap-id
no interface-id
[no] remote-id
server ipv6z-address [ipv6z-address...(up to 8 max)]
no server [ipv6z-address...(up to 8 max)]
description description-string
source-address ipv6-address
max-nbr-of-leases max-nbr-of-leases
[no] prefix ipv6-address/prefix-length
duid duid [iaid iaid]
[no] shutdown
packet-too-big [number seconds]
param-problem [number seconds]
redirects [number seconds]
time-exceeded [number seconds]
unreachables [number seconds]
neighbor ipv6-address mac-address
no neighbor ipv6-address
proxy-nd-policy policy-name [policy-name...(up to 5 max)]
[no] subscriber-interface ip-int-name
gi-address ip-address [src-ip-addr]
relay-unicast-msg [release-update-src-ip]
[no] group-interface ip-int-name
client-applications {[dhcp] [pppoe]}
description description-string
gi-address ip-address [src-ip-addr]
gi-address [nbr-of-leases]
lease-populate [nbr-of-leases] l2-header [mac ieee-address]
action {replace | drop | keep}
no action
circuit-id [ascii-tuple | ifindex | sap-id | vlan-ascii-tuple]
no circuit-id
remote-id [mac | string string]
no remote-id
[no] vendor-specific-option
string text
relay-unicast-msg [release-update-src-ip]
server server1 [server2...(up to 8 max)]
[no] pppoe
anti-spoof pppoe-anti-spoofing-type
description description-string
[no] ccag-use-origin-sap
policy ppp-policy-name
sap-session-limit sap-session-limit
session-limit session-limit
user-db local-user-db-name
 
VPRN DHCP Commands
config
local-dhcp-server-server server-name [create]
description description-string
maximum-client-lead-time [hrs hours] [min minutes] [sec seconds]
partner-down-delay [hrs hours] [min minutes] [sec seconds]
peer ip-address tag sync-tag
[no] startup-wait-time [min minutes] [sec seconds] [days days] [hrs hours] [min minutes] [sec seconds]
lease-hold-time [days days] [hrs hours] [min minutes] [sec seconds]
pool pool-name [create]
no pool pool-name
[no] ignore-mclt-on-takeover
maximum-client-lead-time [hrs hours] [min minutes] [sec seconds]
no maximum-client-lead-time
partner-down-delay [hrs hours] [min minutes] [sec seconds]
no partner-down-delay
peer ip-address tag sync-tag
no peer
[no] shutdown
[no] startup-wait-time [min minutes] [sec seconds] [days days] [hrs hours] [min minutes] [sec seconds]
prefix ipv6-addr/prefix-len [failover {local | remote}] [pd] [wan-host] [create]
no prefix ipv6-addr/prefix-len
thresholds
[no] minimum-free prefix-length [1..128]
minimum [percent [0..100]] [number [0..4294967295]]
[no] interface ip-int-name
description description-string
gi-address ip-address [src-ip-addr]
lease-populate [nbr-of-leases]
action {replace | drop | keep}
circuit-id [ascii-tuple | ifindex | sap-id |vlan-ascii-tup]
remote-id [mac | string string]
[no] client-mac-address
[no] pool-name
[no] sap-id
[no] service-id
string text
no string
[no] system-id
python-policy policy-name
emulated-server ip-address
lease-time [days days] [hrs hours] [min minutes] [sec seconds] [override]
relay-unicast-msg [release-update-src-ip]
server server1 [server2...(up to 8 max)]
user-ident user-ident
 
VPRN DHCP Subscriber Interface Commands
config
subscriber-interface ip-int-name [fwd-service service-id fwd-subscriber-interface ip-int-name] [create]
description description-string
gi-address ip-address [src-ip-addr]
lease-populate nbr-of-leases
string text
emulated-server ip-address
lease-time [days days] [hrs hours] [min minutes] [sec seconds] [override]
relay-unicast-msg [release-update-src-ip]
server server1 [server2...(up to 8 max)]
[no] group-interface ip-int-name
arp-timeout seconds
description description-string
description description-string
gi-address ip-address [src-ip-addr]
lease-populate [nbr-of-leases] l2-header [mac ieee-address]
action {replace | drop | keep}
no action
circuit-id [ascii-tuple|ifindex|sap-id|vlan-ascii-tupl]
no circuit-id
remote-id [mac | string string]
no remote-id
[no] vendor-specific-option
string text
emulated-server ip-address
no emulated-server
lease-time [days days] [hrs hours] [min minutes] [sec seconds] [override]
no lease-time
[no] shutdown
relay-unicast-msg [release-update-src-ip]
server server1 [server2...(up to 8 max)]
 
IES/VPRN IPv6-DHCP6 Commands
configure
ies service-id/vprn service-id
[no] allow-multiple-wan-addresses
filter filter-id
no filter
interface-id [ascii-tuple]
interface-id ifindex
interface-id string string
pd-managed-route [next-hop {ipv4 | ipv6}]
client-applications {[dhcp] [ppp]}
preferred-lifetime [days days] [hrs hours] [min minutes] [sec seconds]
rebind-timer [days days] [hrs hours] [min minutes] [sec seconds]
renew-timer [days days] [hrs hours] [min minutes] [sec seconds]
server-id duid-en hex hex-string
server-id duid-en string ascii-string
server-id duid-ll
valid-lifetime [days days] [hrs hours] [min minutes] [sec seconds]
[no] relay
client-applications [dhcp] [ppp]
description description-string
link-address ipv6-address
[no] server [ipv6z-address...(upto 8 max)]
source-address ipv6-address
user-db local-user-db-name
user-ident user-ident
current-hop-limit limit
no current-hop-limit
[no] dns-options
force-mcast [ip] [mac]
no force-mcast
[no] managed-configuration
max-advertisement seconds
no max-advertisement
min-advertisement seconds
no min-advertisement
mtu bytes
no mtu
[no] other-stateful-configuration
[no] prefix-options
reachable-time milli-seconds
no reachable-time
retransmit-time milli-seconds
no retransmit-time
router-lifetime seconds
router-lifetime no-default-router
no router-lifetime
[no] shutdown
inactivity-timer [days days] [hrs hours] [min minutes] [sec seconds]
inactivity-timer infinite
no inactivity-timer
min-auth-interval [days days] [hrs hours] [min minutes] [sec seconds]
no min-auth-interval
[no] shutdown
user-db local-user-db-name
no user-db
mode {strict|loose|strict-no-ecmp}
 
Local User Database Commands
 
IPoE Commands
config
local-user-db local-user-db-name [create]
no local-user-db local-user-db-name
description description-string
IPoE Commands
host host-name [create]
no host host-name
acct-policy acct-policy-name [duplicate acct-policy-name]
address gi-address [scope scope]
address ip-address
address pool pool-name [secondary-pool sec-pool-name] [delimiter delimiter]
address use-pool-from-client [delimiter delimiter]
auth-domain-name domain-name
auth-policy policy-name
gi-address ip-address
circuit-id string ascii-string
circuit-id hex hex-string
derived-id derived-id-string
encap-tag-range start-tag start-tag end-tag end-tag
mac ieee-address
option60 hex-string
remote-id hex hex-string
remote-id string ascii-string
sap-id sap-id
service-id service-id
string string
system-id system-id
identification-strings option-number [create]
ancp-string ancp-string
app-profile-string app-profile-string
category-map category-map-name
inter-dest-id intermediate-destination-id
sla-profile-string sla-profile-string
sub-profile-stringsub-profile-string
subscriber-id sub-ident-string
ipv6-address ipv6-address
ipv6-delegated-prefix ipv6-prefix/prefix-length
preferred-lifetime [days days] [hrs hrs] [min min] [sec sec]
rebind-timer [days days] [hrs hrs] [min min] [sec sec]
renew-timer [days days] [hrs hrs] [min min] [sec sec]
valid-lifetime [days days] [hrs hrs] [min min] [sec sec]
ipv6-slaac-prefix ipv6-prefix/prefix-length
link-address ipv6-address
fail-action {continue|drop}
mac-format mac-format
match {circuit-id|mac|remote-id}
match option [1..254] [option6 [1..65535]]
match option6 [1..65535]
server [service service-id] name server-name
group-interface ip-int-name [prefix {port-id}]
group-interface ip-int-name [suffix {port-id}]
policy msap-policy-name
service service-id
custom-option option-number address [ip-address...(up to 4 max)]
custom-option option-number hex hex-string
custom-option option-number string ascii-string
no custom-option option-number
default-router ip-address [ip-address...(up to 4 max)]
no default-router
dns-server address [ip-address...(upto 4 max)]
domain-name domain-name
lease-rebind-time [days days] [hrs hours] [min minutes] [sec seconds]
lease-renew-time [days days] [hrs hours] [min minutes] [sec seconds]
lease-time [days days] [hrs hours] [min minutes] [sec seconds]
netbios-name-server ip-address [ip-address...(up to 4 max)]
netbios-node-type netbios-node-type
subnet-mask ip-address
dns-server ipv6-address [ipv6-address...(upto 4 max)]
option option-number address ipv4-address [ipv4-address...(upto 4 max)]
option option-number hex hex-string
option option-number string ascii-string
no option option-number
option option-number address ipv6-address [ipv6-address...(upto 4 max)]
option option-number hex hex-string
option option-number string ascii-string
no option option-number
option option-number address [ip-address...(up to 4 max)]
option option-number hex hex-string
option option-number string ascii-string
no option option-number
option option-number address [ip-address...(up to 4 max)]
option option-number hex hex-string
option option-number string ascii-string
no option option-number
server ip-address
server6 ipv6-address
mask type ipoe-match-type {[prefix-string prefix-string | prefix-length prefix-length] [suffix-string suffix-string | suffix-length suffix-length]}
no mask type ipoe-match-type
match-list ipoe-match-type-1 [ipoe-match-type-2...(up to 4 max)]
PPP Commands
config
local-user-db local-user-db-name [create]
no local-user-db local-user-db-name
description description-string
PPP Commands
host host-name [create]
no host host-name
encap-offset [type type]
circuit-id sap-id
circuit-id ASCII string
remote-id ASCII string
acct-policy acct-policy-name [duplicate acct-policy-name]
address gi-address [scope scope]
address ip-address[/prefix-length]
address pool pool-name [secondary-pool sec-pool-name] [delimiter delimiter]
address use-pool-from-client [delimiter delimiter]
auth-policy policy-name
circuit-id string ascii-string
circuit-id hex hex-string
encap-tag-range start-tag start-tag end-tag end-tag
mac ieee-address
remote-id hex hex-string
remote-id string ascii-string
sap-id sap-id
service-name service-name
username user-name
username user-name [no-domain]
username user-name domain-only
identification-strings option-number [create]
ancp-string ancp-string
app-profile-string app-profile-string
category-map category-map-name
inter-dest-id intermediate-destination-id
sla-profile-string sla-profile-string
sub-profile-string sub-profile-string
subscriber-id sub-ident-string
interface ip-int-name service-id service-id
ipv6-address ipv6-address
ipv6-delegated-prefix ipv6-prefix/prefix-length
preferred-lifetime [days days] [hrs hrs] [min min] [sec sec]
rebind-timer [days days] [hrs hrs] [min min] [sec sec]
renew-timer [days days] [hrs hrs] [min min] [sec sec]
valid-lifetime [days days] [hrs hrs] [min min] [sec sec]
ipv6-slaac-prefix ipv6-prefix/prefix-length
group tunnel-group-name [service-id service-id]
group-interface ip-int-name [prefix {port-id}]
group-interface ip-int-name [suffix {port-id}]
policy msap-policy-name
service service-id
custom-option option-number address [ip-address...(up to 4 max)]
custom-option option-number hex hex-string
custom-option option-number string ascii-string
no custom-option option-number
dns-server address [ip-address...(upto 4 max)]
netbios-name-server ip-address [ip-address...(up to 4 max)]
dns-server ipv6-address [ipv6-address...(upto 4 max)]
pado-delay deci-seconds
password ignore
password {chap password |pap password} [hash|hash2]
pre-auth-policy policy-name
option option-number address [ip-address...(up to 4 max)]
option option-number hex hex-string
option option-number string ascii-string
no option option-number
option option-number address [ip-address...(up to 4 max)]
option option-number hex hex-string
option option-number string ascii-string
no option option-number
Show Commands
show
lease-state [sap sap-id]
statistics [interface ip-int-name | ip-address]
local-dhcp-server server-name
declined-addresses ip-address[/mask] [detail]
declined-addresses pool pool-name
free-addresses ip-address[/mask]
free-addresses summary [subnet ip-address[/mask]
free-addresses pool pool-name
leases ip-address[/mask] address-from-user-db [detail]
leases ip-address[/mask] dhcp-host dhcp-host-name [detail]
leases ip-address[/mask] ppp-host ppp-host-name [detail]
leases ip-address[/mask] [detail]
pool-ext-stats [pool-name]
subnet-ext-stats ip-address[/mask]
subnet-ext-stats pool pool-name
subnet-stats ip-address[/mask]
subnet-stats pool pool-name
local-dhcp-server server-name
leases [ipv6-address/prefix-length] [type] [state] [detail]
pool-ext-stats [pool-name]
prefix-ext-stats ipv6-address/prefix-length
prefix-ext-stats pool pool-name
pool-threshold-stats [pool-name] detail [format {exact|scientific}]
prefix-threshold-stats pool pool-name detail [format {exact|scientific}]
prefix-threshold-stats pool pool-name
prefix-threshold-stats ipv6-address/prefix-length detail [format {exact|scientific}]
prefix-threshold-stats ipv6-address/prefix-length
 
show
Show Commands
id service-id
lease-state [wholesaler service-id] [sap sap-id|sdp sdp-id:vc-id| interface interface-name|ip-address ip-address[/mask]|chaddr ieee-address|mac ieee-address|{[port port-id] [no-inter-dest-id | inter-dest-id inter-dest-id]}] [session {none|ipoe}] [detail]
statistics [sap sap-id] | [sdp [sdp-id[:vc-id]] | interface ip-int-name]]
virtual-subnet subscriber sub-ident
virtual-subnet [sap sap-id]
lease-state [detail] [wholesaler service-id] [session {none|ipoe|ppp}]|
lease-state [detail] interface interface-name [wholesaler service-id] [session {none|ipoe|ppp}]
lease-state [detail] ipv6-address ipv6-prefix[/prefix-length] [wholesaler service-id] [session {none|ipoe|ppp}]
lease-state [detail] mac ieee-address [wholesaler service-id] [session {none|ipoe|ppp}]
lease-state [interface ip-int-name]
 
 
show
Tools Commands
tools
remap-lease-state old-mac ieee-address mac ieee-address
remap-lease-state sap sap-id [mac ieee-address]
 
Clear Commands
clear
lease-state [interface ip-int-name | ip-addr | ip-address ip-address | mac ieee-address]
local-dhcp-server server-name
declined-addresses ip-address[/mask]
declined-addresses pool pool-name
leases ip-address[/mask] [offered]
pool-ext-stats [pool-name]
subnet-ext-stats ip-address[/mask]
subnet-ext-stats pool pool-name
statistics [ip-int-name | ip-address]
local-dhcp-server server-name
leases [ipv6-address/prefix-length] [type] [state]
leases all [type] [state]
pool-ext-stats [pool-name]
prefix-ext-stats ipv6-address/prefix-length
prefix-ext-stats pool pool-name
prefix-threshold-stats ipv6-address/prefix-length
prefix-threshold-stats pool pool-name
id service-id
lease-state [no-dhcp-release]
lease-state [port port-id] [inter-dest-id intermediate-destination-id] [no-dhcp-release]
lease-state [port port-id] no-inter-dest-id [no-dhcp-release]
lease-state ip-address ip-address [no-dhcp-release]
lease-state mac ieee-address no-dhcp-release
lease-state sap sap-id [no-dhcp-release]
lease-state sdp sdp-id:vc-id [no-dhcp-release]
statistics [sap sap-id | sdp [sdp-id[:vc-id] | interface ip-int-name | ip-address]
lease-state [ip-address ipv6-address/prefix-length] [mac ieee-address]
 
DHCP Debug Commands
debug
[no] dhcp [ip-int-name]
detail-level {low | medium | high}
mode {dropped-only | ingr-and-dropped | egr-ingr-and-dropped}
dhcp6 [ip-int-name]
[no] local-dhcp-server server-name [lease-address ip-address]
detail-level {low | medium | high}
mode {dropped-only | ingr-and-dropped | egr-ingr-and-dropped}
 
Tools Commands
tools
edit-ppp-session sap sap-id ip ip-address [subscriber sub-ident-string] [sub-profile-string sub-profile-string] [sla-profile-string sla-profile-string] [inter-dest-id intermediate-destination-id] [ancp-string ancp-string] [app-profile-string app-profile-string] [user-name user-name]
eval-lease-state [svc-id service-id] [sap sap-id] [subscriber sub-ident-string] [ip ip-address]
local-user-db local-user-db-name
authentication pppoe-user-name [password password]
host-lookup [mac ieee-address] [remote-id remote-id] [user-name user-name] [circuit-id circuit-id | circuit-id-hex circuit-id-hex]
host-lookup [mac ieee-address] [remote-id remote-id] [sap-id sap-id] [service-id service-id] [string vso-string] [system-id system-id] [option60 hex-string] [circuit-id circuit-id | circuit-id-hex circuit-id-hex]